cumulus_sns_schema.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "definitions": {
    "file": {
        "type": "object",
        "properties": {
          "type": {
            "description": "The type of file. science files (netcdf, HDF, binary) should use the 'data' type. More can be added if need and consensus demand.",
            "type": "string",
            "enum": [
              "data",
              "browse",
              "metadata",
              "ancillary",
              "linkage"
            ]
          },
          "subtype": {
            "description": "An optional, specific implmentation of the file::type. e.g. NetCDF for a file of type 'data'",
            "type": "string"
          },
          "uri": {
            "description": "the URI of the file (s3://...)",
            "type": "string"
          },
          "name": {
            "description": "The human readable filename that this file represents. ",
            "type": "string"
          },
          "checksumType": {
            "description  ": "Type of the checksum (e.g. md5). Optional. If no checksumType is defined for a file, it is assumed to be md5",
            "type": "string",
            "enum": [
              "SHA-1",
              "md5"
            ]
          },
          "checksum": {
            "description": "Checksum of the file.",
            "type": "string"
          },
          "size": {
            "description": "Size, in bytes, of the file.",
            "type": "number"
          }
        },
        "required": [
          "type",
          "uri",
          "size",
          "checksum",
          "checksumType",
          "name"
        ]
    },
    "filegroup": {
      "type": "object",
      "properties": {
        "id": {
          "type":"string",
          "description":"string id of the filegroup by which all files are associated."
        },
        "files": {
          "description": "array of files that make up this product",
          "type": "array",
          "items": { "$ref": "#/definitions/file" }
        }
      },
      "required": [
        "id",
        "files"
      ]
    }
  },
  "title": "Cloud Notification Message (cnm) 1.2 ",
  "description": "A message format to trigger or respond to processing. Version 1.2",
  "type": "object",
  "properties": {
    "version":{
      "description" : "The CNM Version used. e.g. 'v1.2'",
      "type":"string",
      "enum": [
        "1.0",
        "1.1"
      ]
    },
    "receivedTime": {
      "description": "Time message was received by the ingest system",
      "type":"string"
    },
    "processCompleteTime": {
      "description": "The time processing completed by the receiving entity.",
      "type":"string"
    },
    "submissionTime": {
      "description": "The time the message was created (and presumably sent) to the publication mechanism.",
      "type":"string"
    },
    "identifier": {
      "description":"Unique identifier for the message as a whole. It is the senders responsibility to ensure uniqueness. This identifier can be used in response messages to provide tracability.",
      "type":"string"
    },
    "collection": {
      "description": "The collection to which these granules will belong.",
      "type": "string"
    },
    "provider": {
      "description": "the name of the provider (e.g. SIP, SDS, etc. ) producing these files.",
      "type": "string"
    },
    "trace": {
      "description": "Information on the message or who is sending it.",
      "type": "string"
    },
    "response":{
      "description": "The response message type sent. Can be a success message or error message. Akin to both the PAN and PDRD",
      "type": "object",
      "properties": {
        "status":{
          "description":"Successful or error.",
          "type":"string",
          "enum": [
            "SUCCESS",
            "FAILURE"
          ]
        },
        "ingestionMetadata":{
          "description":"Object defining ingestion metadata, like CMR Concept IDs, URLS, etc",
          "type": "object",
          "properties": {
            "catalogId":{
              "description":"Identifier for catalog",
              "type":"string"
            },
            "catalogUrl":{
              "description":"URL of catalog entry",
              "type":"string"
            }
          }
        },
        "errorCode": {
          "description":"Error message. Success messages can be ignored.",
          "type":"string",
          "enum": [
            "VALIDATION_ERROR",
            "ACCESS_ERROR",
            "PROCESSING_ERROR"
          ]
        },
        "errorMessage":{
          "description":"The message error for the failure that occured.",
          "type":"string"
        }
      },
      "required": [
          "status"
      ]
    },
    "product": {
      "type": "object",
      "properties": {
        "name": {
          "description": "Identifier/name of the product",
          "type": "string"
        },
        "dataVersion": {
          "description": "Version of this product",
          "type": "string"
        },
        "files": {
          "description": "array of files that make up this product",
          "type": "array",
          "items": { "$ref": "#/definitions/file" }
        },
        "filegroups": {
          "description": "array of filegroups that make up this product",
          "type": "array",
          "items": { "$ref": "#/definitions/filegroup" }
        }
      },
      "oneOf": [
        {"required": ["name","files"]},
          {"required": ["name","filegroups"]}
      ]
    }
  },
  "oneOf": [
    {"required": ["version","submissionTime","collection", "identifier", "product"]},
    {"required": ["version","receivedTime","processCompleteTime","submissionTime","identifier","collection", "response"] }
  ]
}