diff --git a/README.md b/README.md index 469d1c6..6db876e 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,20 @@ # unity-sps-ogc-processes-api-python-client + This document is an API definition document provided alongside the OGC API - Processes standard. The OGC API - Processes Standard specifies a processing interface to communicate over a RESTful protocol using JavaScript Object Notation (JSON) encodings. The specification allows for the wrapping of computational tasks into executable processes that can be offered by a server and be invoked by a client application. This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - API version: 2.0.0 -- Package version: 1.0.0 +- Package version: 2.0.1 - Generator version: 7.7.0 - Build package: org.openapitools.codegen.languages.PythonClientCodegen -## Requirements. +## Requirements Python 3.7+ ## Installation & Usage + ### pip install If the python package is hosted on a repository, you can install directly using: @@ -20,9 +22,11 @@ If the python package is hosted on a repository, you can install directly using: ```sh pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git ``` + (you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`) Then import the package: + ```python import unity_sps_ogc_processes_api_python_client ``` @@ -34,9 +38,11 @@ Install via [Setuptools](http://pypi.python.org/pypi/setuptools). ```sh python setup.py install --user ``` + (or `sudo python setup.py install` to install the package for all users) Then import the package: + ```python import unity_sps_ogc_processes_api_python_client ``` @@ -90,7 +96,7 @@ with unity_sps_ogc_processes_api_python_client.ApiClient(configuration) as api_c ## Documentation for API Endpoints -All URIs are relative to *http://localhost* +All URIs are relative to ** Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- @@ -110,115 +116,113 @@ Class | Method | HTTP request | Description *ProcessesApi* | [**get_process_description_processes_process_id_get**](docs/ProcessesApi.md#get_process_description_processes_process_id_get) | **GET** /processes/{processId} | retrieve a process description *ProcessesApi* | [**get_processes_processes_get**](docs/ProcessesApi.md#get_processes_processes_get) | **GET** /processes | retrieve the list of available processes - ## Documentation For Models - - [ActualInstance](docs/ActualInstance.md) - - [ActualInstance1](docs/ActualInstance1.md) - - [ActualInstance2](docs/ActualInstance2.md) - - [ActualInstance3](docs/ActualInstance3.md) - - [ActualInstance4](docs/ActualInstance4.md) - - [ActualInstance5](docs/ActualInstance5.md) - - [ActualInstance6](docs/ActualInstance6.md) - - [Bbox](docs/Bbox.md) - - [Bbox1](docs/Bbox1.md) - - [BboxBboxInner](docs/BboxBboxInner.md) - - [BboxDefCrs](docs/BboxDefCrs.md) - - [ConfClasses](docs/ConfClasses.md) - - [Cpumax](docs/Cpumax.md) - - [Cpumin](docs/Cpumin.md) - - [Enumeration](docs/Enumeration.md) - - [Exception](docs/Exception.md) - - [Execute200ResponseInput](docs/Execute200ResponseInput.md) - - [Execute200ResponseInputAnyOfValue](docs/Execute200ResponseInputAnyOfValue.md) - - [Execute200ResponseOutput](docs/Execute200ResponseOutput.md) - - [Execute200ResponseOutputAnyOfValue](docs/Execute200ResponseOutputAnyOfValue.md) - - [ExecuteWorkflows](docs/ExecuteWorkflows.md) - - [ExecutionUnit](docs/ExecutionUnit.md) - - [ExecutionUnitConfig](docs/ExecutionUnitConfig.md) - - [FieldsModifiersProperties](docs/FieldsModifiersProperties.md) - - [Format](docs/Format.md) - - [FormatSchema](docs/FormatSchema.md) - - [HTTPValidationError](docs/HTTPValidationError.md) - - [HealthCheck](docs/HealthCheck.md) - - [InlineOrRefDataInput](docs/InlineOrRefDataInput.md) - - [InlineOrRefDataOutput](docs/InlineOrRefDataOutput.md) - - [InlineOrRefDataWorkflows](docs/InlineOrRefDataWorkflows.md) - - [InputCollection](docs/InputCollection.md) - - [InputDescriptionInput](docs/InputDescriptionInput.md) - - [InputDescriptionOutput](docs/InputDescriptionOutput.md) - - [InputParameterized](docs/InputParameterized.md) - - [InputProcess](docs/InputProcess.md) - - [InputValueInput](docs/InputValueInput.md) - - [InputValueNoObjectInput](docs/InputValueNoObjectInput.md) - - [InputValueNoObjectOutput](docs/InputValueNoObjectOutput.md) - - [InputValueNoObjectWorkflows](docs/InputValueNoObjectWorkflows.md) - - [InputValueOutput](docs/InputValueOutput.md) - - [InputValueWorkflows](docs/InputValueWorkflows.md) - - [InputWorkflows](docs/InputWorkflows.md) - - [InputWorkflows1](docs/InputWorkflows1.md) - - [InputWorkflowsAnyOfInner](docs/InputWorkflowsAnyOfInner.md) - - [JobControlOptions](docs/JobControlOptions.md) - - [JobListInput](docs/JobListInput.md) - - [JobListOutput](docs/JobListOutput.md) - - [Jobtimeout](docs/Jobtimeout.md) - - [LandingPage](docs/LandingPage.md) - - [Link](docs/Link.md) - - [Maximum](docs/Maximum.md) - - [Memorymax](docs/Memorymax.md) - - [Memorymin](docs/Memorymin.md) - - [MetadataInput](docs/MetadataInput.md) - - [MetadataOneOf](docs/MetadataOneOf.md) - - [MetadataOneOf1](docs/MetadataOneOf1.md) - - [MetadataOneOf1Value](docs/MetadataOneOf1Value.md) - - [MetadataOutput](docs/MetadataOutput.md) - - [Minimum](docs/Minimum.md) - - [ModelSchemaInput](docs/ModelSchemaInput.md) - - [ModelSchemaOutput](docs/ModelSchemaOutput.md) - - [Multipleof](docs/Multipleof.md) - - [Ogcapppkg](docs/Ogcapppkg.md) - - [OgcapppkgExecutionUnit](docs/OgcapppkgExecutionUnit.md) - - [OgcapppkgExecutionUnitAnyOfInner](docs/OgcapppkgExecutionUnitAnyOfInner.md) - - [OneofSchema2Validator](docs/OneofSchema2Validator.md) - - [OneofSchema6Validator](docs/OneofSchema6Validator.md) - - [OutputDescriptionInput](docs/OutputDescriptionInput.md) - - [OutputDescriptionOutput](docs/OutputDescriptionOutput.md) - - [OutputWorkflows](docs/OutputWorkflows.md) - - [OutputWorkflows1](docs/OutputWorkflows1.md) - - [ProcessInput](docs/ProcessInput.md) - - [ProcessListInput](docs/ProcessListInput.md) - - [ProcessListOutput](docs/ProcessListOutput.md) - - [ProcessOutput](docs/ProcessOutput.md) - - [ProcessSummaryInput](docs/ProcessSummaryInput.md) - - [ProcessSummaryOutput](docs/ProcessSummaryOutput.md) - - [QualifiedInputValueInput](docs/QualifiedInputValueInput.md) - - [QualifiedInputValueOutput](docs/QualifiedInputValueOutput.md) - - [QualifiedInputValueWorkflows](docs/QualifiedInputValueWorkflows.md) - - [Reference](docs/Reference.md) - - [Schema1Input](docs/Schema1Input.md) - - [Schema1Output](docs/Schema1Output.md) - - [SchemaOneOfAdditionalPropertiesInput](docs/SchemaOneOfAdditionalPropertiesInput.md) - - [SchemaOneOfAdditionalPropertiesOutput](docs/SchemaOneOfAdditionalPropertiesOutput.md) - - [SchemaOneOfInput](docs/SchemaOneOfInput.md) - - [SchemaOneOfOutput](docs/SchemaOneOfOutput.md) - - [StatusCode](docs/StatusCode.md) - - [StatusInfo](docs/StatusInfo.md) - - [Storageoutputsmin](docs/Storageoutputsmin.md) - - [Storagetempmin](docs/Storagetempmin.md) - - [Subscriber](docs/Subscriber.md) - - [ValidationError](docs/ValidationError.md) - - [ValidationErrorLocInner](docs/ValidationErrorLocInner.md) - +- [ActualInstance](docs/ActualInstance.md) +- [ActualInstance1](docs/ActualInstance1.md) +- [ActualInstance2](docs/ActualInstance2.md) +- [ActualInstance3](docs/ActualInstance3.md) +- [ActualInstance4](docs/ActualInstance4.md) +- [ActualInstance5](docs/ActualInstance5.md) +- [ActualInstance6](docs/ActualInstance6.md) +- [Bbox](docs/Bbox.md) +- [Bbox1](docs/Bbox1.md) +- [BboxBboxInner](docs/BboxBboxInner.md) +- [BboxDefCrs](docs/BboxDefCrs.md) +- [ConfClasses](docs/ConfClasses.md) +- [Cpumax](docs/Cpumax.md) +- [Cpumin](docs/Cpumin.md) +- [Enumeration](docs/Enumeration.md) +- [Exception](docs/Exception.md) +- [Execute200ResponseInput](docs/Execute200ResponseInput.md) +- [Execute200ResponseInputAnyOfValue](docs/Execute200ResponseInputAnyOfValue.md) +- [Execute200ResponseOutput](docs/Execute200ResponseOutput.md) +- [Execute200ResponseOutputAnyOfValue](docs/Execute200ResponseOutputAnyOfValue.md) +- [ExecuteWorkflows](docs/ExecuteWorkflows.md) +- [ExecutionUnit](docs/ExecutionUnit.md) +- [ExecutionUnitConfig](docs/ExecutionUnitConfig.md) +- [FieldsModifiersProperties](docs/FieldsModifiersProperties.md) +- [Format](docs/Format.md) +- [FormatSchema](docs/FormatSchema.md) +- [HTTPValidationError](docs/HTTPValidationError.md) +- [HealthCheck](docs/HealthCheck.md) +- [InlineOrRefDataInput](docs/InlineOrRefDataInput.md) +- [InlineOrRefDataOutput](docs/InlineOrRefDataOutput.md) +- [InlineOrRefDataWorkflows](docs/InlineOrRefDataWorkflows.md) +- [InputCollection](docs/InputCollection.md) +- [InputDescriptionInput](docs/InputDescriptionInput.md) +- [InputDescriptionOutput](docs/InputDescriptionOutput.md) +- [InputParameterized](docs/InputParameterized.md) +- [InputProcess](docs/InputProcess.md) +- [InputValueInput](docs/InputValueInput.md) +- [InputValueNoObjectInput](docs/InputValueNoObjectInput.md) +- [InputValueNoObjectOutput](docs/InputValueNoObjectOutput.md) +- [InputValueNoObjectWorkflows](docs/InputValueNoObjectWorkflows.md) +- [InputValueOutput](docs/InputValueOutput.md) +- [InputValueWorkflows](docs/InputValueWorkflows.md) +- [InputWorkflows](docs/InputWorkflows.md) +- [InputWorkflows1](docs/InputWorkflows1.md) +- [InputWorkflowsAnyOfInner](docs/InputWorkflowsAnyOfInner.md) +- [JobControlOptions](docs/JobControlOptions.md) +- [JobListInput](docs/JobListInput.md) +- [JobListOutput](docs/JobListOutput.md) +- [Jobtimeout](docs/Jobtimeout.md) +- [LandingPage](docs/LandingPage.md) +- [Link](docs/Link.md) +- [Maximum](docs/Maximum.md) +- [Memorymax](docs/Memorymax.md) +- [Memorymin](docs/Memorymin.md) +- [MetadataInput](docs/MetadataInput.md) +- [MetadataOneOf](docs/MetadataOneOf.md) +- [MetadataOneOf1](docs/MetadataOneOf1.md) +- [MetadataOneOf1Value](docs/MetadataOneOf1Value.md) +- [MetadataOutput](docs/MetadataOutput.md) +- [Minimum](docs/Minimum.md) +- [ModelSchemaInput](docs/ModelSchemaInput.md) +- [ModelSchemaOutput](docs/ModelSchemaOutput.md) +- [Multipleof](docs/Multipleof.md) +- [Ogcapppkg](docs/Ogcapppkg.md) +- [OgcapppkgExecutionUnit](docs/OgcapppkgExecutionUnit.md) +- [OgcapppkgExecutionUnitAnyOfInner](docs/OgcapppkgExecutionUnitAnyOfInner.md) +- [OneofSchema2Validator](docs/OneofSchema2Validator.md) +- [OneofSchema6Validator](docs/OneofSchema6Validator.md) +- [OutputDescriptionInput](docs/OutputDescriptionInput.md) +- [OutputDescriptionOutput](docs/OutputDescriptionOutput.md) +- [OutputWorkflows](docs/OutputWorkflows.md) +- [OutputWorkflows1](docs/OutputWorkflows1.md) +- [ProcessInput](docs/ProcessInput.md) +- [ProcessListInput](docs/ProcessListInput.md) +- [ProcessListOutput](docs/ProcessListOutput.md) +- [ProcessOutput](docs/ProcessOutput.md) +- [ProcessSummaryInput](docs/ProcessSummaryInput.md) +- [ProcessSummaryOutput](docs/ProcessSummaryOutput.md) +- [QualifiedInputValueInput](docs/QualifiedInputValueInput.md) +- [QualifiedInputValueOutput](docs/QualifiedInputValueOutput.md) +- [QualifiedInputValueWorkflows](docs/QualifiedInputValueWorkflows.md) +- [Reference](docs/Reference.md) +- [Schema1Input](docs/Schema1Input.md) +- [Schema1Output](docs/Schema1Output.md) +- [SchemaOneOfAdditionalPropertiesInput](docs/SchemaOneOfAdditionalPropertiesInput.md) +- [SchemaOneOfAdditionalPropertiesOutput](docs/SchemaOneOfAdditionalPropertiesOutput.md) +- [SchemaOneOfInput](docs/SchemaOneOfInput.md) +- [SchemaOneOfOutput](docs/SchemaOneOfOutput.md) +- [StatusCode](docs/StatusCode.md) +- [StatusInfo](docs/StatusInfo.md) +- [Storageoutputsmin](docs/Storageoutputsmin.md) +- [Storagetempmin](docs/Storagetempmin.md) +- [Subscriber](docs/Subscriber.md) +- [ValidationError](docs/ValidationError.md) +- [ValidationErrorLocInner](docs/ValidationErrorLocInner.md) -## Documentation For Authorization +## Documentation For Authorization Authentication schemes defined for the API: + ### bearerAuth - **Type**: Bearer authentication (JWT) - ## Author diff --git a/pyproject.toml b/pyproject.toml index 72e76b1..3ad2380 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "unity_sps_ogc_processes_api_python_client" -version = "1.0.0" +version = "2.0.1" description = "Unity Processing API conforming to the Draft of OGC API - Processes - Part 2: Deploy, Replace, Undeploy" authors = ["OpenAPI Generator Community "] license = "NoLicense" diff --git a/setup.py b/setup.py index b59a791..ca5a6b2 100644 --- a/setup.py +++ b/setup.py @@ -21,7 +21,7 @@ # prerequisite: setuptools # http://pypi.python.org/pypi/setuptools NAME = "unity-sps-ogc-processes-api-python-client" -VERSION = "1.0.0" +VERSION = "2.0.1" PYTHON_REQUIRES = ">=3.7" REQUIRES = [ "urllib3 >= 1.25.3, < 2.1.0", diff --git a/unity_sps_ogc_processes_api_python_client/__init__.py b/unity_sps_ogc_processes_api_python_client/__init__.py index babaeea..6691744 100644 --- a/unity_sps_ogc_processes_api_python_client/__init__.py +++ b/unity_sps_ogc_processes_api_python_client/__init__.py @@ -14,7 +14,7 @@ """ # noqa: E501 -__version__ = "1.0.0" +__version__ = "2.0.0" # import apis into sdk package from unity_sps_ogc_processes_api_python_client.api.api_api import APIApi