ldproxy

Common Core

specstableimplmature

The common resources of all OGC Web APIs.

Scope

Conformance Classes

Common Core implements all requirements of conformance class Core of OGC API - Features - Part 1: Core 1.0.1open in new window for the three mentioned resources.

Info

The conformance class has been split into three building blocks in ldproxy, since other OGC API standards reuse parts. The building blocks "Common Core" and "Feature Collections" reflect this.

Operations

ResourcePathMethodsMedia TypesDescription
Landing Page
{@path}
GET
HTML, JSON, XML
The landing page provides links to the API definition (link relations service-desc and service-doc), the Conformance declaration (path /conformance, link relation conformance), and other resources in the API.
Conformance Declaration
conformance
GET
HTML, JSON, XML
The URIs of all conformance classes supported by the API. This information is provided to support 'generic' clients that want to access multiple OGC API implementations - and not 'just' a specific API. For clients accessing only a single API, this information is in general not relevant and the OpenAPI definition describes the API in detail.
API Definition
api
GET
HTML, JSON, YAML
Provides the OpenAPI definition.

Query Parameters

NameResourcesDescription
f
Landing Page, Conformance Declaration
Select the output format of the response. If no value is provided, the standard HTTP rules apply, i.e., the "Accept" header will be used to determine the format.
f
API Definition
Select the output format of the response. If no value is provided, the standard HTTP rules apply, i.e., the "Accept" header will be used to determine the format.
lang
*
Select the language of the response. If no value is provided, the standard HTTP rules apply, i.e., the "Accept-Language" header will be used to determine the language.
token
*
Set the authorization token for the request. If no value is provided, the standard HTTP rules apply, i.e., the authorization header will be used to determine the token.

Configuration

Options

NameDefaultDescriptionTypeSince
buildingBlock
Always COMMON.
string
v3.1
enabled
true
Enable the building block?
boolean
v3.1
caching
{}
Sets fixed values for HTTP Caching Headers for the resources.
object
v3.1
additionalLinks
[]
Add additional links to the Landing Page resource. The value is an array of link objects. Required properties of a link are a URI (href), a label (label) and a relation (rel).
array
v3.1

Examples


- buildingBlock: COMMON
  enabled: true
  caching:
    lastModified: '2021-07-01T00:00:00Z'
    expires: '2023-06-30T23:59:59Z'
    cacheControl: max-age=86400
    cacheControlItems: max-age=3600
  additionalLinks:
  - rel: describedby
    type: text/html
    title: Website with additional information
    href: 'https://example.com/path/to/document'
    hreflang: en
Legal NoticePrivacy Notice