Skip to content

Commit

Permalink
Rename (un)register to (un)deploy
Browse files Browse the repository at this point in the history
  • Loading branch information
Drew Meyers committed May 10, 2024
1 parent c0c9620 commit 51e6978
Show file tree
Hide file tree
Showing 5 changed files with 1,832 additions and 1,831 deletions.
11 changes: 5 additions & 6 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -142,19 +142,19 @@ All URIs are relative to *<http://localhost>*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultApi* | [**conformance_declaration_conformance_get**](docs/DefaultApi.md#conformance_declaration_conformance_get) | **GET** /conformance | Information about standards that this API conforms to
*DefaultApi* | [**deploy_process_processes_post**](docs/DefaultApi.md#deploy_process_processes_post) | **POST** /processes | Deploy a process
*DefaultApi* | [**dismiss_jobs_job_id_delete**](docs/DefaultApi.md#dismiss_jobs_job_id_delete) | **DELETE** /jobs/{job_id} | Cancel a job execution, remove a finished job
*DefaultApi* | [**execute_processes_process_id_execution_post**](docs/DefaultApi.md#execute_processes_process_id_execution_post) | **POST** /processes/{process_id}/execution | Execute a process
*DefaultApi* | [**get_health_health_get**](docs/DefaultApi.md#get_health_health_get) | **GET** /health | Perform a Health Check
*DefaultApi* | [**job_list_jobs_get**](docs/DefaultApi.md#job_list_jobs_get) | **GET** /jobs | Retrieve the list of jobs
*DefaultApi* | [**landing_page_get**](docs/DefaultApi.md#landing_page_get) | **GET** / | Landing page of this API
*DefaultApi* | [**process_description_processes_process_id_get**](docs/DefaultApi.md#process_description_processes_process_id_get) | **GET** /processes/{process_id} | Retrieve a process description
*DefaultApi* | [**process_list_processes_get**](docs/DefaultApi.md#process_list_processes_get) | **GET** /processes | Retrieve the list of available processes
*DefaultApi* | [**register_process_processes_post**](docs/DefaultApi.md#register_process_processes_post) | **POST** /processes | Register a process
*DefaultApi* | [**results_jobs_job_id_results_get**](docs/DefaultApi.md#results_jobs_job_id_results_get) | **GET** /jobs/{job_id}/results | Retrieve the result(s) of a job
*DefaultApi* | [**status_jobs_job_id_get**](docs/DefaultApi.md#status_jobs_job_id_get) | **GET** /jobs/{job_id} | Retrieve the status of a job
*DefaultApi* | [**unregister_process_processes_process_id_delete**](docs/DefaultApi.md#unregister_process_processes_process_id_delete) | **DELETE** /processes/{process_id} | Unregister a process
*DefaultApi* | [**undeploy_process_processes_process_id_delete**](docs/DefaultApi.md#undeploy_process_processes_process_id_delete) | **DELETE** /processes/{process_id} | Undeploy a process

## Documentation For Models
#### Documentation For Models

* [Bbox](docs/Bbox.md)
* [ConfClasses](docs/ConfClasses.md)
Expand Down Expand Up @@ -190,12 +190,11 @@ Class | Method | HTTP request | Description
* [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)
* [Value](docs/Value.md)

## Documentation For Authorization
#### Documentation For Authorization

Authentication schemes defined for the API:
<a id="bearerAuth"></a>

### bearerAuth
##### bearerAuth

* **Type**: Bearer authentication (JWT)

Expand Down
178 changes: 89 additions & 89 deletions docs/DefaultApi.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,17 @@ All URIs are relative to *http://localhost*
Method | HTTP request | Description
------------- | ------------- | -------------
[**conformance_declaration_conformance_get**](DefaultApi.md#conformance_declaration_conformance_get) | **GET** /conformance | Information about standards that this API conforms to
[**deploy_process_processes_post**](DefaultApi.md#deploy_process_processes_post) | **POST** /processes | Deploy a process
[**dismiss_jobs_job_id_delete**](DefaultApi.md#dismiss_jobs_job_id_delete) | **DELETE** /jobs/{job_id} | Cancel a job execution, remove a finished job
[**execute_processes_process_id_execution_post**](DefaultApi.md#execute_processes_process_id_execution_post) | **POST** /processes/{process_id}/execution | Execute a process
[**get_health_health_get**](DefaultApi.md#get_health_health_get) | **GET** /health | Perform a Health Check
[**job_list_jobs_get**](DefaultApi.md#job_list_jobs_get) | **GET** /jobs | Retrieve the list of jobs
[**landing_page_get**](DefaultApi.md#landing_page_get) | **GET** / | Landing page of this API
[**process_description_processes_process_id_get**](DefaultApi.md#process_description_processes_process_id_get) | **GET** /processes/{process_id} | Retrieve a process description
[**process_list_processes_get**](DefaultApi.md#process_list_processes_get) | **GET** /processes | Retrieve the list of available processes
[**register_process_processes_post**](DefaultApi.md#register_process_processes_post) | **POST** /processes | Register a process
[**results_jobs_job_id_results_get**](DefaultApi.md#results_jobs_job_id_results_get) | **GET** /jobs/{job_id}/results | Retrieve the result(s) of a job
[**status_jobs_job_id_get**](DefaultApi.md#status_jobs_job_id_get) | **GET** /jobs/{job_id} | Retrieve the status of a job
[**unregister_process_processes_process_id_delete**](DefaultApi.md#unregister_process_processes_process_id_delete) | **DELETE** /processes/{process_id} | Unregister a process
[**undeploy_process_processes_process_id_delete**](DefaultApi.md#undeploy_process_processes_process_id_delete) | **DELETE** /processes/{process_id} | Undeploy a process


# **conformance_declaration_conformance_get**
Expand Down Expand Up @@ -92,6 +92,86 @@ This endpoint does not need any parameter.

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **deploy_process_processes_post**
> ProcessOutput deploy_process_processes_post(process_input)
Deploy a process

Deploy a new process. **Note:** This is not an officially supported endpoint in the OGC Processes specification.

### Example

* Bearer (JWT) Authentication (bearerAuth):

```python
import unity_sps_ogc_processes_api_python_client
from unity_sps_ogc_processes_api_python_client.models.process_input import ProcessInput
from unity_sps_ogc_processes_api_python_client.models.process_output import ProcessOutput
from unity_sps_ogc_processes_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = unity_sps_ogc_processes_api_python_client.Configuration(
host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = unity_sps_ogc_processes_api_python_client.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unity_sps_ogc_processes_api_python_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = unity_sps_ogc_processes_api_python_client.DefaultApi(api_client)
process_input = unity_sps_ogc_processes_api_python_client.ProcessInput() # ProcessInput |

try:
# Deploy a process
api_response = api_instance.deploy_process_processes_post(process_input)
print("The response of DefaultApi->deploy_process_processes_post:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DefaultApi->deploy_process_processes_post: %s\n" % e)
```



### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**process_input** | [**ProcessInput**](ProcessInput.md)| |

### Return type

[**ProcessOutput**](ProcessOutput.md)

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response | - |
**422** | Validation Error | - |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **dismiss_jobs_job_id_delete**
> StatusInfo dismiss_jobs_job_id_delete(job_id)
Expand Down Expand Up @@ -628,86 +708,6 @@ This endpoint does not need any parameter.

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **register_process_processes_post**
> ProcessOutput register_process_processes_post(process_input)
Register a process

Register a new process. **Note:** This is not an officially supported endpoint in the OGC Processes specification.

### Example

* Bearer (JWT) Authentication (bearerAuth):

```python
import unity_sps_ogc_processes_api_python_client
from unity_sps_ogc_processes_api_python_client.models.process_input import ProcessInput
from unity_sps_ogc_processes_api_python_client.models.process_output import ProcessOutput
from unity_sps_ogc_processes_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = unity_sps_ogc_processes_api_python_client.Configuration(
host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = unity_sps_ogc_processes_api_python_client.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unity_sps_ogc_processes_api_python_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = unity_sps_ogc_processes_api_python_client.DefaultApi(api_client)
process_input = unity_sps_ogc_processes_api_python_client.ProcessInput() # ProcessInput |

try:
# Register a process
api_response = api_instance.register_process_processes_post(process_input)
print("The response of DefaultApi->register_process_processes_post:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DefaultApi->register_process_processes_post: %s\n" % e)
```



### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**process_input** | [**ProcessInput**](ProcessInput.md)| |

### Return type

[**ProcessOutput**](ProcessOutput.md)

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response | - |
**422** | Validation Error | - |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **results_jobs_job_id_results_get**
> object results_jobs_job_id_results_get(job_id)
Expand Down Expand Up @@ -865,12 +865,12 @@ Name | Type | Description | Notes

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **unregister_process_processes_process_id_delete**
> unregister_process_processes_process_id_delete(process_id)
# **undeploy_process_processes_process_id_delete**
> undeploy_process_processes_process_id_delete(process_id)
Unregister a process
Undeploy a process

Unregister an existing process. **Note:** This is not an officially supported endpoint in the OGC Processes specification.
Undeploy an existing process. **Note:** This is not an officially supported endpoint in the OGC Processes specification.

### Example

Expand Down Expand Up @@ -904,10 +904,10 @@ with unity_sps_ogc_processes_api_python_client.ApiClient(configuration) as api_c
process_id = 'process_id_example' # str |

try:
# Unregister a process
api_instance.unregister_process_processes_process_id_delete(process_id)
# Undeploy a process
api_instance.undeploy_process_processes_process_id_delete(process_id)
except Exception as e:
print("Exception when calling DefaultApi->unregister_process_processes_process_id_delete: %s\n" % e)
print("Exception when calling DefaultApi->undeploy_process_processes_process_id_delete: %s\n" % e)
```


Expand Down
Loading

0 comments on commit 51e6978

Please sign in to comment.