https://github.com/opengeospatial/ogcapi-common
OGC API - Common provides those elements shared by most or all of the OGC API standards to ensure consistency across the family.
https://github.com/opengeospatial/ogcapi-common
Last synced: 3 months ago
JSON representation
OGC API - Common provides those elements shared by most or all of the OGC API standards to ensure consistency across the family.
- Host: GitHub
- URL: https://github.com/opengeospatial/ogcapi-common
- Owner: opengeospatial
- License: other
- Created: 2018-09-12T12:48:47.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2026-03-26T17:16:22.000Z (3 months ago)
- Last Synced: 2026-03-27T06:48:29.949Z (3 months ago)
- Language: CSS
- Homepage: https://ogcapi.ogc.org/common
- Size: 30.2 MB
- Stars: 55
- Watchers: 34
- Forks: 15
- Open Issues: 63
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OGC API - Common
The [OGC API](https://ogcapi.ogc.org) family of Standards is organized by resource type. The Standards are developed by the [Open Geospatial Consortium](http://ogc.org). Each resource has an associated API standard. These resource-specific API standards are built using shared API modules. The OGC API-Common suite of standards provides the standards which define these modules. This GitHub repository supports the development and maintenance of the API-Common suite of standards.
[OGC API Standards](https://ogcapi.ogc.org) define modular API building blocks to spatially enable Web APIs in a consistent way. The Standards use the [OpenAPI](http://openapis.org) specification to define the reusable API building blocks.
## OGC API - Common Users Guide
It is the goal of the OGC to produce standards which are concise, complete, and testable. However, such documents do not fully capture the body of knowledge needed to successfully implement the standard. API-Common provides this non-normative information through the associated API-Common Best Practices document. The standard tells you what you must do. The Best Practices tell you how and why.
The Best Practices are available in [HTML](https://docs.ogc.org/guides/20-071.html) and [PDF](https://docs.ogc.org/guides/20-071.pdf) formats.
## OGC API - Common - Part 1: Core
The OGC API - Common - Part 1: Core Standard defines the resources and operations which SHALL be common to all OGC API standards. This Standard defines the minimal requirements for an API to be discovered and used by any client.
Version 1.0.0 of this standard is available in [HTML](https://docs.ogc.org/is/19-072/19-072.html) and [PDF](https://docs.ogc.org/is/19-072/19-072.pdf) formats.
## OGC API - Common - Part 2: Geospatial Data
The OGC API - Common - Part 2: Geospatial Data *candidate* Standard provides a common connection between the API landing page and resource-specific details. That connection includes metadata which describes the collections of hosted resources, common parameters for selecting subsets of those collections, and URI templates for identifying the above.
This *candidate* standard is available in [HTML](https://docs.ogc.org/DRAFTS/20-024.html) and [PDF](https://docs.ogc.org/DRAFTS/20-024.pdf) formats.
## OGC API - Common - Part 3: Schemas
The OGC API - Common - Part 3: Schemas *candidate* Standard (also dual-titled OGC API - Features - Part 5) allows to describe the logical schema
associated with a collection of geospatial data. The schemas describe the fields/properties available from the collection, with details such as
their data type, semantic definitions and units of measure.
This *candidate* standard is available in [HTML](https://docs.ogc.org/DRAFTS/23-058r1.html) and [PDF](https://docs.ogc.org/DRAFTS/23-058r1.pdf) formats.
## OGC API - Common - Part 4: Discovery within many collections
The OGC API - Common - Part 4: Discovery within many collections *candidate* Standard extends the `/collections` end-point defined in Part 2
with query parameters to retrieve only a subset of the collections, useful for API deployments where a large number of collections are available.
This includes the ability to specify a limit on the number of collections returned, sorting, filtering by bounding box or date/time,
advanced filtering using the OGC Common Query Language (CQL2) and to filter collection hierarchies.
This *candidate* standard is available in [HTML](https://docs.ogc.org/DRAFTS/25-046.html) and [PDF](https://docs.ogc.org/DRAFTS/25-046.pdf) formats.
## Draft Specifications
GitHub allows developers to maintain multiple versions (branches) of a standard. API-Common uses that feature to manage updates to the repository. At any time, the current "gold" version of API-Common resides in the "Master" branch. Updates to API-Common are performed on a monthly cycle. These updates are managed in separate brances, named using the following template: "{month-name}-YYYY-Updates"
Where:
{month-name} = the name of the month
YYYY - the four digit year
For example, the branch for April 2020 is "April-2020-Updates"
PDF and HTML versions of the in-work specifications are available in each draft.
There are three possible dispositions for a monthly update branch:
1) Upon approval of the SWG, they are merged into "Master" and become part of the "gold" copy.
2) More work is needed, so they become the base for the next month's branch.
3) They are deemed a bad piece of work and are abandoned.
## Getting Involved
See [DEVELOPMENT.md](DEVELOPMENT.md) for details on how to join the Standard Working Group and get involved.
Pull Requests from contributors are welcomed. However, please note that by sending a Pull Request or Commit to this GitHub repository, you are agreeing to the terms in the Observer Agreement https://portal.ogc.org/files/?artifact_id=92169