api.creativeforesight.io

{
  "oneOf": [
    {
      "additionalProperties": false,
      "properties": {
        "data": {
          "oneOf": [
            {
              "$ref": "#/components/schemas/LatestObservation"
            },
            {
              "type": "null"
            }
          ]
        },
        "meta": {
          "additionalProperties": false,
          "properties": {
            "concept": {
              "additionalProperties": false,
              "properties": {
                "code": {
                  "type": "string"
                },
                "resolved_indicator": {
                  "type": "string"
                },
                "source": {
                  "type": "string"
                }
              },
              "required": [
                "code",
                "resolved_indicator",
                "source"
              ],
              "type": "object"
            },
            "indicator": {
              "type": "string"
            },
            "limit": {
              "const": 1,
              "type": "integer"
            },
            "offset": {
              "const": 0,
              "type": "integer"
            },
            "region": {
              "type": "string"
            },
            "retired": {
              "additionalProperties": false,
              "description": "Present when the series has been retired from the catalog (orphaned, superseded, discontinued upstream or never ingested). Its stored data is still served; it no longer updates.",
              "properties": {
                "reason": {
                  "type": "string"
                },
                "replaced_by": {
                  "description": "The indicator code that replaces this series, when there is one.",
                  "type": "string"
                },
                "retired_at": {
                  "format": "date",
                  "type": "string"
                }
              },
              "required": [
                "retired_at",
                "reason"
              ],
              "type": "object"
            },
            "source_attribution": {
              "type": "string"
            },
            "total": {
              "maximum": 1,
              "minimum": 0,
              "type": "integer"
            },
            "unit": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "required": [
            "indicator",
            "region",
            "unit",
            "total",
            "limit",
            "offset"
          ],
          "type": "object"
        }
      },
      "required": [
        "data",
        "meta"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "data": {
          "items": {
            "$ref": "#/components/schemas/LatestObservation"
          },
          "type": "array"
        },
        "errors": {
          "items": {
            "additionalProperties": false,
            "properties": {
              "code": {
                "enum": [
                  "INVALID_PARAMETER",
                  "RESOURCE_NOT_FOUND",
                  "CATEGORY_NOT_ALLOWED",
                  "REGION_NOT_ALLOWED"
                ],
                "type": "string"
              },
              "details": {
                "additionalProperties": true,
                "type": "object"
              },
              "indicator": {
                "type": "string"
              },
              "message": {
                "type": "string"
              }
            },
            "required": [
              "indicator",
              "code",
              "message"
            ],
            "type": "object"
          },
          "type": "array"
        }
      },
      "required": [
        "data",
        "errors"
      ],
      "type": "object"
    }
  ]
}