feat: Updated openapi spec

unity-sds · Sep 9, 2024 · ec098bf · ec098bf
1 parent b6a5272
commit ec098bf
Show file tree

Hide file tree

Showing 133 changed files with 1,901 additions and 1,796 deletions.
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
@@ -112,89 +112,6 @@ setup.cfg
 setup.py
 test-requirements.txt
 test/__init__.py
-test/test_actual_instance.py
-test/test_actual_instance1.py
-test/test_actual_instance2.py
-test/test_actual_instance3.py
-test/test_actual_instance4.py
-test/test_actual_instance5.py
-test/test_actual_instance6.py
-test/test_api_api.py
-test/test_bbox1.py
-test/test_bbox_bbox_inner.py
-test/test_bbox_def_crs.py
-test/test_conformance_api.py
-test/test_cpumax.py
-test/test_cpumin.py
-test/test_dru_api.py
-test/test_enumeration.py
-test/test_execute200_response_input.py
-test/test_execute200_response_input_any_of_value.py
-test/test_execute200_response_output.py
-test/test_execute200_response_output_any_of_value.py
-test/test_execute_workflows.py
-test/test_execution_unit.py
-test/test_execution_unit_config.py
-test/test_fields_modifiers_properties.py
-test/test_format.py
-test/test_format_schema.py
-test/test_health_api.py
-test/test_inline_or_ref_data_input.py
-test/test_inline_or_ref_data_output.py
-test/test_inline_or_ref_data_workflows.py
-test/test_input_collection.py
-test/test_input_description_input.py
-test/test_input_description_output.py
-test/test_input_parameterized.py
-test/test_input_process.py
-test/test_input_value_no_object_workflows.py
-test/test_input_value_workflows.py
-test/test_input_workflows.py
-test/test_input_workflows1.py
-test/test_input_workflows_any_of_inner.py
-test/test_job_list_input.py
-test/test_job_list_output.py
-test/test_jobs_api.py
-test/test_jobtimeout.py
-test/test_landing_page_api.py
-test/test_maximum.py
-test/test_memorymax.py
-test/test_memorymin.py
-test/test_metadata_input.py
-test/test_metadata_one_of.py
-test/test_metadata_one_of1.py
-test/test_metadata_one_of1_value.py
-test/test_metadata_output.py
-test/test_minimum.py
-test/test_model_schema_input.py
-test/test_model_schema_output.py
-test/test_multipleof.py
-test/test_ogcapppkg.py
-test/test_ogcapppkg_execution_unit.py
-test/test_ogcapppkg_execution_unit_any_of_inner.py
-test/test_oneof_schema2_validator.py
-test/test_oneof_schema6_validator.py
-test/test_output_description_input.py
-test/test_output_description_output.py
-test/test_output_workflows.py
-test/test_output_workflows1.py
-test/test_process_list_input.py
-test/test_process_list_output.py
-test/test_process_summary_input.py
-test/test_process_summary_output.py
-test/test_processes_api.py
-test/test_qualified_input_value_input.py
-test/test_qualified_input_value_output.py
-test/test_qualified_input_value_workflows.py
-test/test_reference.py
-test/test_schema1_input.py
-test/test_schema1_output.py
-test/test_schema_one_of_additional_properties_input.py
-test/test_schema_one_of_additional_properties_output.py
-test/test_schema_one_of_input.py
-test/test_schema_one_of_output.py
-test/test_storageoutputsmin.py
-test/test_storagetempmin.py
 tox.ini
 unity_sps_ogc_processes_api_python_client/__init__.py
 unity_sps_ogc_processes_api_python_client/api/__init__.py

diff --git a/README.md b/README.md
@@ -61,6 +61,15 @@ 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
@@ -204,7 +213,12 @@ Class | Method | HTTP request | Description
 <a id="documentation-for-authorization"></a>
 ## Documentation For Authorization
 
-Endpoints do not require authorization.
+
+Authentication schemes defined for the API:
+<a id="bearerAuth"></a>
+### bearerAuth
+
+- **Type**: Bearer authentication (JWT)
 
 
 ## Author
diff --git a/docs/APIApi.md b/docs/APIApi.md
@@ -15,6 +15,7 @@ Retrieve this API definition.
 
 ### Example
 
+* Bearer (JWT) Authentication (bearerAuth):
 
 ```python
 import unity_sps_ogc_processes_api_python_client
@@ -27,6 +28,15 @@ 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:
@@ -58,7 +68,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[bearerAuth](../README.md#bearerAuth)
 
 ### HTTP request headers
 
@@ -71,8 +81,8 @@ No authorization required
 |-------------|-------------|------------------|
 **200** | The OpenAPI definition of the API. |  -  |
 **406** | Content negotiation failed. For example, the &amp;#x60;Accept&amp;#x60; header submitted in the request did not support any of the media types supported by the server for the requested resource. |  -  |
-**500** | A server error occurred. |  -  |
 **422** | Validation Error |  -  |
+**500** | A server error occurred. |  -  |
 
 [[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)
 
@@ -83,6 +93,7 @@ Retrieve the list of processes available from this API implementation &amp; depl
 
 ### Example
 
+* Bearer (JWT) Authentication (bearerAuth):
 
 ```python
 import unity_sps_ogc_processes_api_python_client
@@ -96,6 +107,15 @@ 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:
@@ -127,7 +147,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[bearerAuth](../README.md#bearerAuth)
 
 ### HTTP request headers
 
@@ -141,7 +161,7 @@ No authorization required
 **200** | An enumerated list of valid string values for API parameters. |  -  |
 **404** | The requested resource does not exist on the server. For example, a path parameter had an incorrect value. |  -  |
 **406** | Content negotiation failed. For example, the &amp;#x60;Accept&amp;#x60; header submitted in the request did not support any of the media types supported by the server for the requested resource. |  -  |
-**500** | A server error occurred. |  -  |
 **422** | Validation Error |  -  |
+**500** | A server error occurred. |  -  |
 
 [[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)
diff --git a/docs/ActualInstance.md b/docs/ActualInstance.md
@@ -5,6 +5,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**actual_instance** | [**ActualInstance1**](ActualInstance1.md) |  | [optional]
+**one_of_schemas** | **List[str]** |  | [optional]
+**oneof_schema_10_validator** | [**InputParameterized**](InputParameterized.md) |  | [optional]
 **oneof_schema_1_validator** | **str** |  | [optional]
 **oneof_schema_2_validator** | [**OneofSchema2Validator**](OneofSchema2Validator.md) |  | [optional]
 **oneof_schema_3_validator** | **int** |  | [optional]
@@ -14,19 +17,16 @@ Name | Type | Description | Notes
 **oneof_schema_7_validator** | [**Bbox1**](Bbox1.md) |  | [optional]
 **oneof_schema_8_validator** | [**InputCollection**](InputCollection.md) |  | [optional]
 **oneof_schema_9_validator** | [**InputProcess**](InputProcess.md) |  | [optional]
-**oneof_schema_10_validator** | [**InputParameterized**](InputParameterized.md) |  | [optional]
-**actual_instance** | [**ActualInstance1**](ActualInstance1.md) |  | [optional]
-**one_of_schemas** | **List[str]** |  | [optional]
 **href** | **str** |  |
-**rel** | **str** |  | [optional]
-**type** | **str** |  | [optional]
 **hreflang** | **str** |  | [optional]
+**rel** | **str** |  | [optional]
 **title** | **str** |  | [optional]
-**media_type** | **str** |  | [optional]
+**type** | **str** |  | [optional]
 **encoding** | **str** |  | [optional]
-**var_schema** | [**FormatSchema**](FormatSchema.md) |  | [optional]
 **filter** | **str** |  | [optional]
+**media_type** | **str** |  | [optional]
 **properties** | [**FieldsModifiersProperties**](FieldsModifiersProperties.md) |  | [optional]
+**var_schema** | [**FormatSchema**](FormatSchema.md) |  | [optional]
 **sort_by** | **List[str]** |  | [optional]
 **value** | [**InputValueWorkflows**](InputValueWorkflows.md) |  |
 

diff --git a/docs/ActualInstance1.md b/docs/ActualInstance1.md
@@ -7,14 +7,14 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **bbox** | [**List[BboxBboxInner]**](BboxBboxInner.md) |  |
 **crs** | [**BboxDefCrs**](BboxDefCrs.md) |  | [optional]
+**collection** | **str** |  |
 **filter** | **str** |  | [optional]
 **properties** | [**FieldsModifiersProperties**](FieldsModifiersProperties.md) |  | [optional]
 **sort_by** | **List[str]** |  | [optional]
-**collection** | **str** |  |
 **input** | **str** |  |
-**process** | **str** | URI to the process execution end point (i.e., &#x60;.../processes/{processId}/execution&#x60;) |
 **inputs** | [**Dict[str, InputWorkflows1]**](InputWorkflows1.md) |  | [optional]
 **outputs** | [**Dict[str, OutputWorkflows1]**](OutputWorkflows1.md) |  | [optional]
+**process** | **str** | URI to the process execution end point (i.e., &#x60;.../processes/{processId}/execution&#x60;) |
 **subscriber** | [**Subscriber**](Subscriber.md) |  | [optional]
 
 ## Example

diff --git a/docs/ActualInstance2.md b/docs/ActualInstance2.md
@@ -5,11 +5,11 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**actual_instance** | [**ActualInstance**](ActualInstance.md) |  | [optional]
+**one_of_schemas** | **List[str]** |  | [optional]
 **oneof_schema_1_validator** | [**InputValueNoObjectWorkflows**](InputValueNoObjectWorkflows.md) |  | [optional]
 **oneof_schema_2_validator** | [**QualifiedInputValueWorkflows**](QualifiedInputValueWorkflows.md) |  | [optional]
 **oneof_schema_3_validator** | [**Link**](Link.md) |  | [optional]
-**actual_instance** | [**ActualInstance**](ActualInstance.md) |  | [optional]
-**one_of_schemas** | **List[str]** |  | [optional]
 
 ## Example
 

diff --git a/docs/ActualInstance3.md b/docs/ActualInstance3.md
@@ -6,41 +6,41 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **ref** | **str** |  |
-**title** | **str** |  | [optional]
-**multiple_of** | [**Multipleof**](Multipleof.md) |  | [optional]
-**maximum** | [**Maximum**](Maximum.md) |  | [optional]
+**additional_properties** | [**SchemaOneOfAdditionalPropertiesInput**](SchemaOneOfAdditionalPropertiesInput.md) |  | [optional]
+**all_of** | [**List[Schema1Input]**](Schema1Input.md) |  | [optional]
+**any_of** | [**List[Schema1Input]**](Schema1Input.md) |  | [optional]
+**content_encoding** | **str** |  | [optional]
+**content_media_type** | **str** |  | [optional]
+**content_schema** | **str** |  | [optional]
+**default** | **object** |  | [optional]
+**deprecated** | **bool** |  | [optional]
+**description** | **str** |  | [optional]
+**enum** | **List[object]** |  | [optional]
+**example** | **object** |  | [optional]
 **exclusive_maximum** | **bool** |  | [optional]
-**minimum** | [**Minimum**](Minimum.md) |  | [optional]
 **exclusive_minimum** | **bool** |  | [optional]
-**max_length** | **int** |  | [optional]
-**min_length** | **int** |  | [optional]
-**pattern** | **str** |  | [optional]
+**format** | **str** |  | [optional]
+**items** | [**Schema1Input**](Schema1Input.md) |  | [optional]
 **max_items** | **int** |  | [optional]
-**min_items** | **int** |  | [optional]
-**unique_items** | **bool** |  | [optional]
+**max_length** | **int** |  | [optional]
 **max_properties** | **int** |  | [optional]
+**maximum** | [**Maximum**](Maximum.md) |  | [optional]
+**min_items** | **int** |  | [optional]
+**min_length** | **int** |  | [optional]
 **min_properties** | **int** |  | [optional]
-**required** | **List[str]** |  | [optional]
-**enum** | **List[object]** |  | [optional]
-**type** | **str** |  | [optional]
+**minimum** | [**Minimum**](Minimum.md) |  | [optional]
+**multiple_of** | [**Multipleof**](Multipleof.md) |  | [optional]
 **var_not** | [**Schema1Input**](Schema1Input.md) |  | [optional]
-**all_of** | [**List[Schema1Input]**](Schema1Input.md) |  | [optional]
+**nullable** | **bool** |  | [optional]
 **one_of** | [**List[Schema1Input]**](Schema1Input.md) |  | [optional]
-**any_of** | [**List[Schema1Input]**](Schema1Input.md) |  | [optional]
-**items** | [**Schema1Input**](Schema1Input.md) |  | [optional]
+**pattern** | **str** |  | [optional]
 **properties** | [**Dict[str, Schema1Input]**](Schema1Input.md) |  | [optional]
-**additional_properties** | [**SchemaOneOfAdditionalPropertiesInput**](SchemaOneOfAdditionalPropertiesInput.md) |  | [optional]
-**description** | **str** |  | [optional]
-**format** | **str** |  | [optional]
-**default** | **object** |  | [optional]
-**nullable** | **bool** |  | [optional]
 **read_only** | **bool** |  | [optional]
+**required** | **List[str]** |  | [optional]
+**title** | **str** |  | [optional]
+**type** | **str** |  | [optional]
+**unique_items** | **bool** |  | [optional]
 **write_only** | **bool** |  | [optional]
-**example** | **object** |  | [optional]
-**deprecated** | **bool** |  | [optional]
-**content_media_type** | **str** |  | [optional]
-**content_encoding** | **str** |  | [optional]
-**content_schema** | **str** |  | [optional]
 
 ## Example