Skip to content

Latest commit

 

History

History
73 lines (46 loc) · 3.58 KB

clause_2_conformance.adoc

File metadata and controls

73 lines (46 loc) · 3.58 KB

Conformance

This standard defines seven requirements / conformance classes.

The standardization targets of all conformance classes are "Web APIs."

The main requirements class is:

The Core specifies requirements that all Web APIs have to implement.

Two requirements classes depend on the Core and specify representations for the resources specified in the Core:

The JSON encoding is mandatory.

The Core does not mandate any encoding or format for the formal definition of the API. OpenAPI 3.0 specification is one option for defining the Processing API. As such a requirements class has been specified for OpenAPI 3.0, which depends on the requirements class Core:

An implementation of the Core requirements class may also decide to use other API definition representations in addition to, or instead of, an OpenAPI 3.0 definition. Examples for alternative API definitions: OpenAPI 2.0 (Swagger), future versions of the OpenAPI specification, an OWS Common 2.0 capabilities document or WSDL.

Note

OpenAPI 3.0 offers an open, powerful and vendor neutral description format. While the use of OpenAPI 3.0 for the formal definition of the API is not mandatory, the requests/responses of the API specified in this standard are defined using OpenAPI 3.0 schemas. See also the note regarding /req/core/landingpage-success

The Core is intended to be a minimal useful API for the execution of processes in the geospatial domain. The Core is designed to map the operations of a Web Processing Service 2.0 instance.

The Core does not mandate the use of any specific process description to specify the interface of a process. Instead this standard defines and recommends the use of the following conformance class:

This class defines an information model, encoded in JSON, which may be used to specify the interface of a process.

Three additional conformance classes are specified that extend the basic functionality of an API:

Additional capabilities such as support for transactions, extended job monitoring, etc., may be specified in future parts of the OGC API - Processes series or as vendor-specific extensions.

Conformance with this standard SHALL be checked using all the relevant tests specified in Annex A (normative) of this document. The framework, concepts, and methodology for testing, and the criteria to be achieved to claim conformance are specified in the OGC Compliance Testing Policies and Procedures and the OGC Compliance Testing web site.

Table 1. Conformance class URIs
Conformance class URI

Core

http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/core

OGC Process Description

http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/ogc-process-description

JSON

http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/json

HTML

http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/html

OpenAPI Specification 3.0

http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/oas30

Job list

http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/job-list

Callback

http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/callback

Dismiss

http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/dismiss