Subscription.json 4.87 KB
Newer Older
canterafonsj's avatar
canterafonsj committed
1
{
canterafonsj's avatar
canterafonsj committed
2
  "$schema": "http://json-schema.org/schema#",
canterafonsj's avatar
canterafonsj committed
3
  "$id": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/subscriptions/Subscription.json",
canterafonsj's avatar
canterafonsj committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71
  "title": "NGSI-LD Subscription",
  "description": "NGSI-LD Subscription",
  "definitions": {
    "NotificationParams": {
      "type": "object",
      "properties": {
        "attributes": {
          "type": "array",
          "minItems": 1,
          "items": {
            "type": "string",
            "minLength": 1
          },
          "uniqueItems": true
        },
        "format": {
          "type": "string"
        },
        "endpoint": {
          "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Endpoint"
        },
        "status": {
          "type": "string",
          "enum": [
            "ok",
            "failed"
          ]
        },
        "timesSent": {
          "type": "number",
          "minimum": 1
        },
        "lastNotification": {
          "type": "string",
          "format": "date-time"
        },
        "lastFailure": {
          "type": "string",
          "format": "date-time"
        },
        "lastSuccess": {
          "type": "string",
          "format": "date-time"
        }
      },
      "required": [
        "endpoint"
      ]
    },
    "GeoQuery": {
      "type": "object",
      "required": [
        "geometry",
        "coordinates",
        "georel"
      ],
      "properties": {
        "georel": {
          "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/georel"
        },
        "coordinates": {
          "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/coordinates"
        },
        "geometry": {
          "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/geometry"
        }
      }
    },
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
    "SubscriptionFragment": {
      "type": "object",
      "properties": {
        "@context": {
          "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/LdContext"
        },
        "entities": {
          "type": "array",
          "items": {
            "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/EntityInfo"
          },
          "minItems": 1
        },
        "name": {
          "type": "string",
          "minLength": 1
        },
        "description": {
          "type": "string",
          "minLength": 1
        },
        "watchedAttributes": {
          "type": "array",
          "minItems": 1,
          "items": {
            "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name"
          },
          "uniqueItems": true
        },
        "timeInterval": {
          "type": "number",
          "minimum": 0
        },
        "expires": {
          "type": "string",
          "format": "date-time"
        },
        "isActive": {
          "type": "boolean"
        },
        "throttling": {
          "type": "number",
          "minimum": 1
        },
        "q": {
          "type": "string"
        },
        "geoQ": {
          "$ref": "#/definitions/GeoQuery"
        },
        "csf": {
          "type": "string"
        }
      }
canterafonsj's avatar
canterafonsj committed
126
    },
127 128
    "Subscription": {
      "allOf": [
canterafonsj's avatar
canterafonsj committed
129
        {
130
          "$ref": "#/definitions/SubscriptionFragment"
canterafonsj's avatar
canterafonsj committed
131 132
        },
        {
133 134
          "type": "object",
          "properties": {
canterafonsj's avatar
canterafonsj committed
135
            "$id": {
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
              "type": "string",
              "format": "uri"
            },
            "type": {
              "type": "string",
              "const": "Subscription"
            },
            "notification": {
              "$ref": "#/definitions/NotificationParams"
            },
            "status": {
              "type": "string",
              "enum": [
                "active",
                "paused",
                "expired"
              ]
            },
            "createdAt": {
              "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/createdAt"
            },
            "modifiedAt": {
              "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/modifiedAt"
            }
          },
          "allOf": [
            {
              "required": [
                "id",
165 166
                "type",
                "notification"
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
              ]
            },
            {
              "anyOf": [
                {
                  "required": [
                    "entities"
                  ]
                },
                {
                  "required": [
                    "watchedAttributes"
                  ]
                }
              ]
            }
canterafonsj's avatar
canterafonsj committed
183 184 185 186
          ]
        }
      ]
    }
187 188 189 190 191
  },
  "allOf": [
    {
      "$ref": "#/definitions/Subscription"
    }
canterafonsj's avatar
canterafonsj committed
192
  ]
canterafonsj's avatar
canterafonsj committed
193
}