discovery module

November 18, 2025 · View on GitHub

home

modules

discovery module

URLS to comply to OGC, to describe the interface

GET / -> landingPage

Landing page
Gives a (technical & human readable) output describing how this API must be used. If the parameter f=html is supplied, a human readable page must be responded.
Parameters
NameInTypeRequiredDescription
fquerystringThe optional f parameter indicates the output format that the server shall provide as part of the response document. The default format is JSON.
Responses
CodeContent typeTypeDescription
200application/jsonlandingPageThe reponse containing a landing page

GET /api

This document
This document
Parameters
NameInTypeRequiredDescription
fquerystringThe optional f parameter indicates the output format that the server shall provide as part of the response document. The default format is JSON.
Responses
CodeContent typeTypeDescription

GET /collections -> collections

the feature collections in the dataset
returns a collection of available collection (like offers, packages, legs, support-requests and payments)
Responses
CodeContent typeTypeDescription
200application/jsoncollectionsA list of available collections

GET /collections/{collectionId}?collectionId=... -> collection

describe the feature collection with id `collectionId`
a (machine or human) readable description of this collection
Parameters
NameInTypeRequiredDescription
collectionIdpathstringlocal identifier of a collection
Responses
CodeContent typeTypeDescription
200application/jsoncollectiondescription of data delivered by this collection

GET /conformance -> conformance

API conformance definition
A list of all conformance classes specified in a standard that the server conforms to.
Parameters
NameInTypeRequiredDescription
fquerystringThe optional f parameter indicates the output format that the server shall provide as part of the response document. The default format is JSON.
Responses
CodeContent typeTypeDescription
200application/jsonconformanceThe URIs of all conformance classes supported by the server.

To support "generic" clients that want to access multiple OGC API Features implementations - and not "just" a specific API / server, the server declares the conformance classes it implements and conforms to.


GET /processes -> processList

retrieve the list of available processes
The list of processes contains a summary of each process the OGC API - Processes offers, including the link to a more detailed description of the process. For more information, see Section 7.9.
Responses
CodeContent typeTypeDescription
200application/jsonprocessListInformation about the available processes

GET /processes/{processID}?processID=... -> process

retrieve a process description
The process description contains information about inputs and outputs and a link to the execution-endpoint for the process. The Core does not mandate the use of a specific process description to specify the interface of a process. That said, the Core requirements class makes the following _recommendation_ implementations SHOULD consider supporting the OGC process description. For more information, see Section 7.10.
Parameters
NameInTypeRequiredDescription
processIDpathstring
Responses
CodeContent typeTypeDescription
200application/jsonprocessA process description.