Merge pull request #2 from unity-sds/openapi-auth

added authentication to openapi spec for bearer authentication

.openapi-generator/FILES

@@ -1,7 +1,6 @@
 .github/workflows/python.yml
 .gitignore
 .gitlab-ci.yml
-.openapi-generator-ignore
 .travis.yml
 README.md
 docs/Bbox.md

README.md

@@ -1,5 +1,4 @@
 # 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:
@@ -9,24 +8,21 @@ This Python package is automatically generated by the [OpenAPI Generator](https:
 - Generator version: 7.5.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:
 
 ```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
 ```
@@ -38,11 +34,9 @@ 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
 ```
@@ -67,6 +61,16 @@ 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:
@@ -85,7 +89,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 *http://localhost*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
@@ -102,46 +106,57 @@ Class | Method | HTTP request | Description
 *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
 
+
 ## Documentation For Models
 
-- [Bbox](docs/Bbox.md)
-- [ConfClasses](docs/ConfClasses.md)
-- [Crs](docs/Crs.md)
-- [Crs5](docs/Crs5.md)
-- [Detail](docs/Detail.md)
-- [Exception](docs/Exception.md)
-- [Execute](docs/Execute.md)
-- [HTTPValidationError](docs/HTTPValidationError.md)
-- [HealthCheck](docs/HealthCheck.md)
-- [InputValueInput](docs/InputValueInput.md)
-- [InputValueNoObjectInput](docs/InputValueNoObjectInput.md)
-- [InputValueNoObjectOutput](docs/InputValueNoObjectOutput.md)
-- [InputValueOutput](docs/InputValueOutput.md)
-- [Instance](docs/Instance.md)
-- [JobControlOptions](docs/JobControlOptions.md)
-- [JobList](docs/JobList.md)
-- [LandingPage](docs/LandingPage.md)
-- [Link](docs/Link.md)
-- [Metadata](docs/Metadata.md)
-- [Metadata1](docs/Metadata1.md)
-- [Metadata2](docs/Metadata2.md)
-- [ProcessInput](docs/ProcessInput.md)
-- [ProcessList](docs/ProcessList.md)
-- [ProcessOutput](docs/ProcessOutput.md)
-- [ProcessSummary](docs/ProcessSummary.md)
-- [Status](docs/Status.md)
-- [StatusCode](docs/StatusCode.md)
-- [StatusInfo](docs/StatusInfo.md)
-- [Subscriber](docs/Subscriber.md)
-- [Title](docs/Title.md)
-- [ValidationError](docs/ValidationError.md)
-- [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)
-- [Value](docs/Value.md)
+ - [Bbox](docs/Bbox.md)
+ - [ConfClasses](docs/ConfClasses.md)
+ - [Crs](docs/Crs.md)
+ - [Crs5](docs/Crs5.md)
+ - [Detail](docs/Detail.md)
+ - [Exception](docs/Exception.md)
+ - [Execute](docs/Execute.md)
+ - [HTTPValidationError](docs/HTTPValidationError.md)
+ - [HealthCheck](docs/HealthCheck.md)
+ - [InputValueInput](docs/InputValueInput.md)
+ - [InputValueNoObjectInput](docs/InputValueNoObjectInput.md)
+ - [InputValueNoObjectOutput](docs/InputValueNoObjectOutput.md)
+ - [InputValueOutput](docs/InputValueOutput.md)
+ - [Instance](docs/Instance.md)
+ - [JobControlOptions](docs/JobControlOptions.md)
+ - [JobList](docs/JobList.md)
+ - [LandingPage](docs/LandingPage.md)
+ - [Link](docs/Link.md)
+ - [Metadata](docs/Metadata.md)
+ - [Metadata1](docs/Metadata1.md)
+ - [Metadata2](docs/Metadata2.md)
+ - [ProcessInput](docs/ProcessInput.md)
+ - [ProcessList](docs/ProcessList.md)
+ - [ProcessOutput](docs/ProcessOutput.md)
+ - [ProcessSummary](docs/ProcessSummary.md)
+ - [Status](docs/Status.md)
+ - [StatusCode](docs/StatusCode.md)
+ - [StatusInfo](docs/StatusInfo.md)
+ - [Subscriber](docs/Subscriber.md)
+ - [Title](docs/Title.md)
+ - [ValidationError](docs/ValidationError.md)
+ - [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)
+ - [Value](docs/Value.md)
 
-<a id="documentation-for-authorization"></a>
 
+<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
+
+
+
+