Foundationspecstableimplmature
Essentials, API catalog with all published APIs.
Scope
Configuration
Provides base functionality for all other modules and therefore cannot be disabled.
Options
Name | Default | Description | Type | Since |
---|---|---|---|---|
buildingBlock | Always FOUNDATION . | string | v2.0 | |
extensionType | Deprecated See buildingBlock . | string | v2.0 | |
enabled | true | Enable the building block? | boolean | v2.0 |
useLangParameter | false | Support query parameter lang to set the desired response language. | boolean | v2.0 |
includeLinkHeader | true | Return links contained in API responses also as HTTP header. | boolean | v2.0 |
apiCatalogLabel | API Overview | Title for resource API Catalog. | string | v2.0 |
apiCatalogDescription | The following OGC Web APIs are available. | Description for resource API Catalog. May contain HTML elements. | string | v2.0 |
googleSiteVerification | null | If set, the value is embedded in the HTML page of the API catalog resource in a "googleSiteVerification" meta tag ( <meta name=" google-site-verification`" content="{value}" >). | string | v2.0 |
Examples
The schema of the API Catalog resource:
type: object
required:
- apis
properties:
title:
type: string
description:
type: string
apis:
type: array
items:
type: object
required:
- title
- landingPageUri
properties:
title:
type: string
description:
type: string
landingPageUri:
type: string
format: uri
Example of the specifications in the configuration file:
- buildingBlock: FOUNDATION
includeLinkHeader: true
useLangParameter: false
apiCatalogLabel: 'Demonstration APIs using ldproxy'
apiCatalogDescription: 'The APIs below are available as examples for Web APIs that can be set up with <a href="https://github.com/interactive-instruments/ldproxy" >ldproxy</a>.'