title: Discrete Global Grid Reference System description
description: A description of a Discrete Global Grid Reference System provided by the API.
type: object
required:
- id
- title
- description
- defaultDepth
- links
properties:
  id:
    description: Local DGGRS identifier consistent with the `{dggrsId}` parameter of `/dggs/{dggrsId}` resources.
    type: string
  title:
    description: Title of this Discrete Global Grid Rfeference System, intended for displaying to a human
    type: string
  description:
    description: Brief narrative description of this Discrete Global Grid System, normally available for display to a human
    type: string
  keywords:
    description: Unordered list of one or more commonly used or formalized word(s)
      or phrase(s) used to describe this Discrete Global Grid Reference System
    type: array
    items:
      type: string
  uri:
    description: Identifier for this Discrete Global Grid Reference System registered with an authority.
    type: string
    format: uri
  crs:
    allOf:
      - description: Coordinate Reference System (CRS) used by this DGGS  (mandatory if applicable), specified as a URI if one exists.
      - $ref: 'crs.yaml'
  defaultDepth:
    description: >-
      The default zone depth returned for zone data retrieval when the `zone-depth` parameter is not used.
      This is the DGGS resolution levels beyond the requested DGGS zone’s hierarchy level included in the
      response, when retrieving data for a particular zone. This can be either:
      • A single positive integer value — representing a specific zone depth to return e.g., `5`;
      • A range of positive integer values in the form “{low}-{high}” — representing a
        continuous range of zone depths to return e.g., `1-8`; or,
      • A comma separated list of at least two (2) positive integer values — representing a
        set of specific zone depths to return e.g., `1,3,7`.
        A particular data encoding imply a particular zone depth and not support the default zone depth specified here,
        in which case the default zone depth (or the only possible depth) for that encoding will be used.
    oneOf:
    - type: integer
      minimum: 0
    - type: string
      description: A comma separated list of positive integers, or a {min}-{max} range of relative zone depths
  maxRefinementLevel:
    type: integer
    minimum: 0
    description: >-
      The maximum refinement level at which the full resolution of the data can be retrieved for this DGGRS and origin
      (using a `zone-depth` relative depth of 0) and/or used for performing the most accurate zone queries (using that value for `zone-level`)
  maxRelativeDepth:
    type: integer
    minimum: 0
    description: >-
      The maximum relative depth at which the full resolution of the data can be retrieved for this DGGRS and origin
  links:
    description: Links to related resources. A `self` link to the Discrete Global Grid Reference System description and an `[ogc-rel:dggrs-definition]` link to the DGGRS definition (using the schema defined by https://schemas.opengis.net/ogcapi/dggs/1.0/core/schemas/dggrs-definition/dggrs-definition-proposed.yaml) are required. An `[ogc-rel:dggrs-zone-query]` link to query DGGS zones should also be included if _DGGS Zone Query_ is supported.
    type: array
    items:
      $ref: '../../schemas/common-core/link.yaml'
  linkTemplates:
    description: Templated Links to related resources. A templated `[ogc-rel:dggrs-zone-data]` link to retrieve data should be included if _DGGS Zone Data_ is supported.
    type: array
    items:
      $ref: '../../schemas/common-core/linkTemplate.yaml'
