WMO WIS2 Notification Message Encoding

$schema: https://json-schema.org/draft/2020-12/schema
$id: https://raw.githubusercontent.com/wmo-im/wis2-notification-message/main/schemas/notificationMessageGeoJSON.yaml
title: WIS2 Notification Message Encoding
description: WIS2 Notification Message Encoding

type: object
properties:
  id: 
    type: string
    format: uuid
    description: UUID (RFC4122) - Guarantee uniqueness of the message over (at least) a 24h period.
  conformsTo:
    type: array
    contains:
      const: http://wis.wmo.int/spec/wnm/1/conf/core
  version:
    type: string
    description: DEPRECATED, please use `conformsTo`.
    const: v04
  type:
    type: string
    enum:
      - Feature
  geometry:
    oneOf:
      - enum:
        - null
      - $ref: 'https://raw.githubusercontent.com/opengeospatial/ogcapi-features/master/core/openapi/schemas/pointGeoJSON.yaml'
      - $ref: 'https://raw.githubusercontent.com/opengeospatial/ogcapi-features/master/core/openapi/schemas/polygonGeoJSON.yaml'
  properties:
    type: object
    properties:
      pubtime:
        type: string
        format: date-time
        description: |
          Identifies the date/time of when the file was posted/published, in RFC3339 format.
          The publication date/time is critical for subscribers to prevent message loss by knowing
          their lag (how far behind the publisher they are).
      data_id: 
        type: string
        description: |
         Unique identifier of the data as defined by the data producer.
         Data producers SHOULD NOT use an opaque id, but something meaningful to support client side filtering.
      metadata_id:
        type: string
        description: |
         Identifier for associated discovery metadata record to which the notification applies to.
         The identification SHOULD be from a WCMP2 discovery metadata record identifier from the WIS2
         Global Discovery Catalogue. Identifiers based on external catalogue systems MAY be articulated as additional links.
      producer:
        type: string
        description: |
          Identifies the provider that initially captured and processed the source data, in support of data distribution on behalf of other Members.
      datetime:
        type:
          - string
          - null
        format: date-time
        description: Identifies the date/time of the data being published, in RFC3339 format.
      start_datetime:
        type: string
        format: date-time
        description: Identifies the start date/time date of the data being published, in RFC3339 format.
      end_datetime:
        type: string
        format: date-time
        description: Identifies the end date/time date of the data being published, in RFC3339 format.
      cache:
        type: boolean
        description: |
          Whether the data in the notification should be cached (if not specified, the default value is `true`).
          When set to `false`, WIS2 Global Cache services do not cache the canonical link, and publish the
          notification with an unmodified canonical link (which points back to the endpoint as specified by the data producer).
          The notification is always published by the Global Cache regardless to the `cache` topic.
        default: true
      integrity:
        type: object
        description: Specifies a checksum to be applied to the data to ensure that the download is accurate.
        properties:
          method:
            type: string
            description: |
                A specific set of methods for calculating the checksum algorithms:
                * ``sha256``: the Secure Hash Algorithm 2, 256 bits, value is base64 encoded.
                * ``sha384``: the Secure Hash Algorithm 2, 384 bits, value is base64 encoded.
                * ``sha512``: the Secure Hash Algorithm 2, 512 bits, value is base64 encoded.
                * ``sha3-256``: the Secure Hash Algorithm 3, 256 bits, value is base64 encoded.
                * ``sha3-384``: the Secure Hash Algorithm 3, 384 bits, value is base64 encoded.
                * ``sha3-512``: the Secure Hash Algorithm 3, 512 bits, value is base64 encoded.
            enum:
              - sha256
              - sha384
              - sha512
              - sha3-256
              - sha3-384
              - sha3-512
          value:
            type: string
            contentEncoding: base64
            description: Checksum value.
        required:
          - method
          - value
      content:
        type: object
        description: Used to embed small products inline within the message.
        properties:
          encoding:
            type: string
            description: Encoding of content
            enum:
              - utf-8
              - base64
              - gzip
          size:
            type: integer
            maximum: 4096
            description: |
              Number of bytes contained in the file. Together with the ``integrity`` property, it provides additional assurance that file content was accurately received.
              Note that the limit takes into account the data encoding used, including data compression (for example `gzip`).
          value:
            type: string
            description: The inline content of the file.
            maxLength: 4096
        required:
          - encoding
          - size
          - value
    required:
      - pubtime
      - data_id
    oneOf:
      - allOf:
        - required:
          - start_datetime
          - end_datetime
      - allOf:
        - required:
          - datetime

  links:
    type: array
    minItems: 1
    items:
      allOf:
        - $ref: 'https://raw.githubusercontent.com/opengeospatial/ogcapi-features/master/core/openapi/schemas/link.yaml'
        - properties:
            security:
              type: object
              $ref: https://raw.githubusercontent.com/OAI/OpenAPI-Specification/3.1.0/schemas/v3.0/schema.yaml#/definitions/Components/properties/securitySchemes

oneOf:
  - required:
    - id
    - conformsTo
    - type
    - geometry
    - properties
    - links
  - required:
    - id
    - version
    - type
    - geometry
    - properties
    - links

example:
  $ref: https://raw.githubusercontent.com/wmo-im/wis2-notification-message/main/examples/example1.json

{
    "id": "31e9d66a-cd83-4174-9429-b932f1abe1be",
    "conformsTo": [
        "http://wis.wmo.int/spec/wnm/1/conf/core"
    ],
    "type": "Feature",
    "geometry": {
        "type": "Point",
        "coordinates": [
            6.146255135536194,
            46.223296618227444
        ]
    },
    "properties": {
        "pubtime": "2022-03-20T04:50:18Z",
        "datetime": "2022-03-20T04:45:00Z",
        "integrity": {
            "method": "sha512",
            "value": "A2KNxvks...S8qfSCw=="
        },
        "data_id": "dataset/123/data-granule/UANT01_CWAO_200445___15103.bufr4",
        "metadata_id": "urn:wmo:md:ca-eccc-msc:observations.swob",
        "content": {
            "encoding": "utf-8",
            "value": "encoded bytes from the file",
            "size": 457
        }
    },
    "links": [
        {
            "href": "https://example.org/data/4Pubsub/92c557ef-d28e-4713-91af-2e2e7be6f8ab.bufr4",
            "rel": "canonical",
            "type": "application/x-bufr"
        },
        {
            "href": "https://example.org/oapi/collections/my-dataset/items/my-data-granule",
            "rel": "item",
            "type": "application/json"
        }
    ]
}

{
    "id": "31e9d66a-cd83-4174-9429-b932f1abe1be",
    "conformsTo": [
        "http://wis.wmo.int/spec/wnm/1/conf/core"
    ],
    "type": "Feature",
    "geometry": {
        "type": "Polygon",
        "coordinates": [
            [
                [
                    -7.75,
                    40.43
                ],
                [
                    -7.75,
                    78.46
                ],
                [
                    71.91,
                    78.46
                ],
                [
                    71.91,
                    40.43
                ],
                [
                    -7.75,
                    40.43
                ]
            ]
        ]
    },
    "properties": {
        "pubtime": "2022-03-20T04:50:18Z",
        "start_datetime": "2022-03-20T00:06:00Z",
        "end_datetime": "2022-03-20T00:12:00Z",
        "integrity": {
            "method": "sha512",
            "value": "A2KNxvks...S8qfSCw=="
        },
        "data_id": "dataset/4546/abcdef-abcd-abcd-abcd-abcdefabcd",
        "metadata_id": "urn:wmo:md:fr-meteo-france:gap123"
    },
    "links": [
        {
            "href": "https://example.org/data/nwp/92c557ef-d28e-4713-91af-2e2e7be6f8ab.grib",
            "rel": "canonical",
            "type": "application/x-grib2"
        }
    ]
}

{
    "id": "31e9d66a-cd83-4174-9429-b932f1abcdef",
    "conformsTo": [
        "http://wis.wmo.int/spec/wnm/1/conf/core"
    ],
    "type": "Feature",
    "geometry": null,
    "properties": {
        "pubtime": "2022-11-20T16:40:37Z",
        "datetime": "2022-11-11T11:11:11Z",
        "data_id": "data/data-123/items/abcdefab-abcd-1234-5678-0123456789ab",
        "metadata_id": "urn:wmo:md:test-nmhs-xyz:some_dataset",
        "cache": false
    },
    "links": [
        {
            "href": "https://example.org/92c557ef-d28e-4713-91af-2e2e7be6f8ab.txt",
            "rel": "canonical"
        }
    ]
}

{
    "id": "31e9d66a-cd83-4174-9429-b932f1abcdef",
    "conformsTo": [
        "http://wis.wmo.int/spec/wnm/1/conf/core"
    ],
    "type": "Feature",
    "geometry": null,
    "properties": {
        "pubtime": "2022-12-22T16:40:37Z",
        "datetime": "2022-11-11T11:11:11Z",
        "data_id": "data/data-123/items/abcdefab-abcd-1234-5678-0123456789ab",
        "metadata_id": "urn:wmo:md:test-nmhs-xyz:some_dataset",
        "cache": false
    },
    "links": [
        {
            "href": "https://example.org/92c557ef-d28e-4713-91af-2e2e7be6f8ab.txt",
            "rel": "deletion"
        }
    ]
}