Skip to content

Commit

Permalink
chore: revert changes to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Drew Meyers committed Sep 19, 2024
1 parent 50774b9 commit cfc8307
Showing 1 changed file with 37 additions and 41 deletions.
78 changes: 37 additions & 41 deletions libs/unity-sps-ogc-processes-api-client-python/README.md
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -11,24 +10,21 @@ This Python package is automatically generated by the [OpenAPI Generator](https:

This is an update

## 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
```
Expand All @@ -40,11 +36,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
```
Expand Down Expand Up @@ -83,11 +77,11 @@ configuration = unity_sps_ogc_processes_api_python_client.Configuration(
# 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.ConformanceApi(api_client)
api_instance = unity_sps_ogc_processes_api_python_client.DefaultApi(api_client)

try:
# Information about standards that this API conforms to
api_response = api_instance.get_conformance_conformance_get()
api_response = api_instance.conformance_declaration_conformance_get()
print("The response of DefaultApi->conformance_declaration_conformance_get:\n")
pprint(api_response)
except ApiException as e:
Expand All @@ -97,7 +91,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
------------ | ------------- | ------------- | -------------
Expand All @@ -114,47 +108,49 @@ 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* | [**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

- [Bbox](docs/Bbox.md)
- [ConfClasses](docs/ConfClasses.md)
- [Crs](docs/Crs.md)
- [Crs5](docs/Crs5.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)
- [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)
- [StatusCode](docs/StatusCode.md)
- [StatusInfo](docs/StatusInfo.md)
- [Subscriber](docs/Subscriber.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)
- [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)
- [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)
- [StatusCode](docs/StatusCode.md)
- [StatusInfo](docs/StatusInfo.md)
- [Subscriber](docs/Subscriber.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


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

### bearerAuth

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


## Author

0 comments on commit cfc8307

Please sign in to comment.