7.7.2.1.  Response Schema for the Landing Page

The landing page response is based on the Landing Page Schema, originally defined in the OGC — API — Common — Part 1.

 

type: object
required:
  - links
properties:
  title:
    type: string
    title: The title of the API.
    description: While a title is not required, implementers are strongly advised to include one.
    example: Buildings in Bonn
  description:
    type: string
    example: Access to data about buildings in the city of Bonn via a Web API that conforms to the OGC API Common specification.
  attribution:
    type: string
    title: attribution for the API
    description: The `attribution` should be short and intended for presentation to a user, for example, in a corner of a map. Parts of the text can be links to other resources if additional information is needed. The string can include HTML markup.
  links:
    type: array
    items:
      $ref: link.yaml

Listing 2 — Landing Page Schema

In addition to the required resources, links to additional resources may be included in the Landing Page.

7.9.2.1.  Response Schema for the Conformance Declaration

The schema for the conformance response is based on the Conformance Declaration Schema (from OGC API — Common — Part 1).

 

type: object
required:
  - conformsTo
properties:
  conformsTo:
    type: array
    items:
      type: string
      example: "http://www.opengis.net/spec/ogcapi-common-1/1.0/conf/core"

Listing 3 — Conformance Declaration Schema

8.2.2.1.  Response Schema for the Collections

The response is based on the Collections Schema (from OGC — API — Common — Part 2).

 

type: object
required:
  - links
  - collections
properties:
  links:
    type: array
    items:
      $ref: 'link.yaml'
  numberMatched:
    $ref: 'numberMatched.yaml'
  numberReturned:
    $ref: 'numberReturned.yaml'
  collections:
    type: array
    items:
      $ref: 'collectionDesc.yaml'

Listing 4 — Collections Schema

 

description: |-
  The number of elements in the response that match the selection parameters like `bbox`.
type: integer
minimum: 0
example: 127

Listing 5 — numberMatched.yaml

 

description: |-
  The number of elements in the response.
  A server may omit this information, if the information about the
  number of elements is not known or difficult to compute.
  If the value is provided, the value shall be identical to the number
  of elements in the response.
type: integer
minimum: 0
example: 10

Listing 6 — numberReturned.yaml

This schema is further constrained by the following requirements and recommendations.

To support hypermedia navigation, the links property must be populated with sufficient hyperlinks to navigate through the whole dataset.

Additional information may be available to assist in understanding and using this dataset. Links to those resources should be provided as well.

The collections property of the Collections response provides a description of each individual collection hosted by the server. These descriptions are based on the Collection Schema.

The array items included in the collection property are described in the Collection Resource section of this Requirements Class.

This Requirements Class does not define any parameters for use against a collections resource.

8.3.2.1.  Response Schema for the Collection

The Collection response is based on the collectionDesc Schema (from OGC — API — Common — Part 2).

 

type: object
required:
  - id
  - links
properties:
  id:
    type: string
    description: identifier of the collection used, for example, in URIs
    example: dem
  title:
    type: string
    description: human readable title of the collection
    example: Digital Elevation Model
  description:
    type: string
    description: a description of the data in the collection
    example: A Digital Elevation Model.
  attribution:
    type: string
    title: attribution for the collection
  accessConstraints:
    description: |-
       Restrictions on the availability of the collection that the user needs to be aware of before using or redistributing the data:

       * unclassified: Available for general disclosure
       * restricted: Not for general disclosure
       * confidential: Available for someone who can be entrusted with information
       * secret: Kept or meant to be kept private, unknown, or hidden from all but a select group of people
       * topSecret: Of the highest secrecy
    enum:
    - unclassified
    - restricted
    - confidential
    - secret
    - topSecret
  publisher:
    type: string
    description: Organization or individual responsible for making the data available
  license:
    type: string
    description: The legal provisions under which the data ofthis collection is made available.
  rights:
    type: string
    description: A statement that concerns all rights not addressed by the license such as a copyright statement.
  formats:
    description: A list of formats in which the data of this collection is distributed
    type: array
    items:
      $ref: 'format.yaml'
  keywords:
    type: array
    description: The topic or topics of the resource. Typically represented using free-form keywords, tags, key phrases, or classification codes.
    items:
      type: string
  themes:
    type: array
    description:
      A knowledge organization system used to classify the resource.
    minItems: 1
    items:
      $ref: 'theme.yaml'
  contacts:
    type: array
    description:
      A list of contacts qualified by their role(s) in association to the collection.
    minItems: 1
    items:
      $ref: 'contact.yaml'
  resourceLanguages:
    type: array
    description: The list of languages in which the data of this collection is available.
    items:
      $ref: 'language.yaml'
  links:
    type: array
    example:
      - href: http://data.example.org/collections/dem?f=json
        rel: self
        type: application/json
        title: Digital Elevation Model
      - href: http://data.example.org/collections/dem?f=html
        rel: alternate
        type: application/json
        title: Digital Elevation Model
      - href: http://data.example.org/collections/dem/coverage
        rel: coverage
        type: image/tiff; application=geotiff
        title: Digital Elevation Model
      - href: http://data.example.org/collections/dem/coverage/domainset
        rel: domainset
        type: application/json
        title: Digital Elevation Model
      - href: http://data.example.org/collections/dem/coverage/rangetype
        rel: rangetype
        type: application/json
        title: Digital Elevation Model
      - href: http://data.example.org/collections/dem/coverage/metadata
        rel: metadata
        type: application/json
        title: Digital Elevation Model
    items:
      $ref: 'link.yaml'
  itemType:
    description: indicator about the type of the items in the collection if the collection has an accessible /collections/{collectionId}/items endpoint
    type: string
    default: feature
  crs:
    description: the list of coordinate reference systems supported by the API; the first item is the default coordinate reference system
    type: array
    items:
      type: string
    default:
      - http://www.opengis.net/def/crs/OGC/1.3/CRS84
    example:
      - http://www.opengis.net/def/crs/OGC/1.3/CRS84
      - http://www.opengis.net/def/crs/EPSG/0/4326
  storageCrs:
    description: the native coordinate reference system (i.e., the most efficient CRS in which to request the data, possibly how the data is stored on the server); this is the default output coordinate reference system for Maps and Coverages
    type: string
    default: http://www.opengis.net/def/crs/OGC/1.3/CRS84
    example: http://www.opengis.net/def/crs/OGC/1.3/CRS84
  epoch:
    description: Epoch of the native (storage) Coordinate Reference System (CRS)
    type: number
    example: 2021.33
  dataType:
    allOf:
      - description: Type of data represented in the collection
      - $ref: 'dataType.yaml'
  geoDataClasses:
     description: URIs identifying a class of data contained in the geospatial data (useful for example to determine compatibility with styles or processes)
     type: array
     items:
       type: string
       format: uri
  geometryDimension:
    description: 'The geometry dimension of the features shown in this layer (0: points, 1: curves, 2: surfaces, 3: solids), unspecified: mixed or unknown'
    type: integer
    minimum: 0
    maximum: 3
  minScaleDenominator:
    description: Minimum scale denominator for usage of the collection
    type: number
  maxScaleDenominator:
    description: Maximum scale denominator for usage of the collection
    type: number
  minCellSize:
    description: Minimum cell size for usage of the collection
    type: number
  maxCellSize:
    description: Maximum cell size for usage of the collection
    type: number
  created:
    description: Timestamp indicating when the collection was first produced
    type: string
    format: date-time
  updated:
    description: Timestamp of the last change/revision to the collection
    type: string
    format: date-time
  extent:
    $ref: 'extent.yaml'

Listing 7 — collectionDesc Schema

 

type: object
anyOf:
- required:
  - name
- required:
  - mediaType
properties:
  name:
    type: string
  mediaType:
    type: string

Listing 8 — format.yaml

 

type: object
required:
  - concepts
  - scheme
properties:
  concepts:
    type: array
    description:
      One or more entity/concept identifiers from this knowledge
      system. it is recommended that a resolvable URI be used for
      each entity/concept identifier.
    minItems: 1
    items:
      type: object
      required:
        - id
      properties:
        id:
          type: string
          description: An identifier for the concept.
        title:
          type: string
          description: A human readable title for the concept.
        description:
          type: string
          description: A human readable description for the concept.
        url:
          type: string
          format: uri
          description: A URI providing further description of the concept.
  scheme:
    type: string
    description:
      An identifier for the knowledge organization system used
      to classify the resource.  It is recommended that the
      identifier be a resolvable URI.  The list of schemes used
      in a searchable catalog can be determined by inspecting
      the server's OpenAPI document or, if the server implements
      CQL2, by exposing a queryable (e.g. named `scheme`) and
      enumerating the list of schemes in the queryable's schema
      definition.

Listing 9 — theme.yaml

 

type: object
description: |-
  Identification of, and means of communication with, person responsible
  for the resource.
anyOf:
  - required:
    - name
  - required:
    - organization
properties:
  identifier:
    type: string
    description: |-
      A value uniquely identifying a contact.
  name:
    type: string
    description: |-
      The name of the responsible person.
  position:
    type: string
    description:
      The name of the role or position of the responsible person taken
      from the organization's formal organizational hierarchy or chart.
  organization:
    type: string
    description:
      Organization/affiliation of the contact.
  logo:
    description:
      Graphic identifying a contact. The link relation should be `icon`
      and the media type should be an image media type.
    allOf:
      - $ref: '../common-core/link.yaml'
      - type: object
        required:
          - rel
          - type
        properties:
          rel:
            enum:
              - icon
  phones:
    type: array
    description: Telephone numbers at which contact can be made.
    items:
      type: object
      required:
        - value
      properties:
        value:
          type: string
          description: The value is the phone number itself.
          pattern: "^\\+[1-9]{1}[0-9]{3,14}$"
          example: "+14165550142"
        roles:
          description:
            The type of phone number (e.g. home, work, fax, etc.).
          $ref: 'roles.yaml'
  emails:
    type: array
    description: Email addresses at which contact can be made.
    items:
      type: object
      required:
        - value
      properties:
        value:
          type: string
          description: The value is the email number itself.
          format: email
        roles:
          description:
            The type of email (e.g. home, work, etc.).
          $ref: 'roles.yaml'
  addresses:
    type: array
    description: Physical location at which contact can be made.
    items:
      type: object
      properties:
        deliveryPoint:
          type: array
          description: Address lines for the location.
          items:
            type: string
        city:
          type: string
          description: City for the location.
        administrativeArea:
          type: string
          description: State or province of the location.
        postalCode:
          type: string
          description: ZIP or other postal code.
        country:
          type: string
          description: Country of the physical address.  ISO 3166-1 is recommended.
        roles:
          description:
            The type of address (e.g. office, home, etc.).
          $ref: 'roles.yaml'
  links:
    type: array
    description: On-line information about the contact.
    items:
      allOf:
        - $ref: '../common-core/link.yaml'
        - type: object
          required:
            - type
  hoursOfService:
    type: string
    description: Time period when the contact can be contacted.
    example: "Hours: Mo-Fr 10am-7pm Sa 10am-22pm Su 10am-21pm"
  contactInstructions:
    type: string
    description: |-
      Supplemental instructions on how or when to contact the
      responsible party.
  roles:
    description:
      The set of named duties, job functions and/or permissions
      associated with this contact.
      (e.g. developer, administrator, etc.).
    $ref: 'roles.yaml'

Listing 10 — contact.yaml

 

description:
  The list of duties, job functions or permissions assigned by the system
  and associated with the context of this member.
type: array
minItems: 1
items:
  type: string

Listing 11 — roles.yaml

 

type: object
description:
  The language used for textual values in this record.
required:
  - code
properties:
  code:
    type: string
    description:
      The language tag as per RFC-5646.
    example: el
  name:
    type: string
    minLength: 1
    description:
      The untranslated name of of the language.
    example: Ελληνικά
  alternate:
    type: string
    description:
      The name of the language in another well-understood language,
      usually English.
    example: Greek
  dir:
    type: string
    description:
      The direction for text in this language. The default, `ltr`
      (left-to-right), represents the most common situation.
      However, care should be taken to set the value of `dir`
      appropriately if the language direction is not `ltr`.
      Other values supported are `rtl` (right-to-left), `ttb`
      (top-to-bottom), and `btt` (bottom-to-top).
    enum:
      - ltr
      - rtl
      - ttb
      - btt
    default:
      ltr

Listing 12 — language.yaml

 

anyOf:
 - type: string
 - type: string
   enum:
   - map
   - vector
   - coverage

Listing 13 — dataType.yaml

 

title: Extent with (optional) Uniform Additional Dimensions Schema
description: |-
   This extent schema includes optional additional dimensions, but will still validate for
   objects not conforming to UAD.
allOf:
   - type: object
     description: |-
        The extent of the data in the collection. In the Core only spatial and temporal
        extents are specified. Extensions may add additional members to represent other
        extents, for example, thermal or pressure ranges.

        The first item in the array describes the overall extent of
        the data. All subsequent items describe more precise extents,
        e.g., to identify clusters of data.
        Clients only interested in the overall extent will only need to
        access the first item in each array.
     properties:
        spatial:
          description: The spatial extent of the data in the collection.
          type: object
          properties:
            bbox:
              description: |-
                One or more bounding boxes that describe the spatial extent of the dataset.

                The first bounding box describes the overall spatial
                extent of the data. All subsequent bounding boxes describe
                more precise bounding boxes, e.g., to identify clusters of data.
                Clients only interested in the overall spatial extent will
                only need to access the first item in each array.
              type: array
              minItems: 1
              items:
                description: |-
                  Each bounding box is provided as four or six numbers, depending on
                  whether the coordinate reference system includes a vertical axis
                  (height or depth):

                  * Lower left corner, coordinate axis 1
                  * Lower left corner, coordinate axis 2
                  * Minimum value, coordinate axis 3 (optional)
                  * Upper right corner, coordinate axis 1
                  * Upper right corner, coordinate axis 2
                  * Maximum value, coordinate axis 3 (optional)

                  If the value consists of four numbers, the coordinate reference system is
                  WGS 84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84)
                  unless a different coordinate reference system is specified in `crs` property.

                  If the value consists of six numbers, the coordinate reference system is WGS 84
                  longitude/latitude/ellipsoidal height (http://www.opengis.net/def/crs/OGC/0/CRS84h)
                  unless a different coordinate reference system is specified in `crs` property.

                  For WGS 84 longitude/latitude the values are in most cases the sequence of
                  minimum longitude, minimum latitude, maximum longitude and maximum latitude.
                  However, in cases where the box spans the antimeridian the first value
                  (west-most box edge) is larger than the third value (east-most box edge).

                  If the vertical axis is included, the third and the sixth number are
                  the bottom and the top of the 3-dimensional bounding box.

                  If a feature has multiple spatial geometry properties, it is the decision of the
                  server whether only a single spatial geometry property is used to determine
                  the extent or all relevant geometries.
                type: array
                oneOf:
                - minItems: 4
                  maxItems: 4
                - minItems: 6
                  maxItems: 6
                items:
                  type: number
                example:
                  - -180
                  - -90
                  - 180
                  - 90
            storageCrsBbox:
              description: |-
                One or more bounding boxes that describe the spatial extent of the dataset in the storage (native) CRS (`storageCrs` property).

                The first bounding box describes the overall spatial
                extent of the data. All subsequent bounding boxes describe
                more precise bounding boxes, e.g., to identify clusters of data.
                Clients only interested in the overall spatial extent will
                only need to access the first item in each array.
              type: array
              minItems: 1
              items:
                description: |-
                  Each bounding box is provided as four or six numbers, depending on
                  whether the coordinate reference system includes a vertical axis
                  (height or depth):

                  * Lower left corner, coordinate axis 1
                  * Lower left corner, coordinate axis 2
                  * Minimum value, coordinate axis 3 (optional)
                  * Upper right corner, coordinate axis 1
                  * Upper right corner, coordinate axis 2
                  * Maximum value, coordinate axis 3 (optional)
                type: array
                oneOf:
                - minItems: 4
                  maxItems: 4
                - minItems: 6
                  maxItems: 6
                items:
                  type: number
                example:
                  - -180
                  - -90
                  - 180
                  - 90
            crs:
              description: |-
                Coordinate reference system of the coordinates of the `bbox` property.
                The default reference system is WGS 84 longitude/latitude.
                WGS 84 longitude/latitude/ellipsoidal height for coordinates with height.
                For non-terrestrial coordinate reference system, another CRS may be specified.
              type: string
              enum:
                - 'http://www.opengis.net/def/crs/OGC/1.3/CRS84'
                - 'http://www.opengis.net/def/crs/OGC/0/CRS84h'
              default: 'http://www.opengis.net/def/crs/OGC/1.3/CRS84'
            grid:
              description: |-
                 Provides information about the limited availability of data within the collection organized
                 as a grid (regular or irregular) along each spatial dimension.
              type: array
              minItems: 2
              maxItems: 3
              items:
                $ref: 'grid.yaml'
        temporal:
          description: |-
            The temporal extent of the features in the collection.
          type: object
          properties:
            interval:
              description: |-
                One or more time intervals that describe the temporal extent of the dataset.
                In the Core only a single time interval is supported.

                Extensions may support multiple intervals.
                The first time interval describes the overall
                temporal extent of the data. All subsequent time intervals describe
                more precise time intervals, e.g., to identify clusters of data.
                Clients only interested in the overall extent will only need
                to access the first item in each array.
              type: array
              minItems: 1
              items:
                description: |-
                  Begin and end times of the time interval. The timestamps are in the
                  temporal coordinate reference system specified in `trs`. By default
                  this is the Gregorian calendar, expressed using RFC 3339 section 5.6.
                  Note that these times may be specified using time zone offsets to UTC time other than zero.

                  The value `null` for start or end time is supported and indicates a half-bounded time interval.
                type: array
                minItems: 2
                maxItems: 2
                items:
                  type: string
                  format: date-time
                  nullable: true
                example:
                  - '2011-11-11T12:22:11Z'
                  - '2011-11-11T08:22:11-04:00'
                  - null
            trs:
              description: |-
                Coordinate reference system of the coordinates in the temporal extent
                (property `interval`). The default reference system is the Gregorian calendar.
                In the Core this is the only supported temporal coordinate reference system.
                Extensions may support additional temporal coordinate reference systems and add
                additional enum values.
              type: string
              enum:
                - 'http://www.opengis.net/def/uom/ISO-8601/0/Gregorian'
              default: 'http://www.opengis.net/def/uom/ISO-8601/0/Gregorian'
            grid:
              $ref: 'grid.yaml'
   - anyOf:
     # To validate against the Uniform Additional Dimensions requirements class, remove or comment out the following line
     - type: object
     - type: object
       additionalProperties:
          description: |-
            The domain intervals for any additional dimensions of the extent (envelope) beyond those described in temporal and spatial.
          type: object
          oneOf:
            - required: [ interval, definition ]
            - required: [ interval, trs ]
            - required: [ interval, vrs ]
          properties:
            interval:
              description: |-
                One or more intervals that describe the extent for this dimension of the dataset.
                The value `null` is supported and indicates an unbounded or half-bounded interval.
                The first interval describes the overall extent of the data for this dimension.
                All subsequent intervals describe more precise intervals, e.g., to identify clusters of data.
                Clients only interested in the overall extent will only need
                to access the first item (a pair of lower and upper bound values).
              type: array
              minItems: 1
              items:
                description: |-
                  Lower and upper bound values of the interval. The values
                  are in the coordinate reference system specified in `crs`, `trs` or `vrs`.
                type: array
                minItems: 2
                maxItems: 2
                items:
                  oneOf:
                     - type: string
                       nullable: true
                     - type: number
                example:
                  - '2011-11-11T12:22:11Z'
                  - '2011-11-11T08:22:11-04:00'
                  - 32.5
                  - null
            trs:
              type: string
              description: temporal coordinate reference system (e.g. as defined by Features for 'temporal')
            vrs:
              type: string
              description: vertical coordinate reference system (e.g. as defined in EDR for 'vertical')
            grid:
              $ref: 'grid.yaml'
            definition:
              type: string
              format: uri
              description: A URI to the definition of the measured or observed property corresponding to this dimension.
            unit:
              type: string
              description: The unit of measure in which the interval and/or grid values are expressed.
            unitLang:
              type: string
              default: UCUM
              description: The language (or vocabulary) in which the unit is expressed (defaults to "UCUM" if not specified).
            variableType:
              description: The type of variable which may inform correct interpretation and interpolation methods
              type: string
              enum:
                - continuous
                - numericalOrdinal
                - numericalNominal
                - categoricalOrdinal
                - categoricalNominal

Listing 14 — extent.yaml

 

type: object
description: |-
  Provides information about the limited availability of data within the collection organized as a grid (regular or irregular) along the dimension.
allOf:
  - type: object
    required: [ cellsCount ]
    properties:
      cellsCount:
        description: Number of samples available along the dimension for data organized as a regular or irregular grid.
        type: integer
        example: 50
  - oneOf:
    - $ref: 'regularGrid.yaml'
    - $ref: 'irregularGrid.yaml'

Listing 15 — grid.yaml

 

type: object
description: Regular grid with samples spaced at equal intervals
required: [ resolution, firstCoordinate ]
properties:
  resolution:
    description: |-
      Resolution of regularly gridded data along the dimension in the collection
    oneOf:
      - type: string
        nullable: true
      - type: number
    example:
      - 0.0006866455078
      - "PT1H"
  firstCoordinate:
    description: |-
      First coordinate where a regular grid begins, with subsequent coordinates adding `resolution` unit at each step
    oneOf:
      - type: string
        nullable: true
      - type: number
    example: -180
  relativeBounds:
    description: |-
      Distance in units from coordinate to the lower and upper bounds of each cell for regular grids, describing the geometry of the cells
    type: array
    minItems: 2
    maxItems: 2
    items:
      oneOf:
        - type: string
          nullable: true
        - type: number
    example: [ -0.5, 0.5 ]

Listing 16 — regularGrid.yaml

 

type: object
description: Irregular grid with samples spaced at different intervals
required: [ coordinates ]
properties:
  coordinates:
    description: |-
      List of coordinates along the dimension for which data organized as an irregular grid in the collection is available
      (e.g., 2, 10, 80, 100).
    type: array
    minItems: 1
    items:
      oneOf:
        - type: string
          nullable: true
        - type: number
    example:
      - [2, 10, 80, 100]
      - ["2020-11-12T12:15:00Z","2020-11-12T12:30:00Z","2020-11-12T12:45:00Z"]
  boundsCoordinates:
    description: |-
      Coordinates of the lower and upper bounds of each cell in absolute units for irregular grids describing the geometry each cell
    type: array
    minItems: 1
    items:
       type: array
       minItems: 2
       maxItems: 2
       items:
         oneOf:
           - type: string
             nullable: true
           - type: number
    example: [ [ -180, -179 ], [ -179, -178 ] ]

Listing 17 — irregularGrid.yaml

8.4.2.1.  Response Schema for the Collection’s Key Fields

 

schema:
  $ref: '#/components/schemas/CollectionKeysResponseObject'

CollectionKeysResponseObject:
  required:
  - keys
  - links
  type: object
  properties:
    links:
      type: array
      items:
        $ref: '#/components/schemas/Link'
    keys:
      type: array
      items:
        $ref: '#/components/schemas/CollectionKeysObject'

CollectionKeysObject:
  required:
  - id
  - isDefault
  - links
  type: object
  properties:
    isDefault:
      type: boolean
    language:
      type: string
    id:
      type: string
    links:
      type: array
      items:
        $ref: '#/components/schemas/Link'

Listing 18 — Collection’s Key Fields Schema

8.5.2.1.  Parameter Limit

The number of returned key values depends on the server and the value of the limit parameter.

The client can request a limit to the number of key values returned in a response by using the limit parameter. The limit parameter indicates the maximum number of key values which should be included in a single response.

The server may have a default value for the limit and a maximum limit.

8.5.2.2.  Paged response

If the number of items in the keys array of the response is less than or equal to the requested/default/maximum limit then the server will include a link to the next set of results.

The effect of the limit parameter is to divide the response into a number of pages. Each page (except for the last) contains the specified number of entities. The response contains the first page. Additional pages can be accessed through hyperlink navigation.

Providing prev links supports navigating back and forth between pages, but depending on the implementation approach it may be too complex to implement.

If the server response does not contain all of the key values that match the selection parameters, then the client must be informed of that fact.

The numberMatched property of the response indicates the number of key values that are available in the server that match the selection parameters in the request.

The number of key values included in a response may be a subset of the number matched. In that case, the numberReturned property of the response indicates the number of key values returned in this “page” of the response.

8.5.2.3.  Response Schema for the Collection’s Key Field

 

schema:
  $ref: '#/components/schemas/CollectionKeysKeyFieldResponseObject'

CollectionKeysKeyFieldResponseObject:
  required:
  - keys
  - links
  type: object
  properties:
    links:
      type: array
      items:
        $ref: '#/components/schemas/Link'
    keys:
      type: array
      items:
        $ref: '#/components/schemas/KeyObject'
    numberMatched:
      type: integer
    numberReturned:
      type: integer

KeyObject:
  required:
  - key
  type: object
  properties:
    key:
      type: string
    title:
      type: string

Listing 21 — Collection’s Key Field Schema

8.6.2.1.  Parameter Limit

The number of returned joins depends on the server and the value of the limit parameter.

The client can request a limit to the number of joins returned in a response by using the limit parameter. The limit parameter indicates the maximum number of joins which should be included in a single response.

The server may have a default value for the limit and a maximum limit.

8.6.2.2.  Parameter datetime

8.6.2.3.  Paged response

If the number of items in the joins array of the response is less than or equal to the requested/default/maximum limit then the server will include a link to the next set of results.

The effect of the limit parameter is to divide the response into a number of pages. Each page (except for the last) contains the specified number of entities. The response contains the first page. Additional pages can be accessed through hyperlink navigation.

Providing prev links supports navigating back and forth between pages, but depending on the implementation approach it may be too complex to implement.

If the server response does not contain all of the joins that match the selection parameters, then the client must be informed of that fact.

The numberMatched property of the response indicates the number of joins that are available in the server that match the selection parameters in the request.

The number of joins included in a response may be a subset of the number matched. In that case, the numberReturned property of the response indicates the number of joins returned in this “page” of the response.

8.6.2.4.  Response schema for the Joins

 

schema:
  $ref: '#/components/schemas/JoinsResponseObject'

JoinsResponseObject:
  required:
  - joins
  - links
  type: object
  properties:
    links:
      type: array
      items:
        $ref: '#/components/schemas/Link'
    joins:
      type: array
      items:
        $ref: '#/components/schemas/JoinsObject'
    numberMatched:
      type: integer
    numberReturned:
      type: integer
    timeStamp:
      type: string
      format: date-time

JoinsObject:
  required:
  - id
  - links
  - timeStamp
  type: object
  properties:
    id:
      type: string
    timeStamp:
      type: string
      format: date-time
    links:
      type: array
      items:
        $ref: '#/components/schemas/Link'

Listing 25 — Joins Schema

8.7.2.1.  Response schema for the Join Creation

The response schema for queries that create a join resource is expressed with the Join Schema.

For responses that produce a direct GeoJSON output, the response is a GeoJSON file that contains also the joined attributes from the input data file.

8.8.2.1.  Response Schema for the Join

 

schema:
  $ref: '#/components/schemas/JoinResponseObject'

JoinResponseObject:
  required:
  - join
  - links
  type: object
  properties:
    links:
      type: array
      items:
        $ref: '#/components/schemas/Link'
    join:
      $ref: '#/components/schemas/JoinObject'

JoinObject:
  required:
  - id
  - inputs
  - outputs
  - timeStamp
  type: object
  properties:
    id:
      type: string
    timeStamp:
      type: string
      format: date-time
    inputs:
      $ref: '#/components/schemas/JoinInputsObject'
    outputs:
      type: array
      items:
        $ref: '#/components/schemas/Link'
    joinInformation:
      $ref: '#/components/schemas/JoinInformationObject'

JoinInputsObject:
  required:
  - attributeDataset
  - collection
  type: object
  properties:
    attributeDataset:
      type: string
    collection:
      type: array
      items:
        $ref: '#/components/schemas/Link'

JoinInformationObject:
  type: object
  properties:
    numberOfMatchedCollectionKeys:
      type: integer
    numberOfUnmatchedCollectionKeys:
      type: integer
    numberOfAdditionalAttributeKeys:
      type: integer
    matchedCollectionKeys:
      type: array
      items:
        type: string
    unmatchedCollectionKeys:
      type: array
      items:
        type: string
    additionalAttributeKeys:
      type: array
      items:
        type: string
    duplicateAttributeKeys:
      type: array
      items:
        type: string
    numberOfDuplicateAttributeKeys:
      type: integer

Listing 26 — Join Schema

9.2.2.1.  Response schema for the Join Delete

The response of the operation is empty.

10.2.2.1.  Response schema for the File Joining

The response is a GeoJSON file that contains also the joined attributes.