Experimental repository for building blocks from the OGC API standards.
geo- geospatial building blockscommon- building blocks applicable to multiple geospatial resource typesdata types- JSON representations of geospatial conceptsparameters- HTTP query parametersheaders- HTTP headers
features- building blocks applicable to feature resources
ogc-utils- Utility building blocks that are used in OGC API's but are not inherently geospatial. They were created to ensure consistency within OGC API's where there was not a clear mainstream standard. They aim to be in line with best practices of the web and could be replaced, e.g. by building blocks specified in an IETF RFC or similar, if and when they are available. API's built with the geo building blocks do not need to use these, but they provide a nice default option that OGC-focused tools will understand.data types- JSON representations of various utilities used in OGC API'sparameters- HTTP query parameters
unstable- These building blocks are not yet stable or mature. They may be extracted from core OGC API standards that have not yet been fully approved, or they may also be new ideas that are not yet in a standard.data types- JSON representations of geospatial concepts or utilities that are not yet stable or mature.
Currently only building blocks from Part 1: Core and Part 2: Coordinate Reference Systems by Reference of OGC API Features are included.
Warning: This is a work-in-progress.
This repository is started with a set of completely mature building blocks that are extracted from the stable OGC API - Features specification. But it includes a set of less stable building blocks as well, to show what's coming next and to enable more participation in the shaping of the next blocks. All building blocks in this repo must include a maturity classification, so that users can easily get a sense of how much they can count on the extension.
| Maturity Classification | Min Impl # | Description | Stability |
|---|---|---|---|
| Mature | 10 | Included in a standard that has been released for at least 1 year and has at least 10 diverse implementations. | Most stable, can rely on it completely. |
| Stable | 3 | Defined and used in one or more released standards. | Approaching stability - breaking changes are not anticipated but can easily come from additional feedback |
| Candidate | 1 | Part of a standard that is close to approval, either as a section or a new 'part' | Mostly stable, breaking changes are unlikely, but possible. |
| Proposal | 0 | A new idea. Ideally it should be linked at least a pull request against one of the OGC API repositories as a 'proposal' or new section | Not stable - breaking changes almost guaranteed as implementers try out the idea. |
| Deprecated | N/A | A previous extension that has likely been superseded by a newer one or did not work out for some reason. | DO NOT USE, is not supported |
Every building block in this repo will have a maturity field with one of the above classifications. If it is a stable or mature block then it must include a reference field, with a link to the section of the released standard that specifies it. For less mature building blocks the reference can link to a standard in progress, a proposal on an existing standard, or a pull request. For the least mature levels a reference link is not required, but it is recommended to try to at least get to a PR in the appropriate OGC API repository as soon as feasible.
Maturity mostly comes through the core building block definition going through the process of becoming a fully adopted OGC standard, and should increase in diverse implementations during that process. But building block authors can also choose to hold back the maturity advancement if they don't feel they anticipate that changes may be coming.