openapi.yaml

openapi: 3.0.3
info:
  title: STAC API - Children
  version: '1.0.0-rc.2'
  description: >-
    This is an OpenAPI definition of the SpatioTemporal Asset Catalog API - Children
    specification.
  contact:
    name: STAC Specification
    url: 'http://stacspec.org'
  license:
    name: Apache License 2.0
    url: 'http://www.apache.org/licenses/LICENSE-2.0'
tags:
  - name: Children
    description: |-
      All endpoints related to STAC API - Children
paths:
  '/':
    get:
      tags:
        - Children
      summary: landing page
      description: |-
        The landing page provides links to the sub-resources.
      operationId: getLandingPage
      responses:
        '200':
          description: |-
            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 the Feature
            Collections (path `/collections`, link relation
            `data`).
          content:
            application/json:
              schema:
                $ref: 'https://api.stacspec.org/v1.0.0-rc.2/core/openapi.yaml#/components/schemas/landingPage'
              example:
                stac_version: '1.0.0'
                type: Catalog
                id: sentinel
                title: Copernicus Sentinel Imagery
                description: Catalog of Copernicus Sentinel 1 and 2 imagery.
                conformsTo:
                  - 'https://api.stacspec.org/v1.0.0-rc.2/core'
                  - 'https://api.stacspec.org/v1.0.0-rc.2/children'
                  - 'http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/core'
                  - 'http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/oas30'
                  - 'http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/geojson'
                links:
                  - href: 'http://data.example.org/'
                    rel: self
                    type: application/json
                    title: this document
                  - href: 'http://data.example.org/api'
                    rel: service-desc
                    type: application/vnd.oai.openapi+json;version=3.0
                    title: the API definition
                  - href: 'http://data.example.org/api.html'
                    rel: service-doc
                    type: text/html
                    title: the API documentation
                  - href: 'http://data.example.org/conformance'
                    rel: conformance
                    type: application/json
                    title: OGC API conformance classes implemented by this server
                  - href: 'http://data.example.org/children'
                    rel: children
                    type: application/json
                    title: Child catalogs and collections of this root catalog
  '/children':
    get:
      tags:
        - Children
      summary: the child catalogs and collections of the root catalog
      description: |-
        A body of Catalogs and Collections that are immediate children of this root Catalog.
      operationId: getChildren
      responses:
        '200':
          $ref: '#/components/responses/Children'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  schemas:
    children:
      type: object
      required:
        - links
        - children
      properties:
        links:
          $ref: 'https://api.stacspec.org/v1.0.0-rc.2/ogcapi-features/openapi.yaml#/components/schemas/links'
        children:
          type: array
          items:
            anyOf:
              - $ref: 'https://api.stacspec.org/v1.0.0-rc.2/ogcapi-features/openapi.yaml#/components/schemas/catalog'
              - $ref: 'https://api.stacspec.org/v1.0.0-rc.2/ogcapi-features/openapi.yaml#/components/schemas/collection'
  responses:
    Children:
      description: |-
        The child catalogs and collections of the root catalog this API represents.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/children'
    ServerError:
      description: |-
        A server error occurred.
      content:
        application/json:
          schema:
            $ref: 'https://api.stacspec.org/v1.0.0-rc.2/ogcapi-features/openapi.yaml#/components/schemas/exception'