ogc-api

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 project:

• API version: 1.0.0
• Package version: 1.0.0
• Generator version: 7.12.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.ogc.org/contacts

Requirements.

Python 3.8+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

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:

import ogc_api_processes_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import ogc_api_processes_client

Tests

Execute task test (or hatch run test:run) to run the tests.

Development Tasks

Use Taskfile targets for local development:

• task build-safe: regenerate code, apply post-generation fixes, run lint checks, and run tests
• task check: run Ruff checks with auto-fix
• task lint: format with Ruff
• task test: run the test suite

Code Generation Caveats

Code generation can overwrite repository files if run directly via OpenAPI Generator.

• Prefer task build-safe instead of raw generation commands.
• The low-level build task is internal and is orchestrated by build-safe.
• .openapi-generator-ignore protects project-maintained files (pyproject.toml, CI workflows, etc.); keep it up to date.
• build-safe includes deterministic post-generation fixes (including the known bytearray/pydantic>=2 incompatibility), then runs check and test.

Getting Started

Please follow the installation procedure and then run the following:

import ogc_api_processes_client
from ogc_api_processes_client.rest import ApiException
from pprint import pprint

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



# Enter a context with an instance of the API client
with ogc_api_processes_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ogc_api_processes_client.CapabilitiesApi(api_client)

    try:
        # landing page of this API
        api_response = api_instance.get_landing_page()
        print("The response of CapabilitiesApi->get_landing_page:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CapabilitiesApi->get_landing_page: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://example.org/ogc

Class	Method	HTTP request	Description
CapabilitiesApi	get_landing_page	GET /	landing page of this API
ConformanceDeclarationApi	get_conformance_classes	GET /conformance	information about standards that this API conforms to
DismissApi	dismiss	DELETE /jobs/{jobId}	cancel a job execution, remove a finished job
ExecuteApi	execute	POST /processes/{processID}/execution	execute a process.
JobListApi	get_jobs	GET /jobs	retrieve the list of jobs.
ProcessDescriptionApi	get_process_description	GET /processes/{processID}	retrieve a process description
ProcessListApi	get_processes	GET /processes	retrieve the list of available processes
ResultApi	get_result	GET /jobs/{jobId}/results	retrieve the result(s) of a job
StatusApi	get_status	GET /jobs/{jobId}	retrieve the status of a job

Documentation For Models

• AdditionalParameter
• AdditionalParameterValueInner
• Bbox
• ConfClasses
• DescriptionType
• DescriptionTypeAdditionalParameters
• Exception
• Execute
• Execute200Response
• ExecuteInputsValue
• Format
• FormatSchema
• InlineOrRefData
• InputDescription
• InputDescriptionAllOfMaxOccurs
• InputValue
• InputValueNoObject
• JobControlOptions
• JobList
• LandingPage
• Link
• Metadata
• ModelSchema
• Output
• OutputDescription
• Process
• ProcessList
• ProcessSummary
• QualifiedInputValue
• Reference
• SchemaOneOf
• SchemaOneOfAdditionalProperties
• SchemaOneOfNot
• StatusCode
• StatusInfo
• Subscriber
• TransmissionMode

Documentation For Authorization

Endpoints do not require authorization.

Author

standards-team@ogc.org