| Conformance URI | Title |
|---|---|
| http://www.opengis.net/spec/ogcapi-common-1/1.0/req/oas30 | Open GeoSpatial Consortium API Commons - Part 1: OpenAPI Version 3.0 |
Part 1 of The OGC API Common version 1.0 Specification outlines requirements for API documentation. The intent for this requirement is to produce content that humans and machines can use. In particular, human-readable content should aid developers with understand how to use and access the API. Well machine-readable documentation should aid developers using common tools to create coding interfaces to the API. One of the recommendations in Part 1 is to use OpenAPI version 3.0 to document the API.
The Portfolio Listing service provides a JSON encoding of the OpenAPI version 3.0 Specification to define the application interfaces the API provides. This includes the specification of open and protected API endpoints. For example, the documentation and user registration endpoints are open to everyone. Where the creation of an API in the Portfolio Listing is protected with Basic Authentication. The Portfolio Listing Service also provides an HTML version of the Portfolio Listing API generated from the OpenAPI document. This should help developers learn about and experiment with the API for use in their application.
To learn more, read the core requirement for OpenAPI in Part 1 of the OGC API Common Specification.