From 8b5fde29cff1c592401539f43a46eae3e43275ad Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Costa?= Date: Thu, 8 Oct 2020 11:44:48 +0200 Subject: [PATCH] Merge of private repo to Master --- .gitlab-ci.yml.disabled => .gitlab-ci.yml | 18 +- CONTRIBUTE.md | 26 + Readme.md => README.md | 4 +- bundle/ngsild_swagger_combined.json | 3052 ++++++++++ .../ngsild_swagger_combined_dereferenced.json | 3052 ++++++++++ ...ContextSourceRegistration-example_C.3.json | 2 +- ...ContextSourceRegistrationList-example.json | 2 +- examples/Entity-example.json | 2 +- examples/EntityList-example.json | 2 +- examples/EntityTemporal-example_C5.5.3.json | 2 +- examples/EntityTemporalList-example.json | 2 +- examples/Entity_temporalValues_C.5.6.3.json | 2 +- examples/OffStreetParking_C2.3.json | 2 +- examples/OffStreetParking_keyValues_C2.3.json | 2 +- examples/Subscription-example_C.4.json | 2 +- examples/SubscriptionList-example.json | 2 +- examples/Vehicle_C2.2.json | 2 +- examples/Vehicle_MultiAttribute_C2.2.json | 2 +- examples/Vehicle_keyValues_C2.2.json | 2 +- jsconfig.json | 5 + package.json | 14 +- schema/BatchOperationResult.json | 4 +- schema/Entity.json | 53 +- schema/EntityList.json | 4 +- schema/Entity_keyValues.json | 18 +- schema/UpdateResult.json | 2 +- schema/common.json | 10 +- schema/geometry-schema.json | 2 +- .../ContextSourceNotification.json | 6 +- .../ContextSourceRegistration.json | 20 +- .../ContextSourceRegistrationList.json | 4 +- schema/subscriptions/Notification.json | 6 +- schema/subscriptions/Subscription.json | 20 +- schema/subscriptions/SubscriptionList.json | 4 +- schema/temporal/EntityTemporal.json | 24 +- schema/temporal/EntityTemporalList.json | 2 +- schema/temporal/Entity_temporalValues.json | 10 +- scripts/combine_files.sh | 21 +- .../ngsild_swagger_combined.json | 1672 ------ .../ngsild_swagger_combined_dereferenced.json | 5238 ----------------- scripts/validate_all.sh | 11 + scripts/validate_examples.sh | 20 +- scripts/validate_locally.sh | 16 +- scripts/validate_online.sh | 22 +- scripts/validate_schema.sh | 29 +- .../csource-registration-by-id-spec.json | 12 +- spec/updated/csource-registrations-spec.json | 32 +- .../csource-subscription-by-id-spec.json | 18 +- spec/updated/csource-subscriptions-spec.json | 12 +- spec/updated/entities-spec.json | 20 +- spec/updated/entity-attrs-spec.json | 28 +- spec/updated/entity-by-id-spec.json | 16 +- spec/updated/entity-operations-spec.json | 22 +- spec/updated/full_api.json | 26 +- spec/updated/ngsi-ld-spec-open-api.json | 40 +- spec/updated/subscription-by-id-spec.json | 18 +- spec/updated/subscriptions-spec.json | 12 +- .../temporal/temporal-entities-spec.json | 42 +- .../temporal/temporal-entity-attrs-spec.json | 22 +- .../temporal/temporal-entity-by-id-spec.json | 34 +- yarn.lock | 352 ++ 61 files changed, 6840 insertions(+), 7283 deletions(-) rename .gitlab-ci.yml.disabled => .gitlab-ci.yml (57%) create mode 100644 CONTRIBUTE.md rename Readme.md => README.md (86%) create mode 100644 bundle/ngsild_swagger_combined.json create mode 100644 bundle/ngsild_swagger_combined_dereferenced.json create mode 100644 jsconfig.json mode change 100644 => 100755 scripts/combine_files.sh delete mode 100644 scripts/combined_spec/ngsild_swagger_combined.json delete mode 100644 scripts/combined_spec/ngsild_swagger_combined_dereferenced.json create mode 100755 scripts/validate_all.sh mode change 100644 => 100755 scripts/validate_locally.sh mode change 100644 => 100755 scripts/validate_online.sh create mode 100644 yarn.lock diff --git a/.gitlab-ci.yml.disabled b/.gitlab-ci.yml similarity index 57% rename from .gitlab-ci.yml.disabled rename to .gitlab-ci.yml index 21ea558..2e0e51c 100644 --- a/.gitlab-ci.yml.disabled +++ b/.gitlab-ci.yml @@ -1,16 +1,24 @@ # This file is a template, and might need editing before it works on your project. # Official framework image. Look for the different tagged releases at: # https://hub.docker.com/r/library/node/tags/ -image: node:8 +image: node::13.7-alpine # This folder is cached between builds -# http://docs.gitlab.com/ce/ci/yaml/README.html#cache +# http://docs.rep.com/ce/ci/yaml/README.html#cache cache: paths: - node_modules/ -all_tests: +before_script: + - yarn + +stages: + - test + +test: + stage: test script: - - npm install - - npm test + - echo "Running tests..." + - yarn test + allow_failure: true diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md new file mode 100644 index 0000000..eb9493c --- /dev/null +++ b/CONTRIBUTE.md @@ -0,0 +1,26 @@ +# CONTRIBUTE + +## Install app +``` +$ yarn +``` + +## Test + +### Test all scripts +``` +$ yarn test +``` + +### Test scripts individually +``` +$ yarn validate-examples +$ yarn validate-locally +$ yarn validate-online +$ yarn validate-schema +``` + +### Bundle ngsi-ld-spec-open-api.json +``` +$ yarn combine-files +``` \ No newline at end of file diff --git a/Readme.md b/README.md similarity index 86% rename from Readme.md rename to README.md index 97d6078..3d02808 100644 --- a/Readme.md +++ b/README.md @@ -4,12 +4,14 @@ This repository contains OpenAPI descriptions for the NGSI-LD interface defined ## Online resources -* [Navigate the API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/full_api.json). +* [Navigate the API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/full_api.json). ## Contribute To get an account on ETSI Forge and to learn how to contribute visit the [Forge Getting started wiki](https://forge.etsi.org/wiki/index.php/Get_started). +More info @ [CONTIBUTE](./CONTRIBUTE.md) + Change requests are managed using [Gerrit](https://forge.etsi.org/gerrit). ## Report issues diff --git a/bundle/ngsild_swagger_combined.json b/bundle/ngsild_swagger_combined.json new file mode 100644 index 0000000..4c94a6f --- /dev/null +++ b/bundle/ngsild_swagger_combined.json @@ -0,0 +1,3052 @@ +{ + "openapi": "3.0.3", + "info": { + "description": "This OAS file describes the NGSI-LD API defined by the ETSI ISG CIM group. This Cross-domain Context Information Management API allows to provide, consume and subscribe to context information in multiple scenarios and involving multiple stakeholders", + "version": "latest", + "title": "ETSI ISG CIM / NGSI-LD API", + "contact": { + "email": "NGSI-LD@etsi.org" + } + }, + "externalDocs": { + "description": "Find out more about the ETSI ISG Context Information Management", + "url": "https://portal.etsi.org/tb.aspx?tbid=854&SubTB=854" + }, + "tags": [ + { + "name": "ETSI", + "description": "European Telecommunications Standards Institute", + "externalDocs": { + "description": "Find out more", + "url": "http://www.etsi.org" + } + }, + { + "name": "CIM", + "description": "Context Information Management", + "externalDocs": { + "description": "Find out more", + "url": "https://portal.etsi.org/tb.aspx?tbid=854&SubTB=854" + } + }, + { + "name": "JSON-LD", + "description": "JSON for Linked Data", + "externalDocs": { + "description": "Find out more", + "url": "https://json-ld.org/" + } + }, + { + "name": "NGSI-LD API", + "description": "API defined by the ETSI ISG CIM", + "externalDocs": { + "description": "Preliminary Specification", + "url": "http://www.etsi.org/deliver/etsi_gs/CIM/001_099/004/01.01.01_60/gs_CIM004v010101p.pdf" + } + } + ], + "paths": { + "/entities/": { + "get": { + "description": "Retrieve a set of entities which matches a specific query from an NGSI-LD system", + "operationId": "queryEntities", + "tags": [ + "Context Information" + ], + "parameters": [ + { + "name": "id", + "description": "Comma separated list of URIs to be retrieved", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "uri" + } + }, + { + "name": "idPattern", + "description": "Regular expression that must be matched by Entity ids", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "regexp" + } + }, + { + "name": "type", + "description": "Comma separated list of Entity type names to be retrieved", + "in": "query", + "required": false, + "schema": { + "type": "string", + "minLength": 1 + } + }, + { + "name": "attrs", + "description": "Comma separated list of attribute names (properties or relationships) to be retrieved", + "in": "query", + "required": false, + "schema": { + "type": "string", + "minLength": 1 + } + }, + { + "name": "q", + "description": "Query", + "in": "query", + "required": false, + "schema": { + "type": "string", + "minLength": 1 + } + }, + { + "name": "georel", + "description": "Geo-relationship", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string", + "enum": [ + "equals", + "disjoint", + "intersects", + "within", + "contains", + "overlaps" + ] + }, + { + "type": "string", + "pattern": "^near;((maxDistance==\\d+)|(minDistance==\\d+))$" + } + ] + } + }, + { + "name": "geometry", + "description": "Geometry", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "Point", + "MultiPoint", + "LineString", + "MultiLineString", + "Polygon", + "MultiPolygon" + ] + } + }, + { + "name": "coordinates", + "description": "Coordinates serialized as a string", + "in": "query", + "required": false, + "schema": { + "oneOf": [ + { + "$ref": "#/paths/~1csourceRegistrations~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/0/properties/location/definitions/position" + }, + { + "$ref": "#/paths/~1csourceRegistrations~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/0/properties/location/definitions/positionArray" + }, + { + "$ref": "#/paths/~1csourceRegistrations~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/0/properties/location/definitions/lineString" + }, + { + "$ref": "#/paths/~1csourceRegistrations~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/0/properties/location/definitions/polygon" + } + ] + } + }, + { + "name": "geoproperty", + "description": "The name of the property that contains the geo-spatial data that will be used to resolve the geoquery", + "in": "query", + "required": false, + "schema": { + "type": "string", + "minLength": 1 + } + }, + { + "name": "csf", + "description": "Context Source Filter", + "in": "query", + "required": false, + "schema": { + "type": "string", + "minLength": 1 + } + }, + { + "name": "limit", + "description": "Pagination limit", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1 + } + }, + { + "name": "options", + "description": "Options dictionary", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "keyValues", + "sysAttrs" + ] + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entityOperations~1create/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema" + }, + "examples": { + "simple": { + "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/EntityList-example.json" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "type": "object", + "properties": { + "type": { + "type": "string", + "format": "uri" + }, + "title": { + "type": "string" + }, + "detail": { + "type": "string" + } + }, + "required": [ + "type" + ] + } + } + } + } + } + }, + "post": { + "description": "Create a new Entity within an NGSI-LD system", + "operationId": "createEntity", + "tags": [ + "Context Information" + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "allOf": [ + { + "required": [ + "id", + "type" + ] + }, + { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + ] + } + } + } + }, + "responses": { + "201": { + "description": "Created. Contains the resource URI of the created Entity" + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "409": { + "description": "Already exists", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + }, + "/entities/{entityId}": { + "get": { + "description": "Retrieve an specific Entity from an NGSI-LD system. It's possible to specify the Entity attributes to be retrieved by using query parameters", + "operationId": "retrieveEntityById", + "tags": [ + "Context Information" + ], + "parameters": [ + { + "name": "entityId", + "description": "Entity Id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uri" + } + }, + { + "name": "attrs", + "description": "Comma separated list of attribute names (properties or relationships) to be retrieved", + "in": "query", + "required": false, + "schema": { + "type": "string", + "minLength": 1 + } + }, + { + "name": "type", + "description": "Entity Type", + "in": "query", + "required": false, + "schema": { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/10/schema" + } + }, + { + "name": "options", + "description": "Options dictionary", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "keyValues", + "sysAttrs" + ] + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema" + }, + "examples": { + "simple": { + "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/Entity-example.json" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + }, + "delete": { + "description": "Removes an specific Entity from an NGSI-LD system", + "operationId": "removeEntityById", + "tags": [ + "Context Information" + ], + "parameters": [ + { + "$ref": "#/paths/~1entities~1%7BentityId%7D/get/parameters/0" + }, + { + "$ref": "#/paths/~1entities~1%7BentityId%7D/get/parameters/2" + } + ], + "responses": { + "204": { + "description": "No Content. The entity was removed successfully" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + }, + "/entities/{entityId}/attrs/": { + "post": { + "description": "Append new Entity attributes to an existing Entity within an NGSI-LD system", + "operationId": "appendEntityAttrs", + "tags": [ + "Context Information" + ], + "parameters": [ + { + "name": "entityId", + "description": "Entity Id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uri" + } + }, + { + "name": "options", + "description": "Indicates that no attribute overwrite shall be performed", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "noOverwrite" + ] + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "type": "object", + "properties": { + "@context": { + "anyOf": [ + { + "type": "object" + }, + { + "type": "string", + "format": "uri" + }, + { + "type": "array", + "minItems": 1, + "items": { + "anyOf": [ + { + "type": "string", + "format": "uri" + }, + { + "type": "object" + } + ] + } + } + ] + }, + "location": { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "GeoProperty" + }, + "value": { + "$ref": "#/paths/~1csourceRegistrations~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/0/properties/location" + }, + "observedAt": { + "type": "string", + "format": "date-time" + }, + "createdAt": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/createdAt" + }, + "modifiedAt": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/modifiedAt" + }, + "datasetId": { + "type": "string", + "format": "uri" + }, + "instanceId": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "type", + "value" + ], + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/additionalProperties/anyOf/0" + }, + { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/additionalProperties/anyOf/1" + } + ] + } + }, + "observationSpace": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/location" + }, + "operationSpace": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/location" + }, + "id": { + "type": "string", + "format": "uri" + }, + "type": { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/10/schema" + }, + "createdAt": { + "type": "string", + "format": "date-time" + }, + "modifiedAt": { + "type": "string", + "format": "date-time" + } + }, + "additionalProperties": { + "anyOf": [ + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "Property" + }, + "value": { + "type": [ + "string", + "number", + "boolean", + "array", + "object" + ] + }, + "observedAt": { + "$ref": "#/paths/~1entities~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/1/properties/location/properties/observedAt" + }, + "createdAt": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/createdAt" + }, + "modifiedAt": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/modifiedAt" + }, + "datasetId": { + "$ref": "#/paths/~1entities~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/1/properties/location/properties/datasetId" + }, + "instanceId": { + "$ref": "#/paths/~1entities~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/1/properties/location/properties/instanceId" + } + }, + "required": [ + "type", + "value" + ], + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/additionalProperties/anyOf/0" + }, + { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/additionalProperties/anyOf/1" + } + ] + } + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "Relationship" + }, + "object": { + "type": "string", + "format": "uri" + }, + "observedAt": { + "$ref": "#/paths/~1entities~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/1/properties/location/properties/observedAt" + }, + "createdAt": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/createdAt" + }, + "modifiedAt": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/modifiedAt" + }, + "datasetId": { + "$ref": "#/paths/~1entities~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/1/properties/location/properties/datasetId" + }, + "instanceId": { + "$ref": "#/paths/~1entities~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/1/properties/location/properties/instanceId" + } + }, + "required": [ + "type", + "object" + ], + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/additionalProperties/anyOf/0" + }, + { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/additionalProperties/anyOf/1" + } + ] + } + }, + { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/location" + } + ] + }, + "propertyNames": { + "type": "string", + "pattern": "^((\\d|[a-zA-Z]|_)+(:(\\d|[a-zA-Z]|_)+)?(#\\d+)?)$|^(@context)$" + } + } + } + } + }, + "responses": { + "204": { + "description": "No Content" + }, + "207": { + "description": "Partial Success. Only the attributes included in the response payload were successfully appended", + "content": { + "application/json;application/ld+json": { + "schema": { + "$schema": "http://json-schema.org/schema#", + "$id": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/UpdateResult.json", + "title": "NGSI-LD Update Result", + "description": "NGSI-LD Update Result", + "definitions": { + "NotUpdatedDetails": { + "attributeName": { + "type": "string", + "pattern": "" + }, + "reason": { + "type": "string", + "minLenght": 1 + } + }, + "UpdateResult": { + "type": "object", + "properties": { + "updated": { + "type": "array", + "items": { + "type": "string", + "pattern": "" + } + }, + "notUpdated": { + "type": "array", + "items": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/responses/207/content/application~1json%3Bapplication~1ld%2Bjson/schema/definitions/NotUpdatedDetails" + } + } + } + } + }, + "allOf": [ + { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/responses/207/content/application~1json%3Bapplication~1ld%2Bjson/schema/definitions/UpdateResult" + } + ] + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + }, + "patch": { + "description": "Update existing Entity attributes within an NGSI-LD system", + "operationId": "updateEntityAttrs", + "tags": [ + "Context Information" + ], + "parameters": [ + { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/parameters/0" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "responses": { + "204": { + "description": "No Content." + }, + "207": { + "description": "Partial Success. Only the attributes included in the response payload were successfully updated", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/responses/207/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + }, + "/entities/{entityId}/attrs/{attrId}": { + "patch": { + "description": "Update existing Entity attributes within an NGSI-LD system", + "operationId": "partialAttrUpdate", + "tags": [ + "Context Information" + ], + "parameters": [ + { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/parameters/0" + }, + { + "name": "attrId", + "description": "Attribute Id", + "in": "path", + "required": true, + "schema": { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/10/schema" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "responses": { + "204": { + "description": "No Content." + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + }, + "delete": { + "description": "Removes an existing Entity attribute within an NGSI-LD system", + "operationId": "removeEntityAttr", + "tags": [ + "Context Information" + ], + "parameters": [ + { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/parameters/0" + }, + { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1%7BattrId%7D/patch/parameters/1" + } + ], + "responses": { + "204": { + "description": "No Content." + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + }, + "/subscriptions/": { + "get": { + "description": "Retrieves the subscriptions available in an NGSI-LD system", + "operationId": "retrieveSubscriptions", + "tags": [ + "Context Subscription" + ], + "parameters": [ + { + "name": "limit", + "description": "Pagination limit", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/paths/~1subscriptions~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + }, + "examples": { + "simple": { + "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/SubscriptionList-example.json" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + }, + "post": { + "description": "Creates a new Subscription within an NGSI-LD system", + "operationId": "createSubscription", + "tags": [ + "Context Subscription" + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "allOf": [ + { + "$ref": "#/paths/~1subscriptions~1%7BsubscriptionId%7D/patch/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema" + }, + { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "const": "Subscription" + }, + "notification": { + "type": "object", + "properties": { + "attributes": { + "type": "array", + "minItems": 1, + "items": { + "type": "string", + "minLength": 1 + }, + "uniqueItems": true + }, + "format": { + "type": "string" + }, + "endpoint": { + "type": "object", + "required": [ + "uri" + ], + "properties": { + "uri": { + "type": "string", + "format": "uri" + }, + "accept": { + "type": "string", + "enum": [ + "application/json", + "application/ld+json" + ] + } + } + }, + "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" + ] + }, + "status": { + "type": "string", + "enum": [ + "active", + "paused", + "expired" + ] + }, + "createdAt": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/createdAt" + }, + "modifiedAt": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/modifiedAt" + } + }, + "allOf": [ + { + "required": [ + "id", + "type", + "notification" + ] + }, + { + "anyOf": [ + { + "required": [ + "entities" + ] + }, + { + "required": [ + "watchedAttributes" + ] + } + ] + } + ] + } + ] + } + } + } + }, + "responses": { + "201": { + "description": "Created. Contains the resource URI of the created Subscription" + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "409": { + "description": "Already exists", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}": { + "get": { + "description": "Retrieves a specific Subscription from an NGSI-LD system", + "operationId": "retrieveSubscription", + "tags": [ + "Context Subscription" + ], + "parameters": [ + { + "name": "subscriptionId", + "description": "Subscription Id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uri" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1subscriptions~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema" + }, + "examples": { + "simple": { + "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/Subscription-example_C.4.json" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + }, + "patch": { + "description": "Updates a specific Subscription within an NGSI-LD system", + "operationId": "updateSubscription", + "tags": [ + "Context Subscription" + ], + "parameters": [ + { + "$ref": "#/paths/~1subscriptions~1%7BsubscriptionId%7D/get/parameters/0" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "type": "object", + "properties": { + "@context": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/%40context" + }, + "entities": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uri" + }, + "type": { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/10/schema" + }, + "idPattern": { + "type": "string", + "format": "regex" + } + }, + "required": [ + "type" + ] + }, + "minItems": 1 + }, + "name": { + "type": "string", + "minLength": 1 + }, + "description": { + "type": "string", + "minLength": 1 + }, + "watchedAttributes": { + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/10/schema" + }, + "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": { + "type": "object", + "required": [ + "geometry", + "coordinates", + "georel" + ], + "properties": { + "georel": { + "$ref": "#/paths/~1entities~1/get/parameters/5/schema" + }, + "coordinates": { + "$ref": "#/paths/~1entities~1/get/parameters/7/schema" + }, + "geometry": { + "$ref": "#/paths/~1entities~1/get/parameters/6/schema" + } + } + }, + "csf": { + "type": "string" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "No Content. The Subscription was updated successfully" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + }, + "delete": { + "description": "Removes a specific Subscription from an NGSI-LD system", + "operationId": "removeSubscription", + "tags": [ + "Context Subscription" + ], + "parameters": [ + { + "$ref": "#/paths/~1subscriptions~1%7BsubscriptionId%7D/get/parameters/0" + } + ], + "responses": { + "204": { + "description": "No Content. The Subscription was removed successfully" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + }, + "/csourceRegistrations/": { + "get": { + "description": "Retrieve a set of context sources which matches a specific query from an NGSI-LD system", + "operationId": "queryCsources", + "tags": [ + "Context Sources" + ], + "parameters": [ + { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/0" + }, + { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/1" + }, + { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/2" + }, + { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/3" + }, + { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/4" + }, + { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/5" + }, + { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/6" + }, + { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/7" + }, + { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/8" + }, + { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/14" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/paths/~1csourceRegistrations~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + }, + "examples": { + "simple": { + "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/ContextSourceRegistrationList-example.json" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + }, + "post": { + "description": "Registers a new context source within an NGSI-LD system", + "operationId": "registerCsource", + "tags": [ + "Context Sources" + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "allOf": [ + { + "type": "object", + "properties": { + "@context": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/%40context" + }, + "information": { + "type": "array", + "minItems": 1, + "items": { + "type": "object", + "anyOf": [ + { + "required": [ + "entities" + ] + }, + { + "required": [ + "properties" + ] + }, + { + "required": [ + "relationships" + ] + } + ], + "properties": { + "entities": { + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/paths/~1subscriptions~1%7BsubscriptionId%7D/patch/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/entities/items" + } + }, + "properties": { + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/10/schema" + }, + "uniqueItems": true + }, + "relationships": { + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/10/schema" + }, + "uniqueItems": true + } + } + } + }, + "observationInterval": { + "$ref": "#/paths/~1csourceRegistrations~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/0/properties/managementInterval" + }, + "managementInterval": { + "type": "object", + "required": [ + "start" + ], + "properties": { + "start": { + "type": "string", + "format": "date-time" + }, + "end": { + "type": "string", + "format": "date-time" + } + } + }, + "location": { + "$schema": "http://json-schema.org/draft-04/schema#", + "$id": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json", + "title": "geometry", + "description": "One geometry as defined by GeoJSON. Licensed as per original source is https://github.com/fge/sample-json-schemas/blob/master/geojson/geometry.json", + "type": "object", + "required": [ + "type", + "coordinates" + ], + "oneOf": [ + { + "title": "Point", + "properties": { + "type": { + "enum": [ + "Point" + ] + }, + "coordinates": { + "$ref": "#/paths/~1csourceRegistrations~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/0/properties/location/definitions/position" + } + } + }, + { + "title": "MultiPoint", + "properties": { + "type": { + "enum": [ + "MultiPoint" + ] + }, + "coordinates": { + "$ref": "#/paths/~1csourceRegistrations~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/0/properties/location/definitions/positionArray" + } + } + }, + { + "title": "LineString", + "properties": { + "type": { + "enum": [ + "LineString" + ] + }, + "coordinates": { + "$ref": "#/paths/~1csourceRegistrations~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/0/properties/location/definitions/lineString" + } + } + }, + { + "title": "MultiLineString", + "properties": { + "type": { + "enum": [ + "MultiLineString" + ] + }, + "coordinates": { + "type": "array", + "items": { + "$ref": "#/paths/~1csourceRegistrations~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/0/properties/location/definitions/lineString" + } + } + } + }, + { + "title": "Polygon", + "properties": { + "type": { + "enum": [ + "Polygon" + ] + }, + "coordinates": { + "$ref": "#/paths/~1csourceRegistrations~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/0/properties/location/definitions/polygon" + } + } + }, + { + "title": "MultiPolygon", + "properties": { + "type": { + "enum": [ + "MultiPolygon" + ] + }, + "coordinates": { + "type": "array", + "items": { + "$ref": "#/paths/~1csourceRegistrations~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/0/properties/location/definitions/polygon" + } + } + } + } + ], + "definitions": { + "position": { + "description": "A single position", + "type": "array", + "minItems": 2, + "items": [ + { + "type": "number" + }, + { + "type": "number" + } + ], + "additionalItems": false + }, + "positionArray": { + "description": "An array of positions", + "type": "array", + "items": { + "$ref": "#/paths/~1csourceRegistrations~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/0/properties/location/definitions/position" + } + }, + "lineString": { + "description": "An array of two or more positions", + "allOf": [ + { + "$ref": "#/paths/~1csourceRegistrations~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/0/properties/location/definitions/positionArray" + }, + { + "minItems": 2 + } + ] + }, + "linearRing": { + "description": "An array of four positions where the first equals the last", + "allOf": [ + { + "$ref": "#/paths/~1csourceRegistrations~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/0/properties/location/definitions/positionArray" + }, + { + "minItems": 4 + } + ] + }, + "polygon": { + "description": "An array of linear rings", + "type": "array", + "items": { + "$ref": "#/paths/~1csourceRegistrations~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/0/properties/location/definitions/linearRing" + } + } + } + }, + "observationSpace": { + "$ref": "#/paths/~1csourceRegistrations~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/0/properties/location" + }, + "operationSpace": { + "$ref": "#/paths/~1csourceRegistrations~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/0/properties/location" + }, + "expires": { + "type": "string", + "format": "date-time" + }, + "name": { + "type": "string", + "minLength": 1 + }, + "description": { + "type": "string", + "minLength": 1 + }, + "endpoint": { + "type": "string", + "format": "uri" + } + }, + "additionalProperties": { + "type": [ + "string", + "number", + "boolean", + "array", + "object" + ] + } + }, + { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "const": "ContextSourceRegistration" + }, + "createdAt": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/createdAt" + }, + "modifiedAt": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/modifiedAt" + } + }, + "required": [ + "id", + "type", + "endpoint", + "information" + ] + } + ] + } + } + } + }, + "responses": { + "201": { + "description": "Created. Contains the resource URI of the created Registration" + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "409": { + "description": "Already exists", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + }, + "/csourceRegistrations/{registrationId}": { + "get": { + "description": "Retrieves a specific context source registration from an NGSI-LD system", + "operationId": "retrieveCsource", + "tags": [ + "Context Sources" + ], + "parameters": [ + { + "name": "registrationId", + "description": "Registration Id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uri" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1csourceRegistrations~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema" + }, + "examples": { + "simple": { + "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + }, + "delete": { + "description": "Removes an specific context source registration within an NGSI-LD system", + "operationId": "removeCsource", + "tags": [ + "Context Sources" + ], + "parameters": [ + { + "$ref": "#/paths/~1csourceRegistrations~1%7BregistrationId%7D/get/parameters/0" + } + ], + "responses": { + "204": { + "description": "No Content. The Registration was removed successfully" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + }, + "/csourceSubscriptions/": { + "get": { + "description": "Retrieves the context source discovery subscriptions available in an NGSI-LD system", + "operationId": "retrieveCSourceSubscriptions", + "tags": [ + "Context Sources" + ], + "parameters": [ + { + "name": "limit", + "description": "Pagination limit", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1subscriptions~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema" + }, + "examples": { + "simple": { + "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/SubscriptionList-example.json" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + }, + "post": { + "description": "Creates a context source discovery Subscription within an NGSI-LD system", + "operationId": "createCSourceSubscription", + "tags": [ + "Context Sources" + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1subscriptions~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "responses": { + "201": { + "description": "Created. Contains the resource URI of the created Subscription" + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "409": { + "description": "Already exists", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + }, + "/csourceSubscriptions/{subscriptionId}": { + "get": { + "description": "Retrieves a specific Subscription from an NGSI-LD system", + "operationId": "retrieveSubscription", + "tags": [ + "Context Sources" + ], + "parameters": [ + { + "name": "subscriptionId", + "description": "Subscription Id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uri" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1subscriptions~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema" + }, + "examples": { + "simple": { + "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/Subscription-example_C.4.json" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + }, + "patch": { + "description": "Updates a specific context source discovery Subscription within an NGSI-LD system", + "operationId": "updateCSourceSubscription", + "tags": [ + "Context Sources" + ], + "parameters": [ + { + "$ref": "#/paths/~1csourceSubscriptions~1%7BsubscriptionId%7D/get/parameters/0" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1subscriptions~1%7BsubscriptionId%7D/patch/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "responses": { + "204": { + "description": "No Content. The Subscription was updated successfully" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + }, + "delete": { + "description": "Removes a specific Context Source Subscription from an NGSI-LD system", + "operationId": "removeCSourceSubscription", + "tags": [ + "Context Sources" + ], + "parameters": [ + { + "$ref": "#/paths/~1csourceSubscriptions~1%7BsubscriptionId%7D/get/parameters/0" + } + ], + "responses": { + "204": { + "description": "No Content. The Subscription was removed successfully" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + }, + "/entityOperations/create": { + "post": { + "description": "Batch Entity creation", + "operationId": "batchEntityCreation", + "tags": [ + "Batch Operations" + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/paths/~1entities~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json;application/ld+json": { + "schema": { + "type": "object", + "properties": { + "success": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + } + }, + "error": { + "type": "array", + "items": { + "entityId": { + "type": "string", + "format": "uri" + }, + "error": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + }, + "/entityOperations/update": { + "post": { + "description": "Batch Entity update", + "operationId": "batchEntityUpdate", + "tags": [ + "Batch Operations" + ], + "parameters": [ + { + "name": "options", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "noOverwrite" + ] + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entityOperations~1create/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entityOperations~1create/post/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + }, + "/entityOperations/upsert": { + "post": { + "description": "Batch Entity upsert", + "operationId": "batchEntityUpsert", + "tags": [ + "Batch Operations" + ], + "parameters": [ + { + "name": "options", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "replace", + "update" + ] + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entityOperations~1create/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entityOperations~1create/post/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + }, + "/entityOperations/delete": { + "post": { + "description": "Batch Entity delete", + "operationId": "batchEntityDelete", + "tags": [ + "Batch Operations" + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "minItems": 1 + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entityOperations~1create/post/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + }, + "/temporal/entities/": { + "get": { + "description": "Query temporal evolution of Entities from an NGSI-LD system", + "operationId": "queryTemporalEntities", + "tags": [ + "Temporal Evolution" + ], + "parameters": [ + { + "name": "id", + "description": "Comma separated list of URIs to be retrieved", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "uri" + } + }, + { + "name": "idPattern", + "description": "Regular expression that must be matched by Entity ids", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "regexp" + } + }, + { + "name": "type", + "description": "Comma separated list of Entity type names to be retrieved", + "in": "query", + "required": false, + "schema": { + "type": "string", + "minLength": 1 + } + }, + { + "name": "attrs", + "description": "Comma separated list of attribute names (properties or relationships) to be retrieved", + "in": "query", + "required": false, + "schema": { + "type": "string", + "minLength": 1 + } + }, + { + "name": "q", + "description": "Query", + "in": "query", + "required": false, + "schema": { + "type": "string", + "minLength": 1 + } + }, + { + "name": "georel", + "description": "Geo-relationship", + "in": "query", + "required": false, + "schema": { + "$ref": "#/paths/~1entities~1/get/parameters/5/schema" + } + }, + { + "name": "geometry", + "description": "Geometry", + "in": "query", + "required": false, + "schema": { + "$ref": "#/paths/~1entities~1/get/parameters/6/schema" + } + }, + { + "name": "coordinates", + "description": "Coordinates serialized as a string", + "in": "query", + "required": false, + "schema": { + "$ref": "#/paths/~1entities~1/get/parameters/7/schema" + } + }, + { + "name": "geoproperty", + "description": "The name of the property that contains the geo-spatial data that will be used to resolve the geoquery", + "in": "query", + "required": false, + "schema": { + "type": "string", + "minLength": 1 + } + }, + { + "name": "timerel", + "description": "Time relationship", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "before", + "after", + "between" + ] + } + }, + { + "name": "timeproperty", + "description": "The name of the property that contains the temporal data that will be used to resolve the temporal query", + "in": "query", + "required": false, + "schema": { + "type": "string", + "pattern": "^((\\d|[a-zA-Z]|_)+(:(\\d|[a-zA-Z]|_)+)?(#\\d+)?)$", + "minLength": 1, + "description": "NGSI-LD Name" + } + }, + { + "name": "time", + "description": "start time for temporal query", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "name": "endTime", + "description": "end time for temporal query", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "name": "csf", + "description": "Context Source Filter", + "in": "query", + "required": false, + "schema": { + "type": "string", + "minLength": 1 + } + }, + { + "name": "limit", + "description": "Pagination limit", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1 + } + }, + { + "name": "options", + "description": "Options dictionary", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "temporalValues", + "sysAttrs" + ] + } + }, + { + "name": "lastN", + "description": "Only retrieve last N instances", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "type": "array", + "items": { + "$schema": "http://json-schema.org/schema#", + "$id": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/temporal/EntityTemporal.json", + "title": "NGSI-LD Entity", + "description": "NGSI-LD Temporal Representation of an Entity", + "definitions": { + "EntityTemporalFragment": { + "type": "object", + "properties": { + "@context": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/%40context" + }, + "location": { + "type": "array", + "items": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/location" + }, + "minItems": 1 + }, + "observationSpace": { + "type": "array", + "items": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/location" + }, + "minItems": 1 + }, + "operationSpace": { + "type": "array", + "items": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/location" + }, + "minItems": 1 + }, + "id": { + "type": "string", + "format": "uri" + }, + "type": { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/10/schema" + }, + "createdAt": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/createdAt" + }, + "modifiedAt": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/modifiedAt" + } + }, + "additionalProperties": { + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/additionalProperties/anyOf/0" + }, + "minItems": 1 + }, + { + "type": "array", + "items": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/additionalProperties/anyOf/1" + }, + "minItems": 1 + }, + { + "type": "array", + "items": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/location" + }, + "minItems": 1 + } + ] + }, + "propertyNames": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/propertyNames" + } + }, + "EntityTemporal": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "type" + ] + }, + { + "$ref": "#/paths/~1temporal~1entities~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/definitions/EntityTemporalFragment" + } + ] + } + }, + "allOf": [ + { + "$ref": "#/paths/~1temporal~1entities~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/definitions/EntityTemporal" + } + ] + } + }, + "examples": { + "simple": { + "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/EntityTemporalList-example.json" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + }, + "post": { + "description": "Create or update temporal representation of an Entity within an NGSI-LD system", + "operationId": "createUpdateEntityTemporal", + "tags": [ + "Temporal Evolution" + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1temporal~1entities~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/definitions/EntityTemporal" + }, + "examples": { + "simple": { + "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/EntityTemporal-example_C5.5.3.json" + } + } + } + } + }, + "responses": { + "201": { + "description": "Created. Contains the resource URI of the created Entity" + }, + "204": { + "description": "Updated. No Content" + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "409": { + "description": "Already exists", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + }, + "/temporal/entities/{entityId}": { + "get": { + "description": "Retrieve the temporal representation of an specific Entity from an NGSI-LD system. It's possible to specify the Entity attributes to be retrieved by using query parameters", + "operationId": "retrieveEntityTemporalById", + "tags": [ + "Temporal Evolution" + ], + "parameters": [ + { + "name": "entityId", + "description": "Entity Id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uri" + } + }, + { + "name": "attrs", + "description": "Comma separated list of attribute names (properties or relationships) to be retrieved", + "in": "query", + "required": false, + "schema": { + "type": "string", + "minLength": 1 + } + }, + { + "name": "type", + "description": "Entity Type", + "in": "query", + "required": false, + "schema": { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/10/schema" + } + }, + { + "name": "options", + "description": "Options dictionary", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "temporalValues", + "sysAttrs" + ] + } + }, + { + "name": "timerel", + "description": "Time relationship", + "in": "query", + "required": false, + "schema": { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/9/schema" + } + }, + { + "name": "timeproperty", + "description": "The name of the property that contains the temporal data that will be used to resolve the temporal query", + "in": "query", + "required": false, + "schema": { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/10/schema" + } + }, + { + "name": "time", + "description": "start time for temporal query", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "name": "endTime", + "description": "end time for temporal query", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "name": "lastN", + "description": "Only retrieve last N instances", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1temporal~1entities~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/definitions/EntityTemporal" + }, + "examples": { + "simple": { + "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/EntityTemporal-example_C5.5.3.json" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + }, + "delete": { + "description": "Removes the temporal representation of an Entity from an NGSI-LD system", + "operationId": "removeEntityTemporalById", + "tags": [ + "Temporal Evolution" + ], + "parameters": [ + { + "$ref": "#/paths/~1temporal~1entities~1%7BentityId%7D/get/parameters/0" + }, + { + "$ref": "#/paths/~1temporal~1entities~1%7BentityId%7D/get/parameters/2" + } + ], + "responses": { + "204": { + "description": "No Content. The entity was removed successfully" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + }, + "/temporal/entities/{entityId}/attrs/": { + "post": { + "description": "Add new attributes to an existing Temporal Entity within an NGSI-LD system", + "operationId": "addTemporalEntityAttrs", + "tags": [ + "Temporal Evolution" + ], + "parameters": [ + { + "name": "entityId", + "description": "Entity Id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uri" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1temporal~1entities~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/definitions/EntityTemporalFragment" + } + } + } + }, + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + }, + "/temporal/entities/{entityId}/attrs/{attrId}": { + "delete": { + "description": "Attribute from Temporal Representation of Entity deletion", + "operationId": "removeEntityTemporalAttr", + "tags": [ + "Temporal Evolution" + ], + "parameters": [ + { + "$ref": "#/paths/~1temporal~1entities~1%7BentityId%7D~1attrs~1/post/parameters/0" + }, + { + "name": "attrId", + "description": "Attribute Id", + "in": "path", + "required": true, + "schema": { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/10/schema" + } + } + ], + "responses": { + "204": { + "description": "No Content." + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + }, + "/temporal/entities/{entityId}/attrs/{attrId}/{instanceId}": { + "patch": { + "description": "Allows modifying a specific Attribute (Property or Relationship) instance, identified by its instanceId, of a Temporal Representation of an Entity.", + "operationId": "modifyEntityTemporalAttrInstance", + "tags": [ + "Temporal Evolution" + ], + "parameters": [ + { + "$ref": "#/paths/~1temporal~1entities~1%7BentityId%7D~1attrs~1/post/parameters/0" + }, + { + "$ref": "#/paths/~1temporal~1entities~1%7BentityId%7D~1attrs~1%7BattrId%7D/delete/parameters/1" + }, + { + "name": "instanceId", + "description": "Instance Id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uri" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1temporal~1entities~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/definitions/EntityTemporalFragment" + } + } + } + }, + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + }, + "delete": { + "description": "Attribute Instance deletion by instance id.", + "operationId": "removeEntityTemporalAttrInstance", + "tags": [ + "Temporal Evolution" + ], + "parameters": [ + { + "$ref": "#/paths/~1temporal~1entities~1%7BentityId%7D~1attrs~1/post/parameters/0" + }, + { + "$ref": "#/paths/~1temporal~1entities~1%7BentityId%7D~1attrs~1%7BattrId%7D/delete/parameters/1" + }, + { + "$ref": "#/paths/~1temporal~1entities~1%7BentityId%7D~1attrs~1%7BattrId%7D~1%7BinstanceId%7D/patch/parameters/2" + } + ], + "responses": { + "204": { + "description": "No Content." + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + } + } +} diff --git a/bundle/ngsild_swagger_combined_dereferenced.json b/bundle/ngsild_swagger_combined_dereferenced.json new file mode 100644 index 0000000..4c94a6f --- /dev/null +++ b/bundle/ngsild_swagger_combined_dereferenced.json @@ -0,0 +1,3052 @@ +{ + "openapi": "3.0.3", + "info": { + "description": "This OAS file describes the NGSI-LD API defined by the ETSI ISG CIM group. This Cross-domain Context Information Management API allows to provide, consume and subscribe to context information in multiple scenarios and involving multiple stakeholders", + "version": "latest", + "title": "ETSI ISG CIM / NGSI-LD API", + "contact": { + "email": "NGSI-LD@etsi.org" + } + }, + "externalDocs": { + "description": "Find out more about the ETSI ISG Context Information Management", + "url": "https://portal.etsi.org/tb.aspx?tbid=854&SubTB=854" + }, + "tags": [ + { + "name": "ETSI", + "description": "European Telecommunications Standards Institute", + "externalDocs": { + "description": "Find out more", + "url": "http://www.etsi.org" + } + }, + { + "name": "CIM", + "description": "Context Information Management", + "externalDocs": { + "description": "Find out more", + "url": "https://portal.etsi.org/tb.aspx?tbid=854&SubTB=854" + } + }, + { + "name": "JSON-LD", + "description": "JSON for Linked Data", + "externalDocs": { + "description": "Find out more", + "url": "https://json-ld.org/" + } + }, + { + "name": "NGSI-LD API", + "description": "API defined by the ETSI ISG CIM", + "externalDocs": { + "description": "Preliminary Specification", + "url": "http://www.etsi.org/deliver/etsi_gs/CIM/001_099/004/01.01.01_60/gs_CIM004v010101p.pdf" + } + } + ], + "paths": { + "/entities/": { + "get": { + "description": "Retrieve a set of entities which matches a specific query from an NGSI-LD system", + "operationId": "queryEntities", + "tags": [ + "Context Information" + ], + "parameters": [ + { + "name": "id", + "description": "Comma separated list of URIs to be retrieved", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "uri" + } + }, + { + "name": "idPattern", + "description": "Regular expression that must be matched by Entity ids", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "regexp" + } + }, + { + "name": "type", + "description": "Comma separated list of Entity type names to be retrieved", + "in": "query", + "required": false, + "schema": { + "type": "string", + "minLength": 1 + } + }, + { + "name": "attrs", + "description": "Comma separated list of attribute names (properties or relationships) to be retrieved", + "in": "query", + "required": false, + "schema": { + "type": "string", + "minLength": 1 + } + }, + { + "name": "q", + "description": "Query", + "in": "query", + "required": false, + "schema": { + "type": "string", + "minLength": 1 + } + }, + { + "name": "georel", + "description": "Geo-relationship", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string", + "enum": [ + "equals", + "disjoint", + "intersects", + "within", + "contains", + "overlaps" + ] + }, + { + "type": "string", + "pattern": "^near;((maxDistance==\\d+)|(minDistance==\\d+))$" + } + ] + } + }, + { + "name": "geometry", + "description": "Geometry", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "Point", + "MultiPoint", + "LineString", + "MultiLineString", + "Polygon", + "MultiPolygon" + ] + } + }, + { + "name": "coordinates", + "description": "Coordinates serialized as a string", + "in": "query", + "required": false, + "schema": { + "oneOf": [ + { + "$ref": "#/paths/~1csourceRegistrations~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/0/properties/location/definitions/position" + }, + { + "$ref": "#/paths/~1csourceRegistrations~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/0/properties/location/definitions/positionArray" + }, + { + "$ref": "#/paths/~1csourceRegistrations~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/0/properties/location/definitions/lineString" + }, + { + "$ref": "#/paths/~1csourceRegistrations~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/0/properties/location/definitions/polygon" + } + ] + } + }, + { + "name": "geoproperty", + "description": "The name of the property that contains the geo-spatial data that will be used to resolve the geoquery", + "in": "query", + "required": false, + "schema": { + "type": "string", + "minLength": 1 + } + }, + { + "name": "csf", + "description": "Context Source Filter", + "in": "query", + "required": false, + "schema": { + "type": "string", + "minLength": 1 + } + }, + { + "name": "limit", + "description": "Pagination limit", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1 + } + }, + { + "name": "options", + "description": "Options dictionary", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "keyValues", + "sysAttrs" + ] + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entityOperations~1create/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema" + }, + "examples": { + "simple": { + "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/EntityList-example.json" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "type": "object", + "properties": { + "type": { + "type": "string", + "format": "uri" + }, + "title": { + "type": "string" + }, + "detail": { + "type": "string" + } + }, + "required": [ + "type" + ] + } + } + } + } + } + }, + "post": { + "description": "Create a new Entity within an NGSI-LD system", + "operationId": "createEntity", + "tags": [ + "Context Information" + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "allOf": [ + { + "required": [ + "id", + "type" + ] + }, + { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + ] + } + } + } + }, + "responses": { + "201": { + "description": "Created. Contains the resource URI of the created Entity" + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "409": { + "description": "Already exists", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + }, + "/entities/{entityId}": { + "get": { + "description": "Retrieve an specific Entity from an NGSI-LD system. It's possible to specify the Entity attributes to be retrieved by using query parameters", + "operationId": "retrieveEntityById", + "tags": [ + "Context Information" + ], + "parameters": [ + { + "name": "entityId", + "description": "Entity Id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uri" + } + }, + { + "name": "attrs", + "description": "Comma separated list of attribute names (properties or relationships) to be retrieved", + "in": "query", + "required": false, + "schema": { + "type": "string", + "minLength": 1 + } + }, + { + "name": "type", + "description": "Entity Type", + "in": "query", + "required": false, + "schema": { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/10/schema" + } + }, + { + "name": "options", + "description": "Options dictionary", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "keyValues", + "sysAttrs" + ] + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema" + }, + "examples": { + "simple": { + "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/Entity-example.json" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + }, + "delete": { + "description": "Removes an specific Entity from an NGSI-LD system", + "operationId": "removeEntityById", + "tags": [ + "Context Information" + ], + "parameters": [ + { + "$ref": "#/paths/~1entities~1%7BentityId%7D/get/parameters/0" + }, + { + "$ref": "#/paths/~1entities~1%7BentityId%7D/get/parameters/2" + } + ], + "responses": { + "204": { + "description": "No Content. The entity was removed successfully" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + }, + "/entities/{entityId}/attrs/": { + "post": { + "description": "Append new Entity attributes to an existing Entity within an NGSI-LD system", + "operationId": "appendEntityAttrs", + "tags": [ + "Context Information" + ], + "parameters": [ + { + "name": "entityId", + "description": "Entity Id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uri" + } + }, + { + "name": "options", + "description": "Indicates that no attribute overwrite shall be performed", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "noOverwrite" + ] + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "type": "object", + "properties": { + "@context": { + "anyOf": [ + { + "type": "object" + }, + { + "type": "string", + "format": "uri" + }, + { + "type": "array", + "minItems": 1, + "items": { + "anyOf": [ + { + "type": "string", + "format": "uri" + }, + { + "type": "object" + } + ] + } + } + ] + }, + "location": { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "GeoProperty" + }, + "value": { + "$ref": "#/paths/~1csourceRegistrations~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/0/properties/location" + }, + "observedAt": { + "type": "string", + "format": "date-time" + }, + "createdAt": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/createdAt" + }, + "modifiedAt": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/modifiedAt" + }, + "datasetId": { + "type": "string", + "format": "uri" + }, + "instanceId": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "type", + "value" + ], + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/additionalProperties/anyOf/0" + }, + { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/additionalProperties/anyOf/1" + } + ] + } + }, + "observationSpace": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/location" + }, + "operationSpace": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/location" + }, + "id": { + "type": "string", + "format": "uri" + }, + "type": { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/10/schema" + }, + "createdAt": { + "type": "string", + "format": "date-time" + }, + "modifiedAt": { + "type": "string", + "format": "date-time" + } + }, + "additionalProperties": { + "anyOf": [ + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "Property" + }, + "value": { + "type": [ + "string", + "number", + "boolean", + "array", + "object" + ] + }, + "observedAt": { + "$ref": "#/paths/~1entities~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/1/properties/location/properties/observedAt" + }, + "createdAt": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/createdAt" + }, + "modifiedAt": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/modifiedAt" + }, + "datasetId": { + "$ref": "#/paths/~1entities~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/1/properties/location/properties/datasetId" + }, + "instanceId": { + "$ref": "#/paths/~1entities~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/1/properties/location/properties/instanceId" + } + }, + "required": [ + "type", + "value" + ], + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/additionalProperties/anyOf/0" + }, + { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/additionalProperties/anyOf/1" + } + ] + } + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "Relationship" + }, + "object": { + "type": "string", + "format": "uri" + }, + "observedAt": { + "$ref": "#/paths/~1entities~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/1/properties/location/properties/observedAt" + }, + "createdAt": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/createdAt" + }, + "modifiedAt": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/modifiedAt" + }, + "datasetId": { + "$ref": "#/paths/~1entities~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/1/properties/location/properties/datasetId" + }, + "instanceId": { + "$ref": "#/paths/~1entities~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/1/properties/location/properties/instanceId" + } + }, + "required": [ + "type", + "object" + ], + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/additionalProperties/anyOf/0" + }, + { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/additionalProperties/anyOf/1" + } + ] + } + }, + { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/location" + } + ] + }, + "propertyNames": { + "type": "string", + "pattern": "^((\\d|[a-zA-Z]|_)+(:(\\d|[a-zA-Z]|_)+)?(#\\d+)?)$|^(@context)$" + } + } + } + } + }, + "responses": { + "204": { + "description": "No Content" + }, + "207": { + "description": "Partial Success. Only the attributes included in the response payload were successfully appended", + "content": { + "application/json;application/ld+json": { + "schema": { + "$schema": "http://json-schema.org/schema#", + "$id": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/UpdateResult.json", + "title": "NGSI-LD Update Result", + "description": "NGSI-LD Update Result", + "definitions": { + "NotUpdatedDetails": { + "attributeName": { + "type": "string", + "pattern": "" + }, + "reason": { + "type": "string", + "minLenght": 1 + } + }, + "UpdateResult": { + "type": "object", + "properties": { + "updated": { + "type": "array", + "items": { + "type": "string", + "pattern": "" + } + }, + "notUpdated": { + "type": "array", + "items": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/responses/207/content/application~1json%3Bapplication~1ld%2Bjson/schema/definitions/NotUpdatedDetails" + } + } + } + } + }, + "allOf": [ + { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/responses/207/content/application~1json%3Bapplication~1ld%2Bjson/schema/definitions/UpdateResult" + } + ] + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + }, + "patch": { + "description": "Update existing Entity attributes within an NGSI-LD system", + "operationId": "updateEntityAttrs", + "tags": [ + "Context Information" + ], + "parameters": [ + { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/parameters/0" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "responses": { + "204": { + "description": "No Content." + }, + "207": { + "description": "Partial Success. Only the attributes included in the response payload were successfully updated", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/responses/207/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + }, + "/entities/{entityId}/attrs/{attrId}": { + "patch": { + "description": "Update existing Entity attributes within an NGSI-LD system", + "operationId": "partialAttrUpdate", + "tags": [ + "Context Information" + ], + "parameters": [ + { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/parameters/0" + }, + { + "name": "attrId", + "description": "Attribute Id", + "in": "path", + "required": true, + "schema": { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/10/schema" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "responses": { + "204": { + "description": "No Content." + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + }, + "delete": { + "description": "Removes an existing Entity attribute within an NGSI-LD system", + "operationId": "removeEntityAttr", + "tags": [ + "Context Information" + ], + "parameters": [ + { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/parameters/0" + }, + { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1%7BattrId%7D/patch/parameters/1" + } + ], + "responses": { + "204": { + "description": "No Content." + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + }, + "/subscriptions/": { + "get": { + "description": "Retrieves the subscriptions available in an NGSI-LD system", + "operationId": "retrieveSubscriptions", + "tags": [ + "Context Subscription" + ], + "parameters": [ + { + "name": "limit", + "description": "Pagination limit", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/paths/~1subscriptions~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + }, + "examples": { + "simple": { + "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/SubscriptionList-example.json" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + }, + "post": { + "description": "Creates a new Subscription within an NGSI-LD system", + "operationId": "createSubscription", + "tags": [ + "Context Subscription" + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "allOf": [ + { + "$ref": "#/paths/~1subscriptions~1%7BsubscriptionId%7D/patch/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema" + }, + { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "const": "Subscription" + }, + "notification": { + "type": "object", + "properties": { + "attributes": { + "type": "array", + "minItems": 1, + "items": { + "type": "string", + "minLength": 1 + }, + "uniqueItems": true + }, + "format": { + "type": "string" + }, + "endpoint": { + "type": "object", + "required": [ + "uri" + ], + "properties": { + "uri": { + "type": "string", + "format": "uri" + }, + "accept": { + "type": "string", + "enum": [ + "application/json", + "application/ld+json" + ] + } + } + }, + "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" + ] + }, + "status": { + "type": "string", + "enum": [ + "active", + "paused", + "expired" + ] + }, + "createdAt": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/createdAt" + }, + "modifiedAt": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/modifiedAt" + } + }, + "allOf": [ + { + "required": [ + "id", + "type", + "notification" + ] + }, + { + "anyOf": [ + { + "required": [ + "entities" + ] + }, + { + "required": [ + "watchedAttributes" + ] + } + ] + } + ] + } + ] + } + } + } + }, + "responses": { + "201": { + "description": "Created. Contains the resource URI of the created Subscription" + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "409": { + "description": "Already exists", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}": { + "get": { + "description": "Retrieves a specific Subscription from an NGSI-LD system", + "operationId": "retrieveSubscription", + "tags": [ + "Context Subscription" + ], + "parameters": [ + { + "name": "subscriptionId", + "description": "Subscription Id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uri" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1subscriptions~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema" + }, + "examples": { + "simple": { + "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/Subscription-example_C.4.json" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + }, + "patch": { + "description": "Updates a specific Subscription within an NGSI-LD system", + "operationId": "updateSubscription", + "tags": [ + "Context Subscription" + ], + "parameters": [ + { + "$ref": "#/paths/~1subscriptions~1%7BsubscriptionId%7D/get/parameters/0" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "type": "object", + "properties": { + "@context": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/%40context" + }, + "entities": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uri" + }, + "type": { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/10/schema" + }, + "idPattern": { + "type": "string", + "format": "regex" + } + }, + "required": [ + "type" + ] + }, + "minItems": 1 + }, + "name": { + "type": "string", + "minLength": 1 + }, + "description": { + "type": "string", + "minLength": 1 + }, + "watchedAttributes": { + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/10/schema" + }, + "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": { + "type": "object", + "required": [ + "geometry", + "coordinates", + "georel" + ], + "properties": { + "georel": { + "$ref": "#/paths/~1entities~1/get/parameters/5/schema" + }, + "coordinates": { + "$ref": "#/paths/~1entities~1/get/parameters/7/schema" + }, + "geometry": { + "$ref": "#/paths/~1entities~1/get/parameters/6/schema" + } + } + }, + "csf": { + "type": "string" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "No Content. The Subscription was updated successfully" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + }, + "delete": { + "description": "Removes a specific Subscription from an NGSI-LD system", + "operationId": "removeSubscription", + "tags": [ + "Context Subscription" + ], + "parameters": [ + { + "$ref": "#/paths/~1subscriptions~1%7BsubscriptionId%7D/get/parameters/0" + } + ], + "responses": { + "204": { + "description": "No Content. The Subscription was removed successfully" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + }, + "/csourceRegistrations/": { + "get": { + "description": "Retrieve a set of context sources which matches a specific query from an NGSI-LD system", + "operationId": "queryCsources", + "tags": [ + "Context Sources" + ], + "parameters": [ + { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/0" + }, + { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/1" + }, + { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/2" + }, + { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/3" + }, + { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/4" + }, + { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/5" + }, + { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/6" + }, + { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/7" + }, + { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/8" + }, + { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/14" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/paths/~1csourceRegistrations~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + }, + "examples": { + "simple": { + "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/ContextSourceRegistrationList-example.json" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + }, + "post": { + "description": "Registers a new context source within an NGSI-LD system", + "operationId": "registerCsource", + "tags": [ + "Context Sources" + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "allOf": [ + { + "type": "object", + "properties": { + "@context": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/%40context" + }, + "information": { + "type": "array", + "minItems": 1, + "items": { + "type": "object", + "anyOf": [ + { + "required": [ + "entities" + ] + }, + { + "required": [ + "properties" + ] + }, + { + "required": [ + "relationships" + ] + } + ], + "properties": { + "entities": { + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/paths/~1subscriptions~1%7BsubscriptionId%7D/patch/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/entities/items" + } + }, + "properties": { + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/10/schema" + }, + "uniqueItems": true + }, + "relationships": { + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/10/schema" + }, + "uniqueItems": true + } + } + } + }, + "observationInterval": { + "$ref": "#/paths/~1csourceRegistrations~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/0/properties/managementInterval" + }, + "managementInterval": { + "type": "object", + "required": [ + "start" + ], + "properties": { + "start": { + "type": "string", + "format": "date-time" + }, + "end": { + "type": "string", + "format": "date-time" + } + } + }, + "location": { + "$schema": "http://json-schema.org/draft-04/schema#", + "$id": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json", + "title": "geometry", + "description": "One geometry as defined by GeoJSON. Licensed as per original source is https://github.com/fge/sample-json-schemas/blob/master/geojson/geometry.json", + "type": "object", + "required": [ + "type", + "coordinates" + ], + "oneOf": [ + { + "title": "Point", + "properties": { + "type": { + "enum": [ + "Point" + ] + }, + "coordinates": { + "$ref": "#/paths/~1csourceRegistrations~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/0/properties/location/definitions/position" + } + } + }, + { + "title": "MultiPoint", + "properties": { + "type": { + "enum": [ + "MultiPoint" + ] + }, + "coordinates": { + "$ref": "#/paths/~1csourceRegistrations~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/0/properties/location/definitions/positionArray" + } + } + }, + { + "title": "LineString", + "properties": { + "type": { + "enum": [ + "LineString" + ] + }, + "coordinates": { + "$ref": "#/paths/~1csourceRegistrations~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/0/properties/location/definitions/lineString" + } + } + }, + { + "title": "MultiLineString", + "properties": { + "type": { + "enum": [ + "MultiLineString" + ] + }, + "coordinates": { + "type": "array", + "items": { + "$ref": "#/paths/~1csourceRegistrations~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/0/properties/location/definitions/lineString" + } + } + } + }, + { + "title": "Polygon", + "properties": { + "type": { + "enum": [ + "Polygon" + ] + }, + "coordinates": { + "$ref": "#/paths/~1csourceRegistrations~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/0/properties/location/definitions/polygon" + } + } + }, + { + "title": "MultiPolygon", + "properties": { + "type": { + "enum": [ + "MultiPolygon" + ] + }, + "coordinates": { + "type": "array", + "items": { + "$ref": "#/paths/~1csourceRegistrations~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/0/properties/location/definitions/polygon" + } + } + } + } + ], + "definitions": { + "position": { + "description": "A single position", + "type": "array", + "minItems": 2, + "items": [ + { + "type": "number" + }, + { + "type": "number" + } + ], + "additionalItems": false + }, + "positionArray": { + "description": "An array of positions", + "type": "array", + "items": { + "$ref": "#/paths/~1csourceRegistrations~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/0/properties/location/definitions/position" + } + }, + "lineString": { + "description": "An array of two or more positions", + "allOf": [ + { + "$ref": "#/paths/~1csourceRegistrations~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/0/properties/location/definitions/positionArray" + }, + { + "minItems": 2 + } + ] + }, + "linearRing": { + "description": "An array of four positions where the first equals the last", + "allOf": [ + { + "$ref": "#/paths/~1csourceRegistrations~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/0/properties/location/definitions/positionArray" + }, + { + "minItems": 4 + } + ] + }, + "polygon": { + "description": "An array of linear rings", + "type": "array", + "items": { + "$ref": "#/paths/~1csourceRegistrations~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/0/properties/location/definitions/linearRing" + } + } + } + }, + "observationSpace": { + "$ref": "#/paths/~1csourceRegistrations~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/0/properties/location" + }, + "operationSpace": { + "$ref": "#/paths/~1csourceRegistrations~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/allOf/0/properties/location" + }, + "expires": { + "type": "string", + "format": "date-time" + }, + "name": { + "type": "string", + "minLength": 1 + }, + "description": { + "type": "string", + "minLength": 1 + }, + "endpoint": { + "type": "string", + "format": "uri" + } + }, + "additionalProperties": { + "type": [ + "string", + "number", + "boolean", + "array", + "object" + ] + } + }, + { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "const": "ContextSourceRegistration" + }, + "createdAt": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/createdAt" + }, + "modifiedAt": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/modifiedAt" + } + }, + "required": [ + "id", + "type", + "endpoint", + "information" + ] + } + ] + } + } + } + }, + "responses": { + "201": { + "description": "Created. Contains the resource URI of the created Registration" + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "409": { + "description": "Already exists", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + }, + "/csourceRegistrations/{registrationId}": { + "get": { + "description": "Retrieves a specific context source registration from an NGSI-LD system", + "operationId": "retrieveCsource", + "tags": [ + "Context Sources" + ], + "parameters": [ + { + "name": "registrationId", + "description": "Registration Id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uri" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1csourceRegistrations~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema" + }, + "examples": { + "simple": { + "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + }, + "delete": { + "description": "Removes an specific context source registration within an NGSI-LD system", + "operationId": "removeCsource", + "tags": [ + "Context Sources" + ], + "parameters": [ + { + "$ref": "#/paths/~1csourceRegistrations~1%7BregistrationId%7D/get/parameters/0" + } + ], + "responses": { + "204": { + "description": "No Content. The Registration was removed successfully" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + }, + "/csourceSubscriptions/": { + "get": { + "description": "Retrieves the context source discovery subscriptions available in an NGSI-LD system", + "operationId": "retrieveCSourceSubscriptions", + "tags": [ + "Context Sources" + ], + "parameters": [ + { + "name": "limit", + "description": "Pagination limit", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1subscriptions~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema" + }, + "examples": { + "simple": { + "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/SubscriptionList-example.json" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + }, + "post": { + "description": "Creates a context source discovery Subscription within an NGSI-LD system", + "operationId": "createCSourceSubscription", + "tags": [ + "Context Sources" + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1subscriptions~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "responses": { + "201": { + "description": "Created. Contains the resource URI of the created Subscription" + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "409": { + "description": "Already exists", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + }, + "/csourceSubscriptions/{subscriptionId}": { + "get": { + "description": "Retrieves a specific Subscription from an NGSI-LD system", + "operationId": "retrieveSubscription", + "tags": [ + "Context Sources" + ], + "parameters": [ + { + "name": "subscriptionId", + "description": "Subscription Id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uri" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1subscriptions~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema" + }, + "examples": { + "simple": { + "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/Subscription-example_C.4.json" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + }, + "patch": { + "description": "Updates a specific context source discovery Subscription within an NGSI-LD system", + "operationId": "updateCSourceSubscription", + "tags": [ + "Context Sources" + ], + "parameters": [ + { + "$ref": "#/paths/~1csourceSubscriptions~1%7BsubscriptionId%7D/get/parameters/0" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1subscriptions~1%7BsubscriptionId%7D/patch/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "responses": { + "204": { + "description": "No Content. The Subscription was updated successfully" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + }, + "delete": { + "description": "Removes a specific Context Source Subscription from an NGSI-LD system", + "operationId": "removeCSourceSubscription", + "tags": [ + "Context Sources" + ], + "parameters": [ + { + "$ref": "#/paths/~1csourceSubscriptions~1%7BsubscriptionId%7D/get/parameters/0" + } + ], + "responses": { + "204": { + "description": "No Content. The Subscription was removed successfully" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + }, + "/entityOperations/create": { + "post": { + "description": "Batch Entity creation", + "operationId": "batchEntityCreation", + "tags": [ + "Batch Operations" + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/paths/~1entities~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json;application/ld+json": { + "schema": { + "type": "object", + "properties": { + "success": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + } + }, + "error": { + "type": "array", + "items": { + "entityId": { + "type": "string", + "format": "uri" + }, + "error": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + }, + "/entityOperations/update": { + "post": { + "description": "Batch Entity update", + "operationId": "batchEntityUpdate", + "tags": [ + "Batch Operations" + ], + "parameters": [ + { + "name": "options", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "noOverwrite" + ] + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entityOperations~1create/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entityOperations~1create/post/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + }, + "/entityOperations/upsert": { + "post": { + "description": "Batch Entity upsert", + "operationId": "batchEntityUpsert", + "tags": [ + "Batch Operations" + ], + "parameters": [ + { + "name": "options", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "replace", + "update" + ] + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entityOperations~1create/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entityOperations~1create/post/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + }, + "/entityOperations/delete": { + "post": { + "description": "Batch Entity delete", + "operationId": "batchEntityDelete", + "tags": [ + "Batch Operations" + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "minItems": 1 + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entityOperations~1create/post/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + }, + "/temporal/entities/": { + "get": { + "description": "Query temporal evolution of Entities from an NGSI-LD system", + "operationId": "queryTemporalEntities", + "tags": [ + "Temporal Evolution" + ], + "parameters": [ + { + "name": "id", + "description": "Comma separated list of URIs to be retrieved", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "uri" + } + }, + { + "name": "idPattern", + "description": "Regular expression that must be matched by Entity ids", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "regexp" + } + }, + { + "name": "type", + "description": "Comma separated list of Entity type names to be retrieved", + "in": "query", + "required": false, + "schema": { + "type": "string", + "minLength": 1 + } + }, + { + "name": "attrs", + "description": "Comma separated list of attribute names (properties or relationships) to be retrieved", + "in": "query", + "required": false, + "schema": { + "type": "string", + "minLength": 1 + } + }, + { + "name": "q", + "description": "Query", + "in": "query", + "required": false, + "schema": { + "type": "string", + "minLength": 1 + } + }, + { + "name": "georel", + "description": "Geo-relationship", + "in": "query", + "required": false, + "schema": { + "$ref": "#/paths/~1entities~1/get/parameters/5/schema" + } + }, + { + "name": "geometry", + "description": "Geometry", + "in": "query", + "required": false, + "schema": { + "$ref": "#/paths/~1entities~1/get/parameters/6/schema" + } + }, + { + "name": "coordinates", + "description": "Coordinates serialized as a string", + "in": "query", + "required": false, + "schema": { + "$ref": "#/paths/~1entities~1/get/parameters/7/schema" + } + }, + { + "name": "geoproperty", + "description": "The name of the property that contains the geo-spatial data that will be used to resolve the geoquery", + "in": "query", + "required": false, + "schema": { + "type": "string", + "minLength": 1 + } + }, + { + "name": "timerel", + "description": "Time relationship", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "before", + "after", + "between" + ] + } + }, + { + "name": "timeproperty", + "description": "The name of the property that contains the temporal data that will be used to resolve the temporal query", + "in": "query", + "required": false, + "schema": { + "type": "string", + "pattern": "^((\\d|[a-zA-Z]|_)+(:(\\d|[a-zA-Z]|_)+)?(#\\d+)?)$", + "minLength": 1, + "description": "NGSI-LD Name" + } + }, + { + "name": "time", + "description": "start time for temporal query", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "name": "endTime", + "description": "end time for temporal query", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "name": "csf", + "description": "Context Source Filter", + "in": "query", + "required": false, + "schema": { + "type": "string", + "minLength": 1 + } + }, + { + "name": "limit", + "description": "Pagination limit", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1 + } + }, + { + "name": "options", + "description": "Options dictionary", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "temporalValues", + "sysAttrs" + ] + } + }, + { + "name": "lastN", + "description": "Only retrieve last N instances", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "type": "array", + "items": { + "$schema": "http://json-schema.org/schema#", + "$id": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/temporal/EntityTemporal.json", + "title": "NGSI-LD Entity", + "description": "NGSI-LD Temporal Representation of an Entity", + "definitions": { + "EntityTemporalFragment": { + "type": "object", + "properties": { + "@context": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/%40context" + }, + "location": { + "type": "array", + "items": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/location" + }, + "minItems": 1 + }, + "observationSpace": { + "type": "array", + "items": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/location" + }, + "minItems": 1 + }, + "operationSpace": { + "type": "array", + "items": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/location" + }, + "minItems": 1 + }, + "id": { + "type": "string", + "format": "uri" + }, + "type": { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/10/schema" + }, + "createdAt": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/createdAt" + }, + "modifiedAt": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/modifiedAt" + } + }, + "additionalProperties": { + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/additionalProperties/anyOf/0" + }, + "minItems": 1 + }, + { + "type": "array", + "items": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/additionalProperties/anyOf/1" + }, + "minItems": 1 + }, + { + "type": "array", + "items": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/location" + }, + "minItems": 1 + } + ] + }, + "propertyNames": { + "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/propertyNames" + } + }, + "EntityTemporal": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "type" + ] + }, + { + "$ref": "#/paths/~1temporal~1entities~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/definitions/EntityTemporalFragment" + } + ] + } + }, + "allOf": [ + { + "$ref": "#/paths/~1temporal~1entities~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/definitions/EntityTemporal" + } + ] + } + }, + "examples": { + "simple": { + "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/EntityTemporalList-example.json" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + }, + "post": { + "description": "Create or update temporal representation of an Entity within an NGSI-LD system", + "operationId": "createUpdateEntityTemporal", + "tags": [ + "Temporal Evolution" + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1temporal~1entities~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/definitions/EntityTemporal" + }, + "examples": { + "simple": { + "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/EntityTemporal-example_C5.5.3.json" + } + } + } + } + }, + "responses": { + "201": { + "description": "Created. Contains the resource URI of the created Entity" + }, + "204": { + "description": "Updated. No Content" + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "409": { + "description": "Already exists", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + }, + "/temporal/entities/{entityId}": { + "get": { + "description": "Retrieve the temporal representation of an specific Entity from an NGSI-LD system. It's possible to specify the Entity attributes to be retrieved by using query parameters", + "operationId": "retrieveEntityTemporalById", + "tags": [ + "Temporal Evolution" + ], + "parameters": [ + { + "name": "entityId", + "description": "Entity Id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uri" + } + }, + { + "name": "attrs", + "description": "Comma separated list of attribute names (properties or relationships) to be retrieved", + "in": "query", + "required": false, + "schema": { + "type": "string", + "minLength": 1 + } + }, + { + "name": "type", + "description": "Entity Type", + "in": "query", + "required": false, + "schema": { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/10/schema" + } + }, + { + "name": "options", + "description": "Options dictionary", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "temporalValues", + "sysAttrs" + ] + } + }, + { + "name": "timerel", + "description": "Time relationship", + "in": "query", + "required": false, + "schema": { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/9/schema" + } + }, + { + "name": "timeproperty", + "description": "The name of the property that contains the temporal data that will be used to resolve the temporal query", + "in": "query", + "required": false, + "schema": { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/10/schema" + } + }, + { + "name": "time", + "description": "start time for temporal query", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "name": "endTime", + "description": "end time for temporal query", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "name": "lastN", + "description": "Only retrieve last N instances", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1temporal~1entities~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/definitions/EntityTemporal" + }, + "examples": { + "simple": { + "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/EntityTemporal-example_C5.5.3.json" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + }, + "delete": { + "description": "Removes the temporal representation of an Entity from an NGSI-LD system", + "operationId": "removeEntityTemporalById", + "tags": [ + "Temporal Evolution" + ], + "parameters": [ + { + "$ref": "#/paths/~1temporal~1entities~1%7BentityId%7D/get/parameters/0" + }, + { + "$ref": "#/paths/~1temporal~1entities~1%7BentityId%7D/get/parameters/2" + } + ], + "responses": { + "204": { + "description": "No Content. The entity was removed successfully" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + }, + "/temporal/entities/{entityId}/attrs/": { + "post": { + "description": "Add new attributes to an existing Temporal Entity within an NGSI-LD system", + "operationId": "addTemporalEntityAttrs", + "tags": [ + "Temporal Evolution" + ], + "parameters": [ + { + "name": "entityId", + "description": "Entity Id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uri" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1temporal~1entities~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/definitions/EntityTemporalFragment" + } + } + } + }, + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + }, + "/temporal/entities/{entityId}/attrs/{attrId}": { + "delete": { + "description": "Attribute from Temporal Representation of Entity deletion", + "operationId": "removeEntityTemporalAttr", + "tags": [ + "Temporal Evolution" + ], + "parameters": [ + { + "$ref": "#/paths/~1temporal~1entities~1%7BentityId%7D~1attrs~1/post/parameters/0" + }, + { + "name": "attrId", + "description": "Attribute Id", + "in": "path", + "required": true, + "schema": { + "$ref": "#/paths/~1temporal~1entities~1/get/parameters/10/schema" + } + } + ], + "responses": { + "204": { + "description": "No Content." + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + }, + "/temporal/entities/{entityId}/attrs/{attrId}/{instanceId}": { + "patch": { + "description": "Allows modifying a specific Attribute (Property or Relationship) instance, identified by its instanceId, of a Temporal Representation of an Entity.", + "operationId": "modifyEntityTemporalAttrInstance", + "tags": [ + "Temporal Evolution" + ], + "parameters": [ + { + "$ref": "#/paths/~1temporal~1entities~1%7BentityId%7D~1attrs~1/post/parameters/0" + }, + { + "$ref": "#/paths/~1temporal~1entities~1%7BentityId%7D~1attrs~1%7BattrId%7D/delete/parameters/1" + }, + { + "name": "instanceId", + "description": "Instance Id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uri" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1temporal~1entities~1/get/responses/200/content/application~1json%3Bapplication~1ld%2Bjson/schema/items/definitions/EntityTemporalFragment" + } + } + } + }, + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + }, + "delete": { + "description": "Attribute Instance deletion by instance id.", + "operationId": "removeEntityTemporalAttrInstance", + "tags": [ + "Temporal Evolution" + ], + "parameters": [ + { + "$ref": "#/paths/~1temporal~1entities~1%7BentityId%7D~1attrs~1/post/parameters/0" + }, + { + "$ref": "#/paths/~1temporal~1entities~1%7BentityId%7D~1attrs~1%7BattrId%7D/delete/parameters/1" + }, + { + "$ref": "#/paths/~1temporal~1entities~1%7BentityId%7D~1attrs~1%7BattrId%7D~1%7BinstanceId%7D/patch/parameters/2" + } + ], + "responses": { + "204": { + "description": "No Content." + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/paths/~1entities~1/get/responses/400/content/application~1json%3Bapplication~1ld%2Bjson/schema" + } + } + } + } + } + } + } + } +} diff --git a/examples/ContextSourceRegistration-example_C.3.json b/examples/ContextSourceRegistration-example_C.3.json index cadf8d5..008f3b4 100644 --- a/examples/ContextSourceRegistration-example_C.3.json +++ b/examples/ContextSourceRegistration-example_C.3.json @@ -72,6 +72,6 @@ "http://example.org/ngsi-ld/commonTerms.jsonld", "http://example.org/ngsi-ld/vehicle.jsonld", "http://example.org/ngsi-ld/parking.jsonld", - "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld" + "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context-v1.3.jsonld" ] } diff --git a/examples/ContextSourceRegistrationList-example.json b/examples/ContextSourceRegistrationList-example.json index 405b4b4..608b691 100644 --- a/examples/ContextSourceRegistrationList-example.json +++ b/examples/ContextSourceRegistrationList-example.json @@ -72,6 +72,6 @@ "http://example.org/ngsi-ld/commonTerms.jsonld", "http://example.org/ngsi-ld/vehicle.jsonld", "http://example.org/ngsi-ld/parking.jsonld", - "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld" + "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context-v1.3.jsonld" ] }] diff --git a/examples/Entity-example.json b/examples/Entity-example.json index 60efe19..ec9fc18 100644 --- a/examples/Entity-example.json +++ b/examples/Entity-example.json @@ -26,6 +26,6 @@ }, "@context": [ "https://example.org/ld/vehicle.jsonld", - "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld" + "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context-v1.3.jsonld" ] } diff --git a/examples/EntityList-example.json b/examples/EntityList-example.json index e3abe5b..6a997fa 100644 --- a/examples/EntityList-example.json +++ b/examples/EntityList-example.json @@ -27,7 +27,7 @@ }, "@context": [ "https://example.org/ld/vehicle.jsonld", - "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld" + "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context-v1.3.jsonld" ] } ] diff --git a/examples/EntityTemporal-example_C5.5.3.json b/examples/EntityTemporal-example_C5.5.3.json index fdc2e38..1782ba8 100644 --- a/examples/EntityTemporal-example_C5.5.3.json +++ b/examples/EntityTemporal-example_C5.5.3.json @@ -26,6 +26,6 @@ ], "@context": [ "http://example.org/ngsi-ld/vehicle.jsonld", - "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld" + "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context-v1.3.jsonld" ] } diff --git a/examples/EntityTemporalList-example.json b/examples/EntityTemporalList-example.json index 8e157fb..476ff5d 100644 --- a/examples/EntityTemporalList-example.json +++ b/examples/EntityTemporalList-example.json @@ -26,7 +26,7 @@ ], "@context": [ "http://example.org/ngsi-ld/vehicle.jsonld", - "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld" + "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context-v1.3.jsonld" ] } ] diff --git a/examples/Entity_temporalValues_C.5.6.3.json b/examples/Entity_temporalValues_C.5.6.3.json index 353a946..e397df6 100644 --- a/examples/Entity_temporalValues_C.5.6.3.json +++ b/examples/Entity_temporalValues_C.5.6.3.json @@ -29,6 +29,6 @@ }, "@context": [ "http://example.org/ngsi-ld/vehicle.jsonld", - "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld" + "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context-v1.3.jsonld" ] } diff --git a/examples/OffStreetParking_C2.3.json b/examples/OffStreetParking_C2.3.json index 82d5c69..10c28fe 100644 --- a/examples/OffStreetParking_C2.3.json +++ b/examples/OffStreetParking_C2.3.json @@ -31,6 +31,6 @@ }, "@context": [ "http://example.org/ngsi-ld/parking.jsonld", - "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld" + "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context-v1.3.jsonld" ] } diff --git a/examples/OffStreetParking_keyValues_C2.3.json b/examples/OffStreetParking_keyValues_C2.3.json index 8193a51..04f15a3 100644 --- a/examples/OffStreetParking_keyValues_C2.3.json +++ b/examples/OffStreetParking_keyValues_C2.3.json @@ -10,6 +10,6 @@ }, "@context": [ "http://example.org/ngsi-ld/parking.jsonld", - "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld" + "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context-v1.3.jsonld" ] } diff --git a/examples/Subscription-example_C.4.json b/examples/Subscription-example_C.4.json index 44b4ddd..2600f89 100644 --- a/examples/Subscription-example_C.4.json +++ b/examples/Subscription-example_C.4.json @@ -30,6 +30,6 @@ }, "@context": [ "http://example.org/ngsi-ld/vehicle.jsonld", - "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld" + "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context-v1.3.jsonld" ] } diff --git a/examples/SubscriptionList-example.json b/examples/SubscriptionList-example.json index 18e4d52..ca12c8f 100644 --- a/examples/SubscriptionList-example.json +++ b/examples/SubscriptionList-example.json @@ -31,7 +31,7 @@ }, "@context": [ "http://example.org/cim/vehicle.jsonld", - "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld" + "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context-v1.3.jsonld" ] } ] diff --git a/examples/Vehicle_C2.2.json b/examples/Vehicle_C2.2.json index 6b21fe1..dd6d125 100644 --- a/examples/Vehicle_C2.2.json +++ b/examples/Vehicle_C2.2.json @@ -23,6 +23,6 @@ "http://example.org/ngsi-ld/vehicle.jsonld", "http://example.org/ngsi-ld/parking.jsonld", "https://schema.org", - "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld" + "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context-v1.3.jsonld" ] } diff --git a/examples/Vehicle_MultiAttribute_C2.2.json b/examples/Vehicle_MultiAttribute_C2.2.json index e179156..df27bcd 100644 --- a/examples/Vehicle_MultiAttribute_C2.2.json +++ b/examples/Vehicle_MultiAttribute_C2.2.json @@ -25,6 +25,6 @@ "speed#2": "http://example.org/speed", "source": "http://example.org/hasSource" }, - "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld" + "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context-v1.3.jsonld" ] } \ No newline at end of file diff --git a/examples/Vehicle_keyValues_C2.2.json b/examples/Vehicle_keyValues_C2.2.json index c795b9b..ad87a89 100644 --- a/examples/Vehicle_keyValues_C2.2.json +++ b/examples/Vehicle_keyValues_C2.2.json @@ -7,6 +7,6 @@ "http://example.org/ngsi-ld/commonTerms.jsonld", "http://example.org/ngsi-ld/vehicle.jsonld", "http://example.org/ngsi-ld/parking.jsonld", - "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld" + "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context-v1.3.jsonld" ] } diff --git a/jsconfig.json b/jsconfig.json new file mode 100644 index 0000000..36aa1a4 --- /dev/null +++ b/jsconfig.json @@ -0,0 +1,5 @@ +{ + "compilerOptions": { + "baseUrl": "." + } +} diff --git a/package.json b/package.json index dec8275..c816142 100644 --- a/package.json +++ b/package.json @@ -1,14 +1,19 @@ { "name": "ngsi-ld", - "version": "1.0.0", + "version": "1.0.1", "description": "NGSI-LD Schema Compilation", "main": "index.js", "scripts": { - "test": "scripts/validate_schema.sh" + "test": "./scripts/validate_all.sh", + "validate-examples": "./scripts/validate_examples.sh", + "validate-locally": "./scripts/validate_locally.sh", + "validate-online": "./scripts/validate_online.sh", + "validate-schema": "./scripts/validate_schema.sh", + "combine-files": "./scripts/combine_files.sh" }, "repository": { "type": "git", - "url": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD" + "url": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD" }, "keywords": [ "NGSI-LD" @@ -16,6 +21,7 @@ "author": "Jose Manuel Cantera", "license": "ISC", "dependencies": { - "ajv": "^6.5.5" + "ajv": "^6.12.5", + "swagger-cli": "^4.0.4" } } diff --git a/schema/BatchOperationResult.json b/schema/BatchOperationResult.json index d2d8f94..bbc1c35 100644 --- a/schema/BatchOperationResult.json +++ b/schema/BatchOperationResult.json @@ -1,6 +1,6 @@ { "$schema": "http://json-schema.org/schema#", - "$id": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/BatchOperationResult.json", + "$id": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/BatchOperationResult.json", "title": "NGSI-LD Batch Operation Result", "description": "NGSI-LD Batch Operation Result", "definitions": { @@ -10,7 +10,7 @@ "format": "uri" }, "error": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } }, "BatchOperationResult": { diff --git a/schema/Entity.json b/schema/Entity.json index aee077e..98dea4c 100644 --- a/schema/Entity.json +++ b/schema/Entity.json @@ -1,6 +1,6 @@ { "$schema": "http://json-schema.org/schema#", - "$id": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json", + "$id": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json", "title": "NGSI-LD Entity", "description": "NGSI-LD Entity", "definitions": { @@ -29,13 +29,13 @@ ] }, "observedAt": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/observedAt" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/observedAt" }, "createdAt": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/createdAt" + "$ref": "https://forge.etsi.org/rep/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" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/modifiedAt" }, "datasetId": { "$ref": "#/definitions/datasetId" @@ -71,13 +71,13 @@ "format": "uri" }, "observedAt": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/observedAt" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/observedAt" }, "createdAt": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/createdAt" + "$ref": "https://forge.etsi.org/rep/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" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/modifiedAt" }, "datasetId": { "$ref": "#/definitions/datasetId" @@ -109,16 +109,16 @@ "const": "GeoProperty" }, "value": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json#" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json" }, "observedAt": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/observedAt" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/observedAt" }, "createdAt": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/createdAt" + "$ref": "https://forge.etsi.org/rep/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" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/modifiedAt" }, "datasetId": { "$ref": "#/definitions/datasetId" @@ -142,11 +142,11 @@ ] } }, - "EntityFragment": { + "Entity": { "type": "object", "properties": { "@context": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/LdContext" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/LdContext" }, "location": { "$ref": "#/definitions/GeoProperty" @@ -162,15 +162,19 @@ "format": "uri" }, "type": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" }, "createdAt": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/createdAt" + "$ref": "https://forge.etsi.org/rep/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" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/modifiedAt" } }, + "required": [ + "id", + "type" + ], "additionalProperties": { "anyOf": [ { @@ -185,21 +189,8 @@ ] }, "propertyNames": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/PropertyNames" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/PropertyNames" } - }, - "Entity": { - "allOf": [ - { - "required": [ - "id", - "type" - ] - }, - { - "$ref": "#/definitions/EntityFragment" - } - ] } }, "allOf": [ @@ -207,4 +198,4 @@ "$ref": "#/definitions/Entity" } ] -} +} \ No newline at end of file diff --git a/schema/EntityList.json b/schema/EntityList.json index 9490e01..bbe3817 100644 --- a/schema/EntityList.json +++ b/schema/EntityList.json @@ -1,13 +1,13 @@ { "$schema": "http://json-schema.org/schema#", - "$id": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/EntityList.json", + "$id": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/EntityList.json", "title": "NGSI-LD EntityList", "description": "NGSI-LD EntityList", "definitions": { "EntityList": { "type": "array", "items": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/Entity" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/Entity" } } }, diff --git a/schema/Entity_keyValues.json b/schema/Entity_keyValues.json index cfd70b3..c9a0342 100644 --- a/schema/Entity_keyValues.json +++ b/schema/Entity_keyValues.json @@ -1,6 +1,6 @@ { "$schema": "http://json-schema.org/schema#", - "$id": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/Entity_keyValues.json", + "$id": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Entity_keyValues.json", "title": "NGSI-LD Entity Key Values", "description": "NGSI-LD Entity Simplified Representation", "type": "object", @@ -10,25 +10,25 @@ "format": "uri" }, "type": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" }, "@context": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/LdContext" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/LdContext" }, "location": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json#" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json#" }, "observationSpace": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json#" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json#" }, "operationSpace": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json#" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json#" }, "createdAt": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/createdAt" + "$ref": "https://forge.etsi.org/rep/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" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/modifiedAt" } }, "required": [ @@ -45,6 +45,6 @@ ] }, "propertyNames": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/PropertyNames" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/PropertyNames" } } diff --git a/schema/UpdateResult.json b/schema/UpdateResult.json index 8becde0..db692eb 100644 --- a/schema/UpdateResult.json +++ b/schema/UpdateResult.json @@ -1,6 +1,6 @@ { "$schema": "http://json-schema.org/schema#", - "$id": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/UpdateResult.json", + "$id": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/UpdateResult.json", "title": "NGSI-LD Update Result", "description": "NGSI-LD Update Result", "definitions": { diff --git a/schema/common.json b/schema/common.json index add2bb9..29ea54c 100644 --- a/schema/common.json +++ b/schema/common.json @@ -1,6 +1,6 @@ { "$schema": "http://json-schema.org/schema#", - "$id": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json", + "$id": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json", "title": "NGSI-LD Common Definitions", "description": "NGSI-LD Common", "definitions": { @@ -130,16 +130,16 @@ "coordinates": { "oneOf": [ { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json#/definitions/position" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json#/definitions/position" }, { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json#/definitions/positionArray" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json#/definitions/positionArray" }, { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json#/definitions/lineString" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json#/definitions/lineString" }, { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json#/definitions/polygon" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json#/definitions/polygon" } ] }, diff --git a/schema/geometry-schema.json b/schema/geometry-schema.json index 328bb09..ef23a8b 100644 --- a/schema/geometry-schema.json +++ b/schema/geometry-schema.json @@ -1,6 +1,6 @@ { "$schema": "http://json-schema.org/draft-04/schema#", - "$id": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json", + "$id": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json", "title": "geometry", "description": "One geometry as defined by GeoJSON. Licensed as per original source is https://github.com/fge/sample-json-schemas/blob/master/geojson/geometry.json", "type": "object", diff --git a/schema/registrations/ContextSourceNotification.json b/schema/registrations/ContextSourceNotification.json index f94ba2c..b61e6e5 100644 --- a/schema/registrations/ContextSourceNotification.json +++ b/schema/registrations/ContextSourceNotification.json @@ -1,6 +1,6 @@ { "$schema": "http://json-schema.org/schema#", - "$id": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/registrations/ContextSourceNotification.json", + "$id": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/registrations/ContextSourceNotification.json", "title": "NGSI-LD Context Source Notification", "description": "NGSI-LD Context Source Notification", "type": "object", @@ -18,7 +18,7 @@ "format": "uri" }, "@context": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/LdContext" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/LdContext" }, "notifiedAt": { "type": "string", @@ -27,7 +27,7 @@ "data": { "type": "array", "items": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/registrations/ContextSourceRegistration.json#/definitions/ContextSourceRegistration" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/registrations/ContextSourceRegistration.json#/definitions/ContextSourceRegistration" }, "minItems": 1 }, diff --git a/schema/registrations/ContextSourceRegistration.json b/schema/registrations/ContextSourceRegistration.json index 030c30d..0268021 100644 --- a/schema/registrations/ContextSourceRegistration.json +++ b/schema/registrations/ContextSourceRegistration.json @@ -1,6 +1,6 @@ { "$schema": "http://json-schema.org/schema#", - "$id": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/registrations/ContextSourceRegistration.json", + "$id": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/registrations/ContextSourceRegistration.json", "title": "NGSI-LD Context Source Registration", "description": "NGSI-LD Context Source Registration", "definitions": { @@ -16,14 +16,14 @@ "type": "array", "minItems": 1, "items": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/EntityInfo" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/EntityInfo" } }, "properties": { "type": "array", "minItems": 1, "items": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" }, "uniqueItems": true }, @@ -31,7 +31,7 @@ "type": "array", "minItems": 1, "items": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" }, "uniqueItems": true } @@ -57,7 +57,7 @@ "type": "object", "properties": { "@context": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/LdContext" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/LdContext" }, "information": { "type": "array", @@ -73,13 +73,13 @@ "$ref": "#/definitions/TimeInterval" }, "location": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json#" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json#" }, "observationSpace": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json#" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json#" }, "operationSpace": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json#" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json#" }, "expires": { "type": "string", @@ -125,10 +125,10 @@ "const": "ContextSourceRegistration" }, "createdAt": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/createdAt" + "$ref": "https://forge.etsi.org/rep/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" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/modifiedAt" } }, "required": [ diff --git a/schema/registrations/ContextSourceRegistrationList.json b/schema/registrations/ContextSourceRegistrationList.json index 8bb5cd7..0518d7a 100644 --- a/schema/registrations/ContextSourceRegistrationList.json +++ b/schema/registrations/ContextSourceRegistrationList.json @@ -1,13 +1,13 @@ { "$schema": "http://json-schema.org/schema#", - "$id": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/registrations/ContextSourceRegistrationList.json", + "$id": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/registrations/ContextSourceRegistrationList.json", "title": "NGSI-LD Registration List", "description": "NGSI-LD Registration List", "definitions": { "ContextSourceRegistrationList": { "type": "array", "items": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/registrations/ContextSourceRegistration.json#/definitions/ContextSourceRegistration" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/registrations/ContextSourceRegistration.json#/definitions/ContextSourceRegistration" } } }, diff --git a/schema/subscriptions/Notification.json b/schema/subscriptions/Notification.json index 7352cc5..dd16e7f 100644 --- a/schema/subscriptions/Notification.json +++ b/schema/subscriptions/Notification.json @@ -1,6 +1,6 @@ { "$schema": "http://json-schema.org/schema#", - "$id": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/subscriptions/Notification.json", + "$id": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/subscriptions/Notification.json", "title": "NGSI-LD Notification", "description": "NGSI-LD Notification", "type": "object", @@ -18,7 +18,7 @@ "format": "uri" }, "@context": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/LdContext" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/LdContext" }, "notifiedAt": { "type": "string", @@ -27,7 +27,7 @@ "data": { "type": "array", "items": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/Entity" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/Entity" }, "minItems": 1 } diff --git a/schema/subscriptions/Subscription.json b/schema/subscriptions/Subscription.json index 38a8b06..794bf16 100644 --- a/schema/subscriptions/Subscription.json +++ b/schema/subscriptions/Subscription.json @@ -1,6 +1,6 @@ { "$schema": "http://json-schema.org/schema#", - "$id": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/subscriptions/Subscription.json", + "$id": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/subscriptions/Subscription.json", "title": "NGSI-LD Subscription", "description": "NGSI-LD Subscription", "definitions": { @@ -20,7 +20,7 @@ "type": "string" }, "endpoint": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Endpoint" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Endpoint" }, "status": { "type": "string", @@ -59,13 +59,13 @@ ], "properties": { "georel": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/georel" + "$ref": "https://forge.etsi.org/rep/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" + "$ref": "https://forge.etsi.org/rep/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" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/geometry" } } }, @@ -73,12 +73,12 @@ "type": "object", "properties": { "@context": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/LdContext" + "$ref": "https://forge.etsi.org/rep/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" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/EntityInfo" }, "minItems": 1 }, @@ -94,7 +94,7 @@ "type": "array", "minItems": 1, "items": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" }, "uniqueItems": true }, @@ -152,10 +152,10 @@ ] }, "createdAt": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/createdAt" + "$ref": "https://forge.etsi.org/rep/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" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/modifiedAt" } }, "allOf": [ diff --git a/schema/subscriptions/SubscriptionList.json b/schema/subscriptions/SubscriptionList.json index ec06754..750ab3e 100644 --- a/schema/subscriptions/SubscriptionList.json +++ b/schema/subscriptions/SubscriptionList.json @@ -1,13 +1,13 @@ { "$schema": "http://json-schema.org/schema#", - "$id": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/subscriptions/SubscriptionList.json", + "$id": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/subscriptions/SubscriptionList.json", "title": "NGSI-LD Subscription List", "description": "NGSI-LD Subscription List", "definitions": { "SubscriptionList": { "type": "array", "items": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/subscriptions/Subscription.json#/definitions/Subscription" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/subscriptions/Subscription.json#/definitions/Subscription" } } }, diff --git a/schema/temporal/EntityTemporal.json b/schema/temporal/EntityTemporal.json index 14deb30..0cb176d 100644 --- a/schema/temporal/EntityTemporal.json +++ b/schema/temporal/EntityTemporal.json @@ -1,6 +1,6 @@ { "$schema": "http://json-schema.org/schema#", - "$id": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/temporal/EntityTemporal.json", + "$id": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/temporal/EntityTemporal.json", "title": "NGSI-LD Entity", "description": "NGSI-LD Temporal Representation of an Entity", "definitions": { @@ -8,26 +8,26 @@ "type": "object", "properties": { "@context": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/LdContext" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/LdContext" }, "location": { "type": "array", "items": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/GeoProperty" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/GeoProperty" }, "minItems": 1 }, "observationSpace": { "type": "array", "items": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/GeoProperty" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/GeoProperty" }, "minItems": 1 }, "operationSpace": { "type": "array", "items": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/GeoProperty" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/GeoProperty" }, "minItems": 1 }, @@ -36,13 +36,13 @@ "format": "uri" }, "type": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" }, "createdAt": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/createdAt" + "$ref": "https://forge.etsi.org/rep/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" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/modifiedAt" } }, "additionalProperties": { @@ -50,28 +50,28 @@ { "type": "array", "items": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/Property" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/Property" }, "minItems": 1 }, { "type": "array", "items": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/Relationship" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/Relationship" }, "minItems": 1 }, { "type": "array", "items": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/GeoProperty" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/GeoProperty" }, "minItems": 1 } ] }, "propertyNames": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/PropertyNames" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/PropertyNames" } }, "EntityTemporal": { diff --git a/schema/temporal/EntityTemporalList.json b/schema/temporal/EntityTemporalList.json index f942533..0b92be8 100644 --- a/schema/temporal/EntityTemporalList.json +++ b/schema/temporal/EntityTemporalList.json @@ -7,7 +7,7 @@ "EntityTemporalList": { "type": "array", "items": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/temporal/EntityTemporal.json#" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/temporal/EntityTemporal.json#" } } }, diff --git a/schema/temporal/Entity_temporalValues.json b/schema/temporal/Entity_temporalValues.json index 8f5b573..30909c3 100644 --- a/schema/temporal/Entity_temporalValues.json +++ b/schema/temporal/Entity_temporalValues.json @@ -88,16 +88,16 @@ "format": "uri" }, "type": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" }, "@context": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/LdContext" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/LdContext" }, "createdAt": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/createdAt" + "$ref": "https://forge.etsi.org/rep/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" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/modifiedAt" } }, "required": [ @@ -115,6 +115,6 @@ ] }, "propertyNames": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/PropertyNames" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/PropertyNames" } } diff --git a/scripts/combine_files.sh b/scripts/combine_files.sh old mode 100644 new mode 100755 index c182e47..ae94438 --- a/scripts/combine_files.sh +++ b/scripts/combine_files.sh @@ -3,22 +3,11 @@ # Requires install swagger-cli: npm install -g swagger-cli # - -# Store current directory -current_dir=${PWD} - -# Store script directory -script_directory="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" - - -# Move cd to the script directory (the script must be called from the 'script' directory) -cd $script_directory - # Generate a file which combines all the spec files into a unique swagger definition file (maintains references) -swagger-cli bundle ../spec/ngsild_swagger.json -o combined_spec/ngsild_swagger_combined.json +swagger-cli bundle ./spec/updated/ngsi-ld-spec-open-api.json -o ./bundle/ngsild_swagger_combined.json # Generate a file which combines all the spec files into a unique swagger definition file (removes references) -swagger-cli bundle -r ../spec/ngsild_swagger.json -o combined_spec/ngsild_swagger_combined_dereferenced.json - -# Move cd to the directory from where the script was called -cd $current_dir +# working with modified swagger-cli.js to avoid circular ref problem +swagger-cli -d bundle --dereference ./spec/updated/ngsi-ld-spec-open-api.json -o ./bundle/ngsild_swagger_combined_dereferenced.json +# modified version to allow circular ref +# swagger-cli bundle --dereference="ignore" ./spec/updated/ngsi-ld-spec-open-api.json -o ./bundle/ngsild_swagger_combined.json \ No newline at end of file diff --git a/scripts/combined_spec/ngsild_swagger_combined.json b/scripts/combined_spec/ngsild_swagger_combined.json deleted file mode 100644 index 30c1fb4..0000000 --- a/scripts/combined_spec/ngsild_swagger_combined.json +++ /dev/null @@ -1,1672 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "description": "This swagger file describes the NGSI-LD API defined by the ETSI ISG CIM group. This Cross-domain Context Information Management API allows to provide, consume and subscribe to context information in multiple scenarios and involving multiple stakeholders", - "version": "0.0.11", - "title": "ETSI ISG CIM / NGSI-LD API", - "termsOfService": "http://tbd.tbd/tbd/", - "contact": { - "email": "NGSI-LD@etsi.org" - }, - "license": { - "name": "Apache 2.0", - "url": "http://www.apache.org/licenses/LICENSE-2.0.html" - } - }, - "externalDocs": { - "description": "Find out more about the ETSI ISG Context Information Management", - "url": "https://portal.etsi.org/tb.aspx?tbid=854&SubTB=854" - }, - "host": "tbd.tbd.tbd", - "basePath": "/v1", - "tags": [ - { - "name": "ETSI", - "description": "European Telecommunications Standards Institute", - "externalDocs": { - "description": "Find out more", - "url": "http://www.etsi.org" - } - }, - { - "name": "CIM", - "description": "Context Information Management", - "externalDocs": { - "description": "Find out more", - "url": "https://portal.etsi.org/tb.aspx?tbid=854&SubTB=854" - } - }, - { - "name": "OMA", - "description": "Open Mobile Alliance", - "externalDocs": { - "description": "Find out more", - "url": "http://openmobilealliance.org" - } - }, - { - "name": "NSGI", - "description": "Next Generation Service Interfaces", - "externalDocs": { - "description": "Find out more", - "url": "http://www.openmobilealliance.org/release/NGSI/V1_0-20120529-A/OMA-AD-NGSI-V1_0-20120529-A.pdf" - } - }, - { - "name": "FIWARE NSGI v2", - "description": "FIWARE Next Generation Service Interfaces v2", - "externalDocs": { - "description": "Find out more", - "url": "https://orioncontextbroker.docs.apiary.io/#" - } - }, - { - "name": "JSON-LD", - "description": "JSON for Linking Data", - "externalDocs": { - "description": "Find out more", - "url": "https://json-ld.org/" - } - }, - { - "name": "NGSI-LD API", - "description": "API defined by the ETSI ISG CIM", - "externalDocs": { - "description": "Find out more", - "url": "http://www.etsi.org/deliver/etsi_gs/CIM/001_099/004/01.01.01_60/gs_CIM004v010101p.pdf" - } - } - ], - "schemes": [ - "http", - "https" - ], - "paths": { - "/entities": { - "get": { - "description": "Retrieve a set of entities which matches a specific query from an NGSI-LD system", - "operationId": "queryEntities", - "parameters": [ - { - "name": "id", - "description": "Comma separated list of URIs to be retrieved", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "type", - "description": "Comma separated list of Entity type names to be retrieved", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "idPattern", - "description": "Regular expression that must be matched by Entity ids", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "attrs", - "description": "Comma separated list of attribute names (properties or relationships) to be retrieved", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "q", - "description": "Query", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "georel", - "description": "Geo-relationship", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "geometry", - "description": "Geometry", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "coordinates", - "description": "Coordinates serialized as a string", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "geoproperty", - "description": "The name of the property that contains the geo-spatial data that will be used to resolve the geoquery", - "in": "query", - "required": false, - "type": "string" - } - ], - "produces": [ - "application/json", - "application/ld+json" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/200/schema" - } - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - } - } - }, - "post": { - "description": "Create a new Entity within an NGSI-LD system", - "operationId": "createEntity", - "parameters": [ - { - "name": "EntityDescription", - "description": "Payload body in the request contains a JSON-LD object which represents the Entity that is to be created", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uri" - } - } - }, - { - "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs/post/parameters/2/schema/allOf/1" - }, - { - "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs/post/parameters/2/schema/allOf/2" - } - ] - } - } - ], - "consumes": [ - "application/json", - "application/ld+json" - ], - "responses": { - "201": { - "description": "Created. Contains the resource URI of the created Entity", - "schema": { - "type": "string" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - }, - "409": { - "description": "Already exists", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - }, - "422": { - "description": "Unprocessable Entity", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - } - } - } - }, - "/entities/{entityId}": { - "get": { - "description": "Retrieve an specific Entity from an NGSI-LD system. It's possible to specify the Entity attributes to be retrieved by using query parameters", - "operationId": "retrieveEntityById", - "parameters": [ - { - "name": "entityId", - "description": "Id (URI) of the Entity to be retrieved", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "attrs", - "description": "Comma separated list of attribute names (properties or relationships) to be included in the response", - "in": "query", - "required": false, - "type": "string" - } - ], - "produces": [ - "application/json", - "application/ld+json" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string", - "format": "uri" - } - } - }, - { - "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs/post/parameters/2/schema/allOf/1" - }, - { - "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs/post/parameters/2/schema/allOf/2" - }, - { - "$ref": "#/paths/~1csources~1%7BregistrationId%7D/get/responses/200/schema/allOf/1" - } - ] - } - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - }, - "404": { - "description": "Not Found", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - } - } - }, - "delete": { - "description": "Removes an specific Entity from an NGSI-LD system", - "operationId": "removeEntityById", - "parameters": [ - { - "name": "entityId", - "description": "Id (URI) of the Entity to be removed", - "in": "path", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "No Content. The entity was removed successfully" - }, - "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - }, - "404": { - "description": "Not Found", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - } - } - } - }, - "/entities/{entityId}/attrs": { - "post": { - "description": "Append new Entity attributes to an existing Entity within an NGSI-LD system", - "operationId": "appendEntityAttrs", - "parameters": [ - { - "name": "entityId", - "description": "Id (URI) of the Entity where to append new attributes", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "noOverwrite", - "description": "Indicates that no attribute overwrite shall be performed", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "EntityFragment", - "description": "Entity Fragment containing a complete representation of the attributes to be added", - "in": "body", - "required": true, - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs/patch/parameters/1/schema" - } - } - ], - "consumes": [ - "application/json", - "application/ld+json" - ], - "responses": { - "204": { - "description": "No Content. All the attributes were appended successfully" - }, - "207": { - "description": "Multi-Status. Only the attributes included in the response payload were successfully appended", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs/patch/responses/207/schema" - } - }, - "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - }, - "404": { - "description": "Not Found", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - } - } - }, - "patch": { - "description": "Update existing Entity attributes within an NGSI-LD system", - "operationId": "updateEntityAttrs", - "parameters": [ - { - "name": "entityId", - "description": "Id (URI) of the Entity where to update the specified attributes", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "EntityFragment", - "description": "Entity Fragment containing a complete representation of the attributes to be updated", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string", - "format": "uri" - } - } - }, - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "minLength": 1 - } - } - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "location": { - "$ref": "#/paths/~1entities/post/parameters/0/schema/allOf/2/allOf/0/properties/observationSpace" - }, - "observationSpace": { - "allOf": [ - { - "type": "object", - "required": [ - "type", - "value" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "GeoProperty" - ] - }, - "value": { - "$ref": "#/paths/~1csources/post/parameters/0/schema/allOf/1/allOf/0/properties/location" - } - } - }, - { - "type": "object", - "properties": { - "observedAt": { - "type": "string", - "format": "date-time" - } - } - } - ] - }, - "operationSpace": { - "$ref": "#/paths/~1entities/post/parameters/0/schema/allOf/2/allOf/0/properties/observationSpace" - } - } - }, - { - "type": "object", - "properties": { - "@context": { - "type": [ - "string", - "object", - "array" - ] - } - } - } - ] - } - ] - } - } - ], - "consumes": [ - "application/json", - "application/ld+json" - ], - "responses": { - "204": { - "description": "No Content. All the attributes were appended successfully" - }, - "207": { - "description": "Multi-Status. Only the attributes included in the response payload were successfully appended", - "schema": { - "allOf": [ - { - "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs/post/parameters/2/schema/allOf/1" - }, - { - "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs/post/parameters/2/schema/allOf/2" - } - ] - } - }, - "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - }, - "404": { - "description": "Not Found", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - } - } - } - }, - "/entities/{entityId}/attrs/{attrId}": { - "patch": { - "description": "Update existing Entity attributes within an NGSI-LD system", - "operationId": "partialAttrUpdate", - "parameters": [ - { - "name": "entityId", - "description": "Id (URI) of the Entity where to update the specified attribute", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "attrId", - "description": "Attribute name (property or relationship) to be updated", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "EntityFragment", - "description": "Entity Fragment containing the elements of the attribute to be updated", - "in": "body", - "required": true, - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs/patch/parameters/1/schema" - } - } - ], - "consumes": [ - "application/json", - "application/ld+json" - ], - "responses": { - "204": { - "description": "No Content. The attribute was updated successfully" - }, - "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - }, - "404": { - "description": "Not Found", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - } - } - }, - "delete": { - "description": "Removes an existing Entity attribute within an NGSI-LD system", - "operationId": "removeEntityAttr", - "parameters": [ - { - "name": "entityId", - "description": "Id (URI) of the Entity where to remove the specified attribute", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "attrId", - "description": "Attribute name (property or relationship) to be removed", - "in": "path", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "No Content. The attribute was removed successfully" - }, - "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - }, - "404": { - "description": "Not Found", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - } - } - } - }, - "/csources": { - "post": { - "description": "Registers a new context source within an NGSI-LD system", - "operationId": "registerCsource", - "parameters": [ - { - "name": "CsourceRegistrationDescription", - "description": "Payload body in the request contains a JSON-LD object which represents the context source registration that is to be created", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uri" - } - } - }, - { - "$ref": "#/paths/~1csources~1%7BregistrationId%7D/patch/parameters/1/schema/allOf/1" - }, - { - "type": "object", - "required": [ - "endpoint", - "type", - "information" - ], - "properties": { - "endpoint": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "ContextSourceRegistration" - ] - }, - "information": { - "type": "array", - "minItems": 1, - "items": { - "$ref": "#/paths/~1csources~1%7BregistrationId%7D/patch/parameters/1/schema/allOf/0/properties/information/items" - } - } - } - } - ] - } - } - ], - "consumes": [ - "application/json", - "application/ld+json" - ], - "responses": { - "201": { - "description": "Created. Contains the resource URI of the created context source registration resource", - "schema": { - "type": "string" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - }, - "409": { - "description": "Already exists", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - }, - "422": { - "description": "Unprocessable Context Source Registration", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - } - } - }, - "get": { - "description": "Retrieve a set of context sources which matches a specific query from an NGSI-LD system", - "operationId": "queryCsources", - "parameters": [ - { - "name": "id", - "description": "Comma separated list of URIs to be retrieved", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "type", - "description": "Comma separated list of context sources type names to be retrieved", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "idPattern", - "description": "Regular expression that must be matched by context source ids", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "attrs", - "description": "Comma separated list of attribute names (properties or relationships) to be retrieved", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "q", - "description": "Query", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "georel", - "description": "Geo-relationship", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "geometry", - "description": "Geometry", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "coordinates", - "description": "Coordinates serialized as a string", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "geoproperty", - "description": "The name of the property that contains the geo-spatial data that will be used to resolve the geo-query", - "in": "query", - "required": false, - "type": "string" - } - ], - "produces": [ - "application/json", - "application/ld+json" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/paths/~1csources~1%7BregistrationId%7D/get/responses/200/schema" - } - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - } - } - } - }, - "/csources/{registrationId}": { - "get": { - "description": "Retrieves a specific context source registration from an NGSI-LD system", - "operationId": "retrieveCsource", - "parameters": [ - { - "name": "registrationId", - "description": "Id (URI) of the context source registration to be retrieved", - "in": "path", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json", - "application/ld+json" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string", - "format": "uri" - } - } - }, - { - "type": "object", - "properties": { - "createdAt": { - "type": "string", - "format": "date-time" - }, - "modifiedAt": { - "type": "string", - "format": "date-time" - } - } - }, - { - "$ref": "#/paths/~1csources~1%7BregistrationId%7D/patch/parameters/1/schema/allOf/1" - }, - { - "$ref": "#/paths/~1csources/post/parameters/0/schema/allOf/2" - } - ] - } - }, - "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - }, - "404": { - "description": "Not Found", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - } - } - }, - "delete": { - "description": "Removes an specific context source registration within an NGSI-LD system", - "operationId": "removeCsource", - "parameters": [ - { - "name": "registrationId", - "description": "Id (URI) of the context source registration to be removed", - "in": "path", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "No Content. The context source registration was removed successfully" - }, - "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - }, - "404": { - "description": "Not Found", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - } - } - }, - "patch": { - "description": "Updates a specific context source registration within an NGSI-LD system", - "operationId": "updateCsource", - "parameters": [ - { - "name": "registrationId", - "description": "Id (URI) of the context source registration to be updated", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "CsourceRegistrationFragment", - "description": "Payload body in the request contains a JSON-LD object which represents the context source registration that is to be updated", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string", - "format": "uri" - }, - "endpoint": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "ContextSourceRegistration" - ] - }, - "information": { - "type": "array", - "minItems": 1, - "items": { - "type": "object", - "required": [ - "entities" - ], - "properties": { - "entities": { - "type": "array", - "minItems": 1, - "items": { - "$ref": "#/paths/~1subscriptions~1%7BsubscriptionId%7D/patch/parameters/1/schema/allOf/0/properties/entities/items" - } - }, - "properties": { - "type": "array", - "minItems": 1, - "items": { - "type": "string" - }, - "uniqueItems": true - }, - "relationships": { - "type": "array", - "minItems": 1, - "items": { - "type": "string" - }, - "uniqueItems": true - } - } - } - } - } - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "timestamp": { - "type": "array", - "minItems": 1, - "items": { - "type": "object", - "required": [ - "start" - ], - "properties": { - "start": { - "type": "string", - "format": "date-time" - }, - "end": { - "type": "string", - "format": "date-time" - } - } - } - }, - "location": { - "title": "Geometry", - "description": "A geometry is a GeoJSON object where the type member's value is one of the following strings: `Point`, `MultiPoint`, `LineString`, `MultiLineString`, `Polygon`, `MultiPolygon`, or `GeometryCollection`.", - "properties": { - "type": { - "enum": [ - "Point", - "MultiPoint", - "LineString", - "MultiLineString", - "Polygon", - "MultiPolygon", - "GeometryCollection" - ] - } - } - }, - "expires": { - "type": "string", - "format": "date-time" - }, - "name": { - "type": "string", - "minLength": 1 - }, - "description": { - "type": "string", - "minLength": 1 - } - } - }, - { - "$ref": "#/paths/~1entities/post/parameters/0/schema/allOf/2/allOf/1" - } - ] - } - ] - } - } - ], - "consumes": [ - "application/json", - "application/ld+json" - ], - "responses": { - "204": { - "description": "No Content. The context source registration was successfully updated" - }, - "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - }, - "404": { - "description": "Not Found", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - } - } - } - }, - "/subscriptions": { - "post": { - "description": "Creates a new Subscription within an NGSI-LD system", - "operationId": "createSubscription", - "parameters": [ - { - "name": "SubscriptionDescription", - "description": "Payload body in the request contains a JSON-LD object which represents the Subscription that is to be created", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uri" - } - } - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1 - }, - "description": { - "type": "string", - "minLength": 1 - }, - "watchedAttributes": { - "type": "array", - "minItems": 1, - "items": { - "type": "string" - }, - "uniqueItems": true - }, - "timeInterval": { - "type": "number", - "minimum": 0 - }, - "geoQ": { - "type": "object", - "required": [ - "geometry", - "coordinates", - "georel" - ], - "properties": { - "geometry": { - "type": "string" - }, - "coordinates": { - "type": "array", - "minItems": 1, - "items": { - "type": "number" - } - }, - "georel": { - "type": "string" - } - } - }, - "notification": { - "type": "object", - "required": [ - "endpoint" - ], - "properties": { - "attributes": { - "type": "array", - "minItems": 1, - "items": { - "type": "string" - } - }, - "format": { - "type": "string" - }, - "endpoint": { - "type": "object", - "required": [ - "uri" - ], - "properties": { - "uri": { - "type": "string", - "format": "uri" - }, - "accept": { - "type": "string", - "enum": [ - "application/json", - "application/ld+json" - ] - } - } - }, - "timesSent": { - "type": "number", - "minimum": 1 - }, - "lastNotification": { - "type": "string", - "format": "date-time" - }, - "lastFailure": { - "type": "string", - "format": "date-time" - }, - "lastSuccess": { - "type": "string", - "format": "date-time" - } - } - }, - "expires": { - "type": "string", - "format": "date-time" - }, - "status": { - "type": "string", - "enum": [ - "active", - "inactive", - "failed", - "expired" - ] - }, - "throttling": { - "type": "number", - "minimum": 1 - }, - "q": { - "type": "string", - "minLength": 1 - } - } - }, - { - "$ref": "#/paths/~1entities/post/parameters/0/schema/allOf/2/allOf/1" - } - ] - }, - { - "$ref": "#/paths/~1subscriptions~1%7BsubscriptionId%7D/get/responses/200/schema/allOf/3" - } - ] - } - } - ], - "consumes": [ - "application/json", - "application/ld+json" - ], - "responses": { - "201": { - "description": "Created. Contains the resource URI of the created Entity resource", - "schema": { - "type": "string" - } - }, - "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - }, - "409": { - "description": "Already exists", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - } - } - }, - "get": { - "description": "Retrieves the subscriptions available in an NGSI-LD system", - "operationId": "retrieveSubscriptions", - "parameters": [ - { - "name": "limit", - "description": "Maximum number of subscriptions to be retrieved", - "in": "query", - "required": false, - "type": "string" - } - ], - "produces": [ - "application/json", - "application/ld+json" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/paths/~1subscriptions~1%7BsubscriptionId%7D/get/responses/200/schema" - } - } - }, - "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - } - } - } - }, - "/subscriptions/{subscriptionId}": { - "get": { - "description": "Retrieves a specific Subscription from an NGSI-LD system", - "operationId": "retrieveSubscription", - "parameters": [ - { - "name": "subscriptionId", - "description": "Id (URI) of the Subscription to be retrieved", - "in": "path", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json", - "application/ld+json" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string", - "format": "uri" - } - } - }, - { - "$ref": "#/paths/~1csources~1%7BregistrationId%7D/get/responses/200/schema/allOf/1" - }, - { - "$ref": "#/paths/~1subscriptions/post/parameters/0/schema/allOf/1" - }, - { - "type": "object", - "required": [ - "type", - "entities" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "Subscription" - ] - }, - "entities": { - "type": "array", - "minItems": 1, - "items": { - "$ref": "#/paths/~1subscriptions~1%7BsubscriptionId%7D/patch/parameters/1/schema/allOf/0/properties/entities/items" - } - } - } - } - ] - } - }, - "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - }, - "404": { - "description": "Not Found", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - } - } - }, - "delete": { - "description": "Removes a specific Subscription from an NGSI-LD system", - "operationId": "removeSubscription", - "parameters": [ - { - "name": "subscriptionId", - "description": "Id (URI) of the Subscription to be removed", - "in": "path", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "No Content. The Subscription was removed successfully" - }, - "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - }, - "404": { - "description": "Not Found", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - } - } - }, - "patch": { - "description": "Updates a specific Subscription within an NGSI-LD system", - "operationId": "updateSubscription", - "parameters": [ - { - "name": "subscriptionId", - "description": "Id (URI) of the Subscription to be updated", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "SubscriptionFragment", - "description": "Subscription Fragment including id, type and any other Subscription field to be updated", - "in": "body", - "required": true, - "schema": { - "$ref": "#/paths/~1csourceSubscriptions~1%7BsubscriptionId%7D/patch/parameters/1/schema" - } - } - ], - "consumes": [ - "application/json", - "application/ld+json" - ], - "responses": { - "204": { - "description": "No Content. The Subscription was updated successfully" - }, - "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - }, - "404": { - "description": "Not Found", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - } - } - } - }, - "/csourceSubscriptions": { - "post": { - "description": "Creates a context source discovery Subscription within an NGSI-LD system", - "operationId": "createCSourceSubscription", - "parameters": [ - { - "name": "SubscriptionDescription", - "description": "Payload body in the request contains a JSON-LD object which represents the context source discovery Subscription that is to be created", - "in": "body", - "required": true, - "schema": { - "$ref": "#/paths/~1subscriptions/post/parameters/0/schema" - } - } - ], - "consumes": [ - "application/json", - "application/ld+json" - ], - "responses": { - "201": { - "description": "Created. Contains the resource URI of the created context source discovery Subscription resource", - "schema": { - "type": "string" - } - }, - "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - }, - "409": { - "description": "Already exists", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - } - } - }, - "get": { - "description": "Retrieves the context source discovery subscriptions available in an NGSI-LD system", - "operationId": "retrieveCSourceSubscriptions", - "parameters": [ - { - "name": "limit", - "description": "Maximum number of subscriptions to be retrieved", - "in": "query", - "required": false, - "type": "string" - } - ], - "produces": [ - "application/json", - "application/ld+json" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/paths/~1subscriptions/get/responses/200/schema" - } - }, - "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - } - } - } - }, - "/csourceSubscriptions/{subscriptionId}": { - "get": { - "description": "Retrieves a specific context source discovery Subscription from an NGSI-LD system", - "operationId": "retrieveCSourceSubscription", - "parameters": [ - { - "name": "subscriptionId", - "description": "Id (URI) context source discovery Subscription to be retrieved", - "in": "path", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json", - "application/ld+json" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/paths/~1subscriptions~1%7BsubscriptionId%7D/get/responses/200/schema" - } - }, - "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - }, - "404": { - "description": "Not Found", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - } - } - }, - "delete": { - "description": "Removes a specific context source discovery Subscription from an NGSI-LD system", - "operationId": "removeCSourceSubscription", - "parameters": [ - { - "name": "subscriptionId", - "description": "Id (URI) context source discovery Subscription to be removed", - "in": "path", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "No Content. The context source discovery Subscription was removed successfully" - }, - "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - }, - "404": { - "description": "Not Found", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - } - } - }, - "patch": { - "description": "Updates a specific context source discovery Subscription within an NGSI-LD system", - "operationId": "updateCSourceSubscription", - "parameters": [ - { - "name": "subscriptionId", - "description": "Id (URI) context source discovery Subscription to be updated", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "SubscriptionFragment", - "description": "Subscription Fragment including id, type and any other Subscription field to be updated", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Subscription" - ] - }, - "entities": { - "type": "array", - "minItems": 1, - "items": { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string" - }, - "idPattern": { - "type": "string" - }, - "type": { - "type": "string" - } - } - } - } - } - }, - { - "$ref": "#/paths/~1subscriptions/post/parameters/0/schema/allOf/1" - } - ] - } - } - ], - "consumes": [ - "application/json", - "application/ld+json" - ], - "responses": { - "204": { - "description": "No Content. The context source discovery Subscription was updated successfully" - }, - "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - }, - "404": { - "description": "Not Found", - "schema": { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/responses/400/schema" - } - } - } - } - } - } -} diff --git a/scripts/combined_spec/ngsild_swagger_combined_dereferenced.json b/scripts/combined_spec/ngsild_swagger_combined_dereferenced.json deleted file mode 100644 index 3ac1642..0000000 --- a/scripts/combined_spec/ngsild_swagger_combined_dereferenced.json +++ /dev/null @@ -1,5238 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "description": "This swagger file describes the NGSI-LD API defined by the ETSI ISG CIM group. This Cross-domain Context Information Management API allows to provide, consume and subscribe to context information in multiple scenarios and involving multiple stakeholders", - "version": "0.0.11", - "title": "ETSI ISG CIM / NGSI-LD API", - "termsOfService": "http://tbd.tbd/tbd/", - "contact": { - "email": "NGSI-LD@etsi.org" - }, - "license": { - "name": "Apache 2.0", - "url": "http://www.apache.org/licenses/LICENSE-2.0.html" - } - }, - "externalDocs": { - "description": "Find out more about the ETSI ISG Context Information Management", - "url": "https://portal.etsi.org/tb.aspx?tbid=854&SubTB=854" - }, - "host": "tbd.tbd.tbd", - "basePath": "/v1", - "tags": [ - { - "name": "ETSI", - "description": "European Telecommunications Standards Institute", - "externalDocs": { - "description": "Find out more", - "url": "http://www.etsi.org" - } - }, - { - "name": "CIM", - "description": "Context Information Management", - "externalDocs": { - "description": "Find out more", - "url": "https://portal.etsi.org/tb.aspx?tbid=854&SubTB=854" - } - }, - { - "name": "OMA", - "description": "Open Mobile Alliance", - "externalDocs": { - "description": "Find out more", - "url": "http://openmobilealliance.org" - } - }, - { - "name": "NSGI", - "description": "Next Generation Service Interfaces", - "externalDocs": { - "description": "Find out more", - "url": "http://www.openmobilealliance.org/release/NGSI/V1_0-20120529-A/OMA-AD-NGSI-V1_0-20120529-A.pdf" - } - }, - { - "name": "FIWARE NSGI v2", - "description": "FIWARE Next Generation Service Interfaces v2", - "externalDocs": { - "description": "Find out more", - "url": "https://orioncontextbroker.docs.apiary.io/#" - } - }, - { - "name": "JSON-LD", - "description": "JSON for Linking Data", - "externalDocs": { - "description": "Find out more", - "url": "https://json-ld.org/" - } - }, - { - "name": "NGSI-LD API", - "description": "API defined by the ETSI ISG CIM", - "externalDocs": { - "description": "Find out more", - "url": "http://www.etsi.org/deliver/etsi_gs/CIM/001_099/004/01.01.01_60/gs_CIM004v010101p.pdf" - } - } - ], - "schemes": [ - "http", - "https" - ], - "paths": { - "/entities": { - "get": { - "description": "Retrieve a set of entities which matches a specific query from an NGSI-LD system", - "operationId": "queryEntities", - "parameters": [ - { - "name": "id", - "description": "Comma separated list of URIs to be retrieved", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "type", - "description": "Comma separated list of Entity type names to be retrieved", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "idPattern", - "description": "Regular expression that must be matched by Entity ids", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "attrs", - "description": "Comma separated list of attribute names (properties or relationships) to be retrieved", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "q", - "description": "Query", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "georel", - "description": "Geo-relationship", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "geometry", - "description": "Geometry", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "coordinates", - "description": "Coordinates serialized as a string", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "geoproperty", - "description": "The name of the property that contains the geo-spatial data that will be used to resolve the geoquery", - "in": "query", - "required": false, - "type": "string" - } - ], - "produces": [ - "application/json", - "application/ld+json" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "allOf": [ - { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string", - "format": "uri" - } - } - }, - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "minLength": 1 - } - } - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "location": { - "allOf": [ - { - "type": "object", - "required": [ - "type", - "value" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "GeoProperty" - ] - }, - "value": { - "title": "Geometry", - "description": "A geometry is a GeoJSON object where the type member's value is one of the following strings: `Point`, `MultiPoint`, `LineString`, `MultiLineString`, `Polygon`, `MultiPolygon`, or `GeometryCollection`.", - "properties": { - "type": { - "enum": [ - "Point", - "MultiPoint", - "LineString", - "MultiLineString", - "Polygon", - "MultiPolygon", - "GeometryCollection" - ] - } - } - } - } - }, - { - "type": "object", - "properties": { - "observedAt": { - "type": "string", - "format": "date-time" - } - } - } - ] - }, - "observationSpace": { - "allOf": [ - { - "type": "object", - "required": [ - "type", - "value" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "GeoProperty" - ] - }, - "value": { - "title": "Geometry", - "description": "A geometry is a GeoJSON object where the type member's value is one of the following strings: `Point`, `MultiPoint`, `LineString`, `MultiLineString`, `Polygon`, `MultiPolygon`, or `GeometryCollection`.", - "properties": { - "type": { - "enum": [ - "Point", - "MultiPoint", - "LineString", - "MultiLineString", - "Polygon", - "MultiPolygon", - "GeometryCollection" - ] - } - } - } - } - }, - { - "type": "object", - "properties": { - "observedAt": { - "type": "string", - "format": "date-time" - } - } - } - ] - }, - "operationSpace": { - "allOf": [ - { - "type": "object", - "required": [ - "type", - "value" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "GeoProperty" - ] - }, - "value": { - "title": "Geometry", - "description": "A geometry is a GeoJSON object where the type member's value is one of the following strings: `Point`, `MultiPoint`, `LineString`, `MultiLineString`, `Polygon`, `MultiPolygon`, or `GeometryCollection`.", - "properties": { - "type": { - "enum": [ - "Point", - "MultiPoint", - "LineString", - "MultiLineString", - "Polygon", - "MultiPolygon", - "GeometryCollection" - ] - } - } - } - } - }, - { - "type": "object", - "properties": { - "observedAt": { - "type": "string", - "format": "date-time" - } - } - } - ] - } - } - }, - { - "type": "object", - "properties": { - "@context": { - "type": [ - "string", - "object", - "array" - ] - } - } - } - ] - }, - { - "type": "object", - "properties": { - "createdAt": { - "type": "string", - "format": "date-time" - }, - "modifiedAt": { - "type": "string", - "format": "date-time" - } - } - } - ] - } - } - }, - "400": { - "description": "Bad request", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - } - } - }, - "post": { - "description": "Create a new Entity within an NGSI-LD system", - "operationId": "createEntity", - "parameters": [ - { - "name": "EntityDescription", - "description": "Payload body in the request contains a JSON-LD object which represents the Entity that is to be created", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uri" - } - } - }, - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "minLength": 1 - } - } - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "location": { - "allOf": [ - { - "type": "object", - "required": [ - "type", - "value" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "GeoProperty" - ] - }, - "value": { - "title": "Geometry", - "description": "A geometry is a GeoJSON object where the type member's value is one of the following strings: `Point`, `MultiPoint`, `LineString`, `MultiLineString`, `Polygon`, `MultiPolygon`, or `GeometryCollection`.", - "properties": { - "type": { - "enum": [ - "Point", - "MultiPoint", - "LineString", - "MultiLineString", - "Polygon", - "MultiPolygon", - "GeometryCollection" - ] - } - } - } - } - }, - { - "type": "object", - "properties": { - "observedAt": { - "type": "string", - "format": "date-time" - } - } - } - ] - }, - "observationSpace": { - "allOf": [ - { - "type": "object", - "required": [ - "type", - "value" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "GeoProperty" - ] - }, - "value": { - "title": "Geometry", - "description": "A geometry is a GeoJSON object where the type member's value is one of the following strings: `Point`, `MultiPoint`, `LineString`, `MultiLineString`, `Polygon`, `MultiPolygon`, or `GeometryCollection`.", - "properties": { - "type": { - "enum": [ - "Point", - "MultiPoint", - "LineString", - "MultiLineString", - "Polygon", - "MultiPolygon", - "GeometryCollection" - ] - } - } - } - } - }, - { - "type": "object", - "properties": { - "observedAt": { - "type": "string", - "format": "date-time" - } - } - } - ] - }, - "operationSpace": { - "allOf": [ - { - "type": "object", - "required": [ - "type", - "value" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "GeoProperty" - ] - }, - "value": { - "title": "Geometry", - "description": "A geometry is a GeoJSON object where the type member's value is one of the following strings: `Point`, `MultiPoint`, `LineString`, `MultiLineString`, `Polygon`, `MultiPolygon`, or `GeometryCollection`.", - "properties": { - "type": { - "enum": [ - "Point", - "MultiPoint", - "LineString", - "MultiLineString", - "Polygon", - "MultiPolygon", - "GeometryCollection" - ] - } - } - } - } - }, - { - "type": "object", - "properties": { - "observedAt": { - "type": "string", - "format": "date-time" - } - } - } - ] - } - } - }, - { - "type": "object", - "properties": { - "@context": { - "type": [ - "string", - "object", - "array" - ] - } - } - } - ] - } - ] - } - } - ], - "consumes": [ - "application/json", - "application/ld+json" - ], - "responses": { - "201": { - "description": "Created. Contains the resource URI of the created Entity", - "schema": { - "type": "string" - } - }, - "400": { - "description": "Bad request", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - }, - "409": { - "description": "Already exists", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - }, - "422": { - "description": "Unprocessable Entity", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - } - } - } - }, - "/entities/{entityId}": { - "get": { - "description": "Retrieve an specific Entity from an NGSI-LD system. It's possible to specify the Entity attributes to be retrieved by using query parameters", - "operationId": "retrieveEntityById", - "parameters": [ - { - "name": "entityId", - "description": "Id (URI) of the Entity to be retrieved", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "attrs", - "description": "Comma separated list of attribute names (properties or relationships) to be included in the response", - "in": "query", - "required": false, - "type": "string" - } - ], - "produces": [ - "application/json", - "application/ld+json" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string", - "format": "uri" - } - } - }, - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "minLength": 1 - } - } - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "location": { - "allOf": [ - { - "type": "object", - "required": [ - "type", - "value" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "GeoProperty" - ] - }, - "value": { - "title": "Geometry", - "description": "A geometry is a GeoJSON object where the type member's value is one of the following strings: `Point`, `MultiPoint`, `LineString`, `MultiLineString`, `Polygon`, `MultiPolygon`, or `GeometryCollection`.", - "properties": { - "type": { - "enum": [ - "Point", - "MultiPoint", - "LineString", - "MultiLineString", - "Polygon", - "MultiPolygon", - "GeometryCollection" - ] - } - } - } - } - }, - { - "type": "object", - "properties": { - "observedAt": { - "type": "string", - "format": "date-time" - } - } - } - ] - }, - "observationSpace": { - "allOf": [ - { - "type": "object", - "required": [ - "type", - "value" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "GeoProperty" - ] - }, - "value": { - "title": "Geometry", - "description": "A geometry is a GeoJSON object where the type member's value is one of the following strings: `Point`, `MultiPoint`, `LineString`, `MultiLineString`, `Polygon`, `MultiPolygon`, or `GeometryCollection`.", - "properties": { - "type": { - "enum": [ - "Point", - "MultiPoint", - "LineString", - "MultiLineString", - "Polygon", - "MultiPolygon", - "GeometryCollection" - ] - } - } - } - } - }, - { - "type": "object", - "properties": { - "observedAt": { - "type": "string", - "format": "date-time" - } - } - } - ] - }, - "operationSpace": { - "allOf": [ - { - "type": "object", - "required": [ - "type", - "value" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "GeoProperty" - ] - }, - "value": { - "title": "Geometry", - "description": "A geometry is a GeoJSON object where the type member's value is one of the following strings: `Point`, `MultiPoint`, `LineString`, `MultiLineString`, `Polygon`, `MultiPolygon`, or `GeometryCollection`.", - "properties": { - "type": { - "enum": [ - "Point", - "MultiPoint", - "LineString", - "MultiLineString", - "Polygon", - "MultiPolygon", - "GeometryCollection" - ] - } - } - } - } - }, - { - "type": "object", - "properties": { - "observedAt": { - "type": "string", - "format": "date-time" - } - } - } - ] - } - } - }, - { - "type": "object", - "properties": { - "@context": { - "type": [ - "string", - "object", - "array" - ] - } - } - } - ] - }, - { - "type": "object", - "properties": { - "createdAt": { - "type": "string", - "format": "date-time" - }, - "modifiedAt": { - "type": "string", - "format": "date-time" - } - } - } - ] - } - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - }, - "404": { - "description": "Not Found", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - } - } - }, - "delete": { - "description": "Removes an specific Entity from an NGSI-LD system", - "operationId": "removeEntityById", - "parameters": [ - { - "name": "entityId", - "description": "Id (URI) of the Entity to be removed", - "in": "path", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "No Content. The entity was removed successfully" - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - }, - "404": { - "description": "Not Found", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - } - } - } - }, - "/entities/{entityId}/attrs": { - "post": { - "description": "Append new Entity attributes to an existing Entity within an NGSI-LD system", - "operationId": "appendEntityAttrs", - "parameters": [ - { - "name": "entityId", - "description": "Id (URI) of the Entity where to append new attributes", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "noOverwrite", - "description": "Indicates that no attribute overwrite shall be performed", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "EntityFragment", - "description": "Entity Fragment containing a complete representation of the attributes to be added", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string", - "format": "uri" - } - } - }, - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "minLength": 1 - } - } - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "location": { - "allOf": [ - { - "type": "object", - "required": [ - "type", - "value" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "GeoProperty" - ] - }, - "value": { - "title": "Geometry", - "description": "A geometry is a GeoJSON object where the type member's value is one of the following strings: `Point`, `MultiPoint`, `LineString`, `MultiLineString`, `Polygon`, `MultiPolygon`, or `GeometryCollection`.", - "properties": { - "type": { - "enum": [ - "Point", - "MultiPoint", - "LineString", - "MultiLineString", - "Polygon", - "MultiPolygon", - "GeometryCollection" - ] - } - } - } - } - }, - { - "type": "object", - "properties": { - "observedAt": { - "type": "string", - "format": "date-time" - } - } - } - ] - }, - "observationSpace": { - "allOf": [ - { - "type": "object", - "required": [ - "type", - "value" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "GeoProperty" - ] - }, - "value": { - "title": "Geometry", - "description": "A geometry is a GeoJSON object where the type member's value is one of the following strings: `Point`, `MultiPoint`, `LineString`, `MultiLineString`, `Polygon`, `MultiPolygon`, or `GeometryCollection`.", - "properties": { - "type": { - "enum": [ - "Point", - "MultiPoint", - "LineString", - "MultiLineString", - "Polygon", - "MultiPolygon", - "GeometryCollection" - ] - } - } - } - } - }, - { - "type": "object", - "properties": { - "observedAt": { - "type": "string", - "format": "date-time" - } - } - } - ] - }, - "operationSpace": { - "allOf": [ - { - "type": "object", - "required": [ - "type", - "value" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "GeoProperty" - ] - }, - "value": { - "title": "Geometry", - "description": "A geometry is a GeoJSON object where the type member's value is one of the following strings: `Point`, `MultiPoint`, `LineString`, `MultiLineString`, `Polygon`, `MultiPolygon`, or `GeometryCollection`.", - "properties": { - "type": { - "enum": [ - "Point", - "MultiPoint", - "LineString", - "MultiLineString", - "Polygon", - "MultiPolygon", - "GeometryCollection" - ] - } - } - } - } - }, - { - "type": "object", - "properties": { - "observedAt": { - "type": "string", - "format": "date-time" - } - } - } - ] - } - } - }, - { - "type": "object", - "properties": { - "@context": { - "type": [ - "string", - "object", - "array" - ] - } - } - } - ] - } - ] - } - } - ], - "consumes": [ - "application/json", - "application/ld+json" - ], - "responses": { - "204": { - "description": "No Content. All the attributes were appended successfully" - }, - "207": { - "description": "Multi-Status. Only the attributes included in the response payload were successfully appended", - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "minLength": 1 - } - } - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "location": { - "allOf": [ - { - "type": "object", - "required": [ - "type", - "value" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "GeoProperty" - ] - }, - "value": { - "title": "Geometry", - "description": "A geometry is a GeoJSON object where the type member's value is one of the following strings: `Point`, `MultiPoint`, `LineString`, `MultiLineString`, `Polygon`, `MultiPolygon`, or `GeometryCollection`.", - "properties": { - "type": { - "enum": [ - "Point", - "MultiPoint", - "LineString", - "MultiLineString", - "Polygon", - "MultiPolygon", - "GeometryCollection" - ] - } - } - } - } - }, - { - "type": "object", - "properties": { - "observedAt": { - "type": "string", - "format": "date-time" - } - } - } - ] - }, - "observationSpace": { - "allOf": [ - { - "type": "object", - "required": [ - "type", - "value" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "GeoProperty" - ] - }, - "value": { - "title": "Geometry", - "description": "A geometry is a GeoJSON object where the type member's value is one of the following strings: `Point`, `MultiPoint`, `LineString`, `MultiLineString`, `Polygon`, `MultiPolygon`, or `GeometryCollection`.", - "properties": { - "type": { - "enum": [ - "Point", - "MultiPoint", - "LineString", - "MultiLineString", - "Polygon", - "MultiPolygon", - "GeometryCollection" - ] - } - } - } - } - }, - { - "type": "object", - "properties": { - "observedAt": { - "type": "string", - "format": "date-time" - } - } - } - ] - }, - "operationSpace": { - "allOf": [ - { - "type": "object", - "required": [ - "type", - "value" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "GeoProperty" - ] - }, - "value": { - "title": "Geometry", - "description": "A geometry is a GeoJSON object where the type member's value is one of the following strings: `Point`, `MultiPoint`, `LineString`, `MultiLineString`, `Polygon`, `MultiPolygon`, or `GeometryCollection`.", - "properties": { - "type": { - "enum": [ - "Point", - "MultiPoint", - "LineString", - "MultiLineString", - "Polygon", - "MultiPolygon", - "GeometryCollection" - ] - } - } - } - } - }, - { - "type": "object", - "properties": { - "observedAt": { - "type": "string", - "format": "date-time" - } - } - } - ] - } - } - }, - { - "type": "object", - "properties": { - "@context": { - "type": [ - "string", - "object", - "array" - ] - } - } - } - ] - } - ] - } - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - }, - "404": { - "description": "Not Found", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - } - } - }, - "patch": { - "description": "Update existing Entity attributes within an NGSI-LD system", - "operationId": "updateEntityAttrs", - "parameters": [ - { - "name": "entityId", - "description": "Id (URI) of the Entity where to update the specified attributes", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "EntityFragment", - "description": "Entity Fragment containing a complete representation of the attributes to be updated", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string", - "format": "uri" - } - } - }, - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "minLength": 1 - } - } - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "location": { - "allOf": [ - { - "type": "object", - "required": [ - "type", - "value" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "GeoProperty" - ] - }, - "value": { - "title": "Geometry", - "description": "A geometry is a GeoJSON object where the type member's value is one of the following strings: `Point`, `MultiPoint`, `LineString`, `MultiLineString`, `Polygon`, `MultiPolygon`, or `GeometryCollection`.", - "properties": { - "type": { - "enum": [ - "Point", - "MultiPoint", - "LineString", - "MultiLineString", - "Polygon", - "MultiPolygon", - "GeometryCollection" - ] - } - } - } - } - }, - { - "type": "object", - "properties": { - "observedAt": { - "type": "string", - "format": "date-time" - } - } - } - ] - }, - "observationSpace": { - "allOf": [ - { - "type": "object", - "required": [ - "type", - "value" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "GeoProperty" - ] - }, - "value": { - "title": "Geometry", - "description": "A geometry is a GeoJSON object where the type member's value is one of the following strings: `Point`, `MultiPoint`, `LineString`, `MultiLineString`, `Polygon`, `MultiPolygon`, or `GeometryCollection`.", - "properties": { - "type": { - "enum": [ - "Point", - "MultiPoint", - "LineString", - "MultiLineString", - "Polygon", - "MultiPolygon", - "GeometryCollection" - ] - } - } - } - } - }, - { - "type": "object", - "properties": { - "observedAt": { - "type": "string", - "format": "date-time" - } - } - } - ] - }, - "operationSpace": { - "allOf": [ - { - "type": "object", - "required": [ - "type", - "value" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "GeoProperty" - ] - }, - "value": { - "title": "Geometry", - "description": "A geometry is a GeoJSON object where the type member's value is one of the following strings: `Point`, `MultiPoint`, `LineString`, `MultiLineString`, `Polygon`, `MultiPolygon`, or `GeometryCollection`.", - "properties": { - "type": { - "enum": [ - "Point", - "MultiPoint", - "LineString", - "MultiLineString", - "Polygon", - "MultiPolygon", - "GeometryCollection" - ] - } - } - } - } - }, - { - "type": "object", - "properties": { - "observedAt": { - "type": "string", - "format": "date-time" - } - } - } - ] - } - } - }, - { - "type": "object", - "properties": { - "@context": { - "type": [ - "string", - "object", - "array" - ] - } - } - } - ] - } - ] - } - } - ], - "consumes": [ - "application/json", - "application/ld+json" - ], - "responses": { - "204": { - "description": "No Content. All the attributes were appended successfully" - }, - "207": { - "description": "Multi-Status. Only the attributes included in the response payload were successfully appended", - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "minLength": 1 - } - } - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "location": { - "allOf": [ - { - "type": "object", - "required": [ - "type", - "value" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "GeoProperty" - ] - }, - "value": { - "title": "Geometry", - "description": "A geometry is a GeoJSON object where the type member's value is one of the following strings: `Point`, `MultiPoint`, `LineString`, `MultiLineString`, `Polygon`, `MultiPolygon`, or `GeometryCollection`.", - "properties": { - "type": { - "enum": [ - "Point", - "MultiPoint", - "LineString", - "MultiLineString", - "Polygon", - "MultiPolygon", - "GeometryCollection" - ] - } - } - } - } - }, - { - "type": "object", - "properties": { - "observedAt": { - "type": "string", - "format": "date-time" - } - } - } - ] - }, - "observationSpace": { - "allOf": [ - { - "type": "object", - "required": [ - "type", - "value" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "GeoProperty" - ] - }, - "value": { - "title": "Geometry", - "description": "A geometry is a GeoJSON object where the type member's value is one of the following strings: `Point`, `MultiPoint`, `LineString`, `MultiLineString`, `Polygon`, `MultiPolygon`, or `GeometryCollection`.", - "properties": { - "type": { - "enum": [ - "Point", - "MultiPoint", - "LineString", - "MultiLineString", - "Polygon", - "MultiPolygon", - "GeometryCollection" - ] - } - } - } - } - }, - { - "type": "object", - "properties": { - "observedAt": { - "type": "string", - "format": "date-time" - } - } - } - ] - }, - "operationSpace": { - "allOf": [ - { - "type": "object", - "required": [ - "type", - "value" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "GeoProperty" - ] - }, - "value": { - "title": "Geometry", - "description": "A geometry is a GeoJSON object where the type member's value is one of the following strings: `Point`, `MultiPoint`, `LineString`, `MultiLineString`, `Polygon`, `MultiPolygon`, or `GeometryCollection`.", - "properties": { - "type": { - "enum": [ - "Point", - "MultiPoint", - "LineString", - "MultiLineString", - "Polygon", - "MultiPolygon", - "GeometryCollection" - ] - } - } - } - } - }, - { - "type": "object", - "properties": { - "observedAt": { - "type": "string", - "format": "date-time" - } - } - } - ] - } - } - }, - { - "type": "object", - "properties": { - "@context": { - "type": [ - "string", - "object", - "array" - ] - } - } - } - ] - } - ] - } - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - }, - "404": { - "description": "Not Found", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - } - } - } - }, - "/entities/{entityId}/attrs/{attrId}": { - "patch": { - "description": "Update existing Entity attributes within an NGSI-LD system", - "operationId": "partialAttrUpdate", - "parameters": [ - { - "name": "entityId", - "description": "Id (URI) of the Entity where to update the specified attribute", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "attrId", - "description": "Attribute name (property or relationship) to be updated", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "EntityFragment", - "description": "Entity Fragment containing the elements of the attribute to be updated", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string", - "format": "uri" - } - } - }, - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "minLength": 1 - } - } - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "location": { - "allOf": [ - { - "type": "object", - "required": [ - "type", - "value" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "GeoProperty" - ] - }, - "value": { - "title": "Geometry", - "description": "A geometry is a GeoJSON object where the type member's value is one of the following strings: `Point`, `MultiPoint`, `LineString`, `MultiLineString`, `Polygon`, `MultiPolygon`, or `GeometryCollection`.", - "properties": { - "type": { - "enum": [ - "Point", - "MultiPoint", - "LineString", - "MultiLineString", - "Polygon", - "MultiPolygon", - "GeometryCollection" - ] - } - } - } - } - }, - { - "type": "object", - "properties": { - "observedAt": { - "type": "string", - "format": "date-time" - } - } - } - ] - }, - "observationSpace": { - "allOf": [ - { - "type": "object", - "required": [ - "type", - "value" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "GeoProperty" - ] - }, - "value": { - "title": "Geometry", - "description": "A geometry is a GeoJSON object where the type member's value is one of the following strings: `Point`, `MultiPoint`, `LineString`, `MultiLineString`, `Polygon`, `MultiPolygon`, or `GeometryCollection`.", - "properties": { - "type": { - "enum": [ - "Point", - "MultiPoint", - "LineString", - "MultiLineString", - "Polygon", - "MultiPolygon", - "GeometryCollection" - ] - } - } - } - } - }, - { - "type": "object", - "properties": { - "observedAt": { - "type": "string", - "format": "date-time" - } - } - } - ] - }, - "operationSpace": { - "allOf": [ - { - "type": "object", - "required": [ - "type", - "value" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "GeoProperty" - ] - }, - "value": { - "title": "Geometry", - "description": "A geometry is a GeoJSON object where the type member's value is one of the following strings: `Point`, `MultiPoint`, `LineString`, `MultiLineString`, `Polygon`, `MultiPolygon`, or `GeometryCollection`.", - "properties": { - "type": { - "enum": [ - "Point", - "MultiPoint", - "LineString", - "MultiLineString", - "Polygon", - "MultiPolygon", - "GeometryCollection" - ] - } - } - } - } - }, - { - "type": "object", - "properties": { - "observedAt": { - "type": "string", - "format": "date-time" - } - } - } - ] - } - } - }, - { - "type": "object", - "properties": { - "@context": { - "type": [ - "string", - "object", - "array" - ] - } - } - } - ] - } - ] - } - } - ], - "consumes": [ - "application/json", - "application/ld+json" - ], - "responses": { - "204": { - "description": "No Content. The attribute was updated successfully" - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - }, - "404": { - "description": "Not Found", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - } - } - }, - "delete": { - "description": "Removes an existing Entity attribute within an NGSI-LD system", - "operationId": "removeEntityAttr", - "parameters": [ - { - "name": "entityId", - "description": "Id (URI) of the Entity where to remove the specified attribute", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "attrId", - "description": "Attribute name (property or relationship) to be removed", - "in": "path", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "No Content. The attribute was removed successfully" - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - }, - "404": { - "description": "Not Found", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - } - } - } - }, - "/csources": { - "post": { - "description": "Registers a new context source within an NGSI-LD system", - "operationId": "registerCsource", - "parameters": [ - { - "name": "CsourceRegistrationDescription", - "description": "Payload body in the request contains a JSON-LD object which represents the context source registration that is to be created", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uri" - } - } - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "timestamp": { - "type": "array", - "minItems": 1, - "items": { - "type": "object", - "required": [ - "start" - ], - "properties": { - "start": { - "type": "string", - "format": "date-time" - }, - "end": { - "type": "string", - "format": "date-time" - } - } - } - }, - "location": { - "title": "Geometry", - "description": "A geometry is a GeoJSON object where the type member's value is one of the following strings: `Point`, `MultiPoint`, `LineString`, `MultiLineString`, `Polygon`, `MultiPolygon`, or `GeometryCollection`.", - "properties": { - "type": { - "enum": [ - "Point", - "MultiPoint", - "LineString", - "MultiLineString", - "Polygon", - "MultiPolygon", - "GeometryCollection" - ] - } - } - }, - "expires": { - "type": "string", - "format": "date-time" - }, - "name": { - "type": "string", - "minLength": 1 - }, - "description": { - "type": "string", - "minLength": 1 - } - } - }, - { - "type": "object", - "properties": { - "@context": { - "type": [ - "string", - "object", - "array" - ] - } - } - } - ] - }, - { - "type": "object", - "required": [ - "endpoint", - "type", - "information" - ], - "properties": { - "endpoint": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "ContextSourceRegistration" - ] - }, - "information": { - "type": "array", - "minItems": 1, - "items": { - "type": "object", - "required": [ - "entities" - ], - "properties": { - "entities": { - "type": "array", - "minItems": 1, - "items": { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string" - }, - "idPattern": { - "type": "string" - }, - "type": { - "type": "string" - } - } - } - }, - "properties": { - "type": "array", - "minItems": 1, - "items": { - "type": "string" - }, - "uniqueItems": true - }, - "relationships": { - "type": "array", - "minItems": 1, - "items": { - "type": "string" - }, - "uniqueItems": true - } - } - } - } - } - } - ] - } - } - ], - "consumes": [ - "application/json", - "application/ld+json" - ], - "responses": { - "201": { - "description": "Created. Contains the resource URI of the created context source registration resource", - "schema": { - "type": "string" - } - }, - "400": { - "description": "Bad request", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - }, - "409": { - "description": "Already exists", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - }, - "422": { - "description": "Unprocessable Context Source Registration", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - } - } - }, - "get": { - "description": "Retrieve a set of context sources which matches a specific query from an NGSI-LD system", - "operationId": "queryCsources", - "parameters": [ - { - "name": "id", - "description": "Comma separated list of URIs to be retrieved", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "type", - "description": "Comma separated list of context sources type names to be retrieved", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "idPattern", - "description": "Regular expression that must be matched by context source ids", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "attrs", - "description": "Comma separated list of attribute names (properties or relationships) to be retrieved", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "q", - "description": "Query", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "georel", - "description": "Geo-relationship", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "geometry", - "description": "Geometry", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "coordinates", - "description": "Coordinates serialized as a string", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "geoproperty", - "description": "The name of the property that contains the geo-spatial data that will be used to resolve the geo-query", - "in": "query", - "required": false, - "type": "string" - } - ], - "produces": [ - "application/json", - "application/ld+json" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "allOf": [ - { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string", - "format": "uri" - } - } - }, - { - "type": "object", - "properties": { - "createdAt": { - "type": "string", - "format": "date-time" - }, - "modifiedAt": { - "type": "string", - "format": "date-time" - } - } - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "timestamp": { - "type": "array", - "minItems": 1, - "items": { - "type": "object", - "required": [ - "start" - ], - "properties": { - "start": { - "type": "string", - "format": "date-time" - }, - "end": { - "type": "string", - "format": "date-time" - } - } - } - }, - "location": { - "title": "Geometry", - "description": "A geometry is a GeoJSON object where the type member's value is one of the following strings: `Point`, `MultiPoint`, `LineString`, `MultiLineString`, `Polygon`, `MultiPolygon`, or `GeometryCollection`.", - "properties": { - "type": { - "enum": [ - "Point", - "MultiPoint", - "LineString", - "MultiLineString", - "Polygon", - "MultiPolygon", - "GeometryCollection" - ] - } - } - }, - "expires": { - "type": "string", - "format": "date-time" - }, - "name": { - "type": "string", - "minLength": 1 - }, - "description": { - "type": "string", - "minLength": 1 - } - } - }, - { - "type": "object", - "properties": { - "@context": { - "type": [ - "string", - "object", - "array" - ] - } - } - } - ] - }, - { - "type": "object", - "required": [ - "endpoint", - "type", - "information" - ], - "properties": { - "endpoint": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "ContextSourceRegistration" - ] - }, - "information": { - "type": "array", - "minItems": 1, - "items": { - "type": "object", - "required": [ - "entities" - ], - "properties": { - "entities": { - "type": "array", - "minItems": 1, - "items": { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string" - }, - "idPattern": { - "type": "string" - }, - "type": { - "type": "string" - } - } - } - }, - "properties": { - "type": "array", - "minItems": 1, - "items": { - "type": "string" - }, - "uniqueItems": true - }, - "relationships": { - "type": "array", - "minItems": 1, - "items": { - "type": "string" - }, - "uniqueItems": true - } - } - } - } - } - } - ] - } - } - }, - "400": { - "description": "Bad request", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - } - } - } - }, - "/csources/{registrationId}": { - "get": { - "description": "Retrieves a specific context source registration from an NGSI-LD system", - "operationId": "retrieveCsource", - "parameters": [ - { - "name": "registrationId", - "description": "Id (URI) of the context source registration to be retrieved", - "in": "path", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json", - "application/ld+json" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string", - "format": "uri" - } - } - }, - { - "type": "object", - "properties": { - "createdAt": { - "type": "string", - "format": "date-time" - }, - "modifiedAt": { - "type": "string", - "format": "date-time" - } - } - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "timestamp": { - "type": "array", - "minItems": 1, - "items": { - "type": "object", - "required": [ - "start" - ], - "properties": { - "start": { - "type": "string", - "format": "date-time" - }, - "end": { - "type": "string", - "format": "date-time" - } - } - } - }, - "location": { - "title": "Geometry", - "description": "A geometry is a GeoJSON object where the type member's value is one of the following strings: `Point`, `MultiPoint`, `LineString`, `MultiLineString`, `Polygon`, `MultiPolygon`, or `GeometryCollection`.", - "properties": { - "type": { - "enum": [ - "Point", - "MultiPoint", - "LineString", - "MultiLineString", - "Polygon", - "MultiPolygon", - "GeometryCollection" - ] - } - } - }, - "expires": { - "type": "string", - "format": "date-time" - }, - "name": { - "type": "string", - "minLength": 1 - }, - "description": { - "type": "string", - "minLength": 1 - } - } - }, - { - "type": "object", - "properties": { - "@context": { - "type": [ - "string", - "object", - "array" - ] - } - } - } - ] - }, - { - "type": "object", - "required": [ - "endpoint", - "type", - "information" - ], - "properties": { - "endpoint": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "ContextSourceRegistration" - ] - }, - "information": { - "type": "array", - "minItems": 1, - "items": { - "type": "object", - "required": [ - "entities" - ], - "properties": { - "entities": { - "type": "array", - "minItems": 1, - "items": { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string" - }, - "idPattern": { - "type": "string" - }, - "type": { - "type": "string" - } - } - } - }, - "properties": { - "type": "array", - "minItems": 1, - "items": { - "type": "string" - }, - "uniqueItems": true - }, - "relationships": { - "type": "array", - "minItems": 1, - "items": { - "type": "string" - }, - "uniqueItems": true - } - } - } - } - } - } - ] - } - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - }, - "404": { - "description": "Not Found", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - } - } - }, - "delete": { - "description": "Removes an specific context source registration within an NGSI-LD system", - "operationId": "removeCsource", - "parameters": [ - { - "name": "registrationId", - "description": "Id (URI) of the context source registration to be removed", - "in": "path", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "No Content. The context source registration was removed successfully" - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - }, - "404": { - "description": "Not Found", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - } - } - }, - "patch": { - "description": "Updates a specific context source registration within an NGSI-LD system", - "operationId": "updateCsource", - "parameters": [ - { - "name": "registrationId", - "description": "Id (URI) of the context source registration to be updated", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "CsourceRegistrationFragment", - "description": "Payload body in the request contains a JSON-LD object which represents the context source registration that is to be updated", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string", - "format": "uri" - }, - "endpoint": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "ContextSourceRegistration" - ] - }, - "information": { - "type": "array", - "minItems": 1, - "items": { - "type": "object", - "required": [ - "entities" - ], - "properties": { - "entities": { - "type": "array", - "minItems": 1, - "items": { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string" - }, - "idPattern": { - "type": "string" - }, - "type": { - "type": "string" - } - } - } - }, - "properties": { - "type": "array", - "minItems": 1, - "items": { - "type": "string" - }, - "uniqueItems": true - }, - "relationships": { - "type": "array", - "minItems": 1, - "items": { - "type": "string" - }, - "uniqueItems": true - } - } - } - } - } - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "timestamp": { - "type": "array", - "minItems": 1, - "items": { - "type": "object", - "required": [ - "start" - ], - "properties": { - "start": { - "type": "string", - "format": "date-time" - }, - "end": { - "type": "string", - "format": "date-time" - } - } - } - }, - "location": { - "title": "Geometry", - "description": "A geometry is a GeoJSON object where the type member's value is one of the following strings: `Point`, `MultiPoint`, `LineString`, `MultiLineString`, `Polygon`, `MultiPolygon`, or `GeometryCollection`.", - "properties": { - "type": { - "enum": [ - "Point", - "MultiPoint", - "LineString", - "MultiLineString", - "Polygon", - "MultiPolygon", - "GeometryCollection" - ] - } - } - }, - "expires": { - "type": "string", - "format": "date-time" - }, - "name": { - "type": "string", - "minLength": 1 - }, - "description": { - "type": "string", - "minLength": 1 - } - } - }, - { - "type": "object", - "properties": { - "@context": { - "type": [ - "string", - "object", - "array" - ] - } - } - } - ] - } - ] - } - } - ], - "consumes": [ - "application/json", - "application/ld+json" - ], - "responses": { - "204": { - "description": "No Content. The context source registration was successfully updated" - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - }, - "404": { - "description": "Not Found", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - } - } - } - }, - "/subscriptions": { - "post": { - "description": "Creates a new Subscription within an NGSI-LD system", - "operationId": "createSubscription", - "parameters": [ - { - "name": "SubscriptionDescription", - "description": "Payload body in the request contains a JSON-LD object which represents the Subscription that is to be created", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uri" - } - } - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1 - }, - "description": { - "type": "string", - "minLength": 1 - }, - "watchedAttributes": { - "type": "array", - "minItems": 1, - "items": { - "type": "string" - }, - "uniqueItems": true - }, - "timeInterval": { - "type": "number", - "minimum": 0 - }, - "geoQ": { - "type": "object", - "required": [ - "geometry", - "coordinates", - "georel" - ], - "properties": { - "geometry": { - "type": "string" - }, - "coordinates": { - "type": "array", - "minItems": 1, - "items": { - "type": "number" - } - }, - "georel": { - "type": "string" - } - } - }, - "notification": { - "type": "object", - "required": [ - "endpoint" - ], - "properties": { - "attributes": { - "type": "array", - "minItems": 1, - "items": { - "type": "string" - } - }, - "format": { - "type": "string" - }, - "endpoint": { - "type": "object", - "required": [ - "uri" - ], - "properties": { - "uri": { - "type": "string", - "format": "uri" - }, - "accept": { - "type": "string", - "enum": [ - "application/json", - "application/ld+json" - ] - } - } - }, - "timesSent": { - "type": "number", - "minimum": 1 - }, - "lastNotification": { - "type": "string", - "format": "date-time" - }, - "lastFailure": { - "type": "string", - "format": "date-time" - }, - "lastSuccess": { - "type": "string", - "format": "date-time" - } - } - }, - "expires": { - "type": "string", - "format": "date-time" - }, - "status": { - "type": "string", - "enum": [ - "active", - "inactive", - "failed", - "expired" - ] - }, - "throttling": { - "type": "number", - "minimum": 1 - }, - "q": { - "type": "string", - "minLength": 1 - } - } - }, - { - "type": "object", - "properties": { - "@context": { - "type": [ - "string", - "object", - "array" - ] - } - } - } - ] - }, - { - "type": "object", - "required": [ - "type", - "entities" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "Subscription" - ] - }, - "entities": { - "type": "array", - "minItems": 1, - "items": { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string" - }, - "idPattern": { - "type": "string" - }, - "type": { - "type": "string" - } - } - } - } - } - } - ] - } - } - ], - "consumes": [ - "application/json", - "application/ld+json" - ], - "responses": { - "201": { - "description": "Created. Contains the resource URI of the created Entity resource", - "schema": { - "type": "string" - } - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - }, - "409": { - "description": "Already exists", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - } - } - }, - "get": { - "description": "Retrieves the subscriptions available in an NGSI-LD system", - "operationId": "retrieveSubscriptions", - "parameters": [ - { - "name": "limit", - "description": "Maximum number of subscriptions to be retrieved", - "in": "query", - "required": false, - "type": "string" - } - ], - "produces": [ - "application/json", - "application/ld+json" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "allOf": [ - { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string", - "format": "uri" - } - } - }, - { - "type": "object", - "properties": { - "createdAt": { - "type": "string", - "format": "date-time" - }, - "modifiedAt": { - "type": "string", - "format": "date-time" - } - } - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1 - }, - "description": { - "type": "string", - "minLength": 1 - }, - "watchedAttributes": { - "type": "array", - "minItems": 1, - "items": { - "type": "string" - }, - "uniqueItems": true - }, - "timeInterval": { - "type": "number", - "minimum": 0 - }, - "geoQ": { - "type": "object", - "required": [ - "geometry", - "coordinates", - "georel" - ], - "properties": { - "geometry": { - "type": "string" - }, - "coordinates": { - "type": "array", - "minItems": 1, - "items": { - "type": "number" - } - }, - "georel": { - "type": "string" - } - } - }, - "notification": { - "type": "object", - "required": [ - "endpoint" - ], - "properties": { - "attributes": { - "type": "array", - "minItems": 1, - "items": { - "type": "string" - } - }, - "format": { - "type": "string" - }, - "endpoint": { - "type": "object", - "required": [ - "uri" - ], - "properties": { - "uri": { - "type": "string", - "format": "uri" - }, - "accept": { - "type": "string", - "enum": [ - "application/json", - "application/ld+json" - ] - } - } - }, - "timesSent": { - "type": "number", - "minimum": 1 - }, - "lastNotification": { - "type": "string", - "format": "date-time" - }, - "lastFailure": { - "type": "string", - "format": "date-time" - }, - "lastSuccess": { - "type": "string", - "format": "date-time" - } - } - }, - "expires": { - "type": "string", - "format": "date-time" - }, - "status": { - "type": "string", - "enum": [ - "active", - "inactive", - "failed", - "expired" - ] - }, - "throttling": { - "type": "number", - "minimum": 1 - }, - "q": { - "type": "string", - "minLength": 1 - } - } - }, - { - "type": "object", - "properties": { - "@context": { - "type": [ - "string", - "object", - "array" - ] - } - } - } - ] - }, - { - "type": "object", - "required": [ - "type", - "entities" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "Subscription" - ] - }, - "entities": { - "type": "array", - "minItems": 1, - "items": { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string" - }, - "idPattern": { - "type": "string" - }, - "type": { - "type": "string" - } - } - } - } - } - } - ] - } - } - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - } - } - } - }, - "/subscriptions/{subscriptionId}": { - "get": { - "description": "Retrieves a specific Subscription from an NGSI-LD system", - "operationId": "retrieveSubscription", - "parameters": [ - { - "name": "subscriptionId", - "description": "Id (URI) of the Subscription to be retrieved", - "in": "path", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json", - "application/ld+json" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string", - "format": "uri" - } - } - }, - { - "type": "object", - "properties": { - "createdAt": { - "type": "string", - "format": "date-time" - }, - "modifiedAt": { - "type": "string", - "format": "date-time" - } - } - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1 - }, - "description": { - "type": "string", - "minLength": 1 - }, - "watchedAttributes": { - "type": "array", - "minItems": 1, - "items": { - "type": "string" - }, - "uniqueItems": true - }, - "timeInterval": { - "type": "number", - "minimum": 0 - }, - "geoQ": { - "type": "object", - "required": [ - "geometry", - "coordinates", - "georel" - ], - "properties": { - "geometry": { - "type": "string" - }, - "coordinates": { - "type": "array", - "minItems": 1, - "items": { - "type": "number" - } - }, - "georel": { - "type": "string" - } - } - }, - "notification": { - "type": "object", - "required": [ - "endpoint" - ], - "properties": { - "attributes": { - "type": "array", - "minItems": 1, - "items": { - "type": "string" - } - }, - "format": { - "type": "string" - }, - "endpoint": { - "type": "object", - "required": [ - "uri" - ], - "properties": { - "uri": { - "type": "string", - "format": "uri" - }, - "accept": { - "type": "string", - "enum": [ - "application/json", - "application/ld+json" - ] - } - } - }, - "timesSent": { - "type": "number", - "minimum": 1 - }, - "lastNotification": { - "type": "string", - "format": "date-time" - }, - "lastFailure": { - "type": "string", - "format": "date-time" - }, - "lastSuccess": { - "type": "string", - "format": "date-time" - } - } - }, - "expires": { - "type": "string", - "format": "date-time" - }, - "status": { - "type": "string", - "enum": [ - "active", - "inactive", - "failed", - "expired" - ] - }, - "throttling": { - "type": "number", - "minimum": 1 - }, - "q": { - "type": "string", - "minLength": 1 - } - } - }, - { - "type": "object", - "properties": { - "@context": { - "type": [ - "string", - "object", - "array" - ] - } - } - } - ] - }, - { - "type": "object", - "required": [ - "type", - "entities" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "Subscription" - ] - }, - "entities": { - "type": "array", - "minItems": 1, - "items": { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string" - }, - "idPattern": { - "type": "string" - }, - "type": { - "type": "string" - } - } - } - } - } - } - ] - } - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - }, - "404": { - "description": "Not Found", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - } - } - }, - "delete": { - "description": "Removes a specific Subscription from an NGSI-LD system", - "operationId": "removeSubscription", - "parameters": [ - { - "name": "subscriptionId", - "description": "Id (URI) of the Subscription to be removed", - "in": "path", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "No Content. The Subscription was removed successfully" - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - }, - "404": { - "description": "Not Found", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - } - } - }, - "patch": { - "description": "Updates a specific Subscription within an NGSI-LD system", - "operationId": "updateSubscription", - "parameters": [ - { - "name": "subscriptionId", - "description": "Id (URI) of the Subscription to be updated", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "SubscriptionFragment", - "description": "Subscription Fragment including id, type and any other Subscription field to be updated", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Subscription" - ] - }, - "entities": { - "type": "array", - "minItems": 1, - "items": { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string" - }, - "idPattern": { - "type": "string" - }, - "type": { - "type": "string" - } - } - } - } - } - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1 - }, - "description": { - "type": "string", - "minLength": 1 - }, - "watchedAttributes": { - "type": "array", - "minItems": 1, - "items": { - "type": "string" - }, - "uniqueItems": true - }, - "timeInterval": { - "type": "number", - "minimum": 0 - }, - "geoQ": { - "type": "object", - "required": [ - "geometry", - "coordinates", - "georel" - ], - "properties": { - "geometry": { - "type": "string" - }, - "coordinates": { - "type": "array", - "minItems": 1, - "items": { - "type": "number" - } - }, - "georel": { - "type": "string" - } - } - }, - "notification": { - "type": "object", - "required": [ - "endpoint" - ], - "properties": { - "attributes": { - "type": "array", - "minItems": 1, - "items": { - "type": "string" - } - }, - "format": { - "type": "string" - }, - "endpoint": { - "type": "object", - "required": [ - "uri" - ], - "properties": { - "uri": { - "type": "string", - "format": "uri" - }, - "accept": { - "type": "string", - "enum": [ - "application/json", - "application/ld+json" - ] - } - } - }, - "timesSent": { - "type": "number", - "minimum": 1 - }, - "lastNotification": { - "type": "string", - "format": "date-time" - }, - "lastFailure": { - "type": "string", - "format": "date-time" - }, - "lastSuccess": { - "type": "string", - "format": "date-time" - } - } - }, - "expires": { - "type": "string", - "format": "date-time" - }, - "status": { - "type": "string", - "enum": [ - "active", - "inactive", - "failed", - "expired" - ] - }, - "throttling": { - "type": "number", - "minimum": 1 - }, - "q": { - "type": "string", - "minLength": 1 - } - } - }, - { - "type": "object", - "properties": { - "@context": { - "type": [ - "string", - "object", - "array" - ] - } - } - } - ] - } - ] - } - } - ], - "consumes": [ - "application/json", - "application/ld+json" - ], - "responses": { - "204": { - "description": "No Content. The Subscription was updated successfully" - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - }, - "404": { - "description": "Not Found", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - } - } - } - }, - "/csourceSubscriptions": { - "post": { - "description": "Creates a context source discovery Subscription within an NGSI-LD system", - "operationId": "createCSourceSubscription", - "parameters": [ - { - "name": "SubscriptionDescription", - "description": "Payload body in the request contains a JSON-LD object which represents the context source discovery Subscription that is to be created", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uri" - } - } - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1 - }, - "description": { - "type": "string", - "minLength": 1 - }, - "watchedAttributes": { - "type": "array", - "minItems": 1, - "items": { - "type": "string" - }, - "uniqueItems": true - }, - "timeInterval": { - "type": "number", - "minimum": 0 - }, - "geoQ": { - "type": "object", - "required": [ - "geometry", - "coordinates", - "georel" - ], - "properties": { - "geometry": { - "type": "string" - }, - "coordinates": { - "type": "array", - "minItems": 1, - "items": { - "type": "number" - } - }, - "georel": { - "type": "string" - } - } - }, - "notification": { - "type": "object", - "required": [ - "endpoint" - ], - "properties": { - "attributes": { - "type": "array", - "minItems": 1, - "items": { - "type": "string" - } - }, - "format": { - "type": "string" - }, - "endpoint": { - "type": "object", - "required": [ - "uri" - ], - "properties": { - "uri": { - "type": "string", - "format": "uri" - }, - "accept": { - "type": "string", - "enum": [ - "application/json", - "application/ld+json" - ] - } - } - }, - "timesSent": { - "type": "number", - "minimum": 1 - }, - "lastNotification": { - "type": "string", - "format": "date-time" - }, - "lastFailure": { - "type": "string", - "format": "date-time" - }, - "lastSuccess": { - "type": "string", - "format": "date-time" - } - } - }, - "expires": { - "type": "string", - "format": "date-time" - }, - "status": { - "type": "string", - "enum": [ - "active", - "inactive", - "failed", - "expired" - ] - }, - "throttling": { - "type": "number", - "minimum": 1 - }, - "q": { - "type": "string", - "minLength": 1 - } - } - }, - { - "type": "object", - "properties": { - "@context": { - "type": [ - "string", - "object", - "array" - ] - } - } - } - ] - }, - { - "type": "object", - "required": [ - "type", - "entities" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "Subscription" - ] - }, - "entities": { - "type": "array", - "minItems": 1, - "items": { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string" - }, - "idPattern": { - "type": "string" - }, - "type": { - "type": "string" - } - } - } - } - } - } - ] - } - } - ], - "consumes": [ - "application/json", - "application/ld+json" - ], - "responses": { - "201": { - "description": "Created. Contains the resource URI of the created context source discovery Subscription resource", - "schema": { - "type": "string" - } - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - }, - "409": { - "description": "Already exists", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - } - } - }, - "get": { - "description": "Retrieves the context source discovery subscriptions available in an NGSI-LD system", - "operationId": "retrieveCSourceSubscriptions", - "parameters": [ - { - "name": "limit", - "description": "Maximum number of subscriptions to be retrieved", - "in": "query", - "required": false, - "type": "string" - } - ], - "produces": [ - "application/json", - "application/ld+json" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "allOf": [ - { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string", - "format": "uri" - } - } - }, - { - "type": "object", - "properties": { - "createdAt": { - "type": "string", - "format": "date-time" - }, - "modifiedAt": { - "type": "string", - "format": "date-time" - } - } - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1 - }, - "description": { - "type": "string", - "minLength": 1 - }, - "watchedAttributes": { - "type": "array", - "minItems": 1, - "items": { - "type": "string" - }, - "uniqueItems": true - }, - "timeInterval": { - "type": "number", - "minimum": 0 - }, - "geoQ": { - "type": "object", - "required": [ - "geometry", - "coordinates", - "georel" - ], - "properties": { - "geometry": { - "type": "string" - }, - "coordinates": { - "type": "array", - "minItems": 1, - "items": { - "type": "number" - } - }, - "georel": { - "type": "string" - } - } - }, - "notification": { - "type": "object", - "required": [ - "endpoint" - ], - "properties": { - "attributes": { - "type": "array", - "minItems": 1, - "items": { - "type": "string" - } - }, - "format": { - "type": "string" - }, - "endpoint": { - "type": "object", - "required": [ - "uri" - ], - "properties": { - "uri": { - "type": "string", - "format": "uri" - }, - "accept": { - "type": "string", - "enum": [ - "application/json", - "application/ld+json" - ] - } - } - }, - "timesSent": { - "type": "number", - "minimum": 1 - }, - "lastNotification": { - "type": "string", - "format": "date-time" - }, - "lastFailure": { - "type": "string", - "format": "date-time" - }, - "lastSuccess": { - "type": "string", - "format": "date-time" - } - } - }, - "expires": { - "type": "string", - "format": "date-time" - }, - "status": { - "type": "string", - "enum": [ - "active", - "inactive", - "failed", - "expired" - ] - }, - "throttling": { - "type": "number", - "minimum": 1 - }, - "q": { - "type": "string", - "minLength": 1 - } - } - }, - { - "type": "object", - "properties": { - "@context": { - "type": [ - "string", - "object", - "array" - ] - } - } - } - ] - }, - { - "type": "object", - "required": [ - "type", - "entities" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "Subscription" - ] - }, - "entities": { - "type": "array", - "minItems": 1, - "items": { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string" - }, - "idPattern": { - "type": "string" - }, - "type": { - "type": "string" - } - } - } - } - } - } - ] - } - } - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - } - } - } - }, - "/csourceSubscriptions/{subscriptionId}": { - "get": { - "description": "Retrieves a specific context source discovery Subscription from an NGSI-LD system", - "operationId": "retrieveCSourceSubscription", - "parameters": [ - { - "name": "subscriptionId", - "description": "Id (URI) context source discovery Subscription to be retrieved", - "in": "path", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json", - "application/ld+json" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string", - "format": "uri" - } - } - }, - { - "type": "object", - "properties": { - "createdAt": { - "type": "string", - "format": "date-time" - }, - "modifiedAt": { - "type": "string", - "format": "date-time" - } - } - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1 - }, - "description": { - "type": "string", - "minLength": 1 - }, - "watchedAttributes": { - "type": "array", - "minItems": 1, - "items": { - "type": "string" - }, - "uniqueItems": true - }, - "timeInterval": { - "type": "number", - "minimum": 0 - }, - "geoQ": { - "type": "object", - "required": [ - "geometry", - "coordinates", - "georel" - ], - "properties": { - "geometry": { - "type": "string" - }, - "coordinates": { - "type": "array", - "minItems": 1, - "items": { - "type": "number" - } - }, - "georel": { - "type": "string" - } - } - }, - "notification": { - "type": "object", - "required": [ - "endpoint" - ], - "properties": { - "attributes": { - "type": "array", - "minItems": 1, - "items": { - "type": "string" - } - }, - "format": { - "type": "string" - }, - "endpoint": { - "type": "object", - "required": [ - "uri" - ], - "properties": { - "uri": { - "type": "string", - "format": "uri" - }, - "accept": { - "type": "string", - "enum": [ - "application/json", - "application/ld+json" - ] - } - } - }, - "timesSent": { - "type": "number", - "minimum": 1 - }, - "lastNotification": { - "type": "string", - "format": "date-time" - }, - "lastFailure": { - "type": "string", - "format": "date-time" - }, - "lastSuccess": { - "type": "string", - "format": "date-time" - } - } - }, - "expires": { - "type": "string", - "format": "date-time" - }, - "status": { - "type": "string", - "enum": [ - "active", - "inactive", - "failed", - "expired" - ] - }, - "throttling": { - "type": "number", - "minimum": 1 - }, - "q": { - "type": "string", - "minLength": 1 - } - } - }, - { - "type": "object", - "properties": { - "@context": { - "type": [ - "string", - "object", - "array" - ] - } - } - } - ] - }, - { - "type": "object", - "required": [ - "type", - "entities" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "Subscription" - ] - }, - "entities": { - "type": "array", - "minItems": 1, - "items": { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string" - }, - "idPattern": { - "type": "string" - }, - "type": { - "type": "string" - } - } - } - } - } - } - ] - } - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - }, - "404": { - "description": "Not Found", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - } - } - }, - "delete": { - "description": "Removes a specific context source discovery Subscription from an NGSI-LD system", - "operationId": "removeCSourceSubscription", - "parameters": [ - { - "name": "subscriptionId", - "description": "Id (URI) context source discovery Subscription to be removed", - "in": "path", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "No Content. The context source discovery Subscription was removed successfully" - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - }, - "404": { - "description": "Not Found", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - } - } - }, - "patch": { - "description": "Updates a specific context source discovery Subscription within an NGSI-LD system", - "operationId": "updateCSourceSubscription", - "parameters": [ - { - "name": "subscriptionId", - "description": "Id (URI) context source discovery Subscription to be updated", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "SubscriptionFragment", - "description": "Subscription Fragment including id, type and any other Subscription field to be updated", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Subscription" - ] - }, - "entities": { - "type": "array", - "minItems": 1, - "items": { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string" - }, - "idPattern": { - "type": "string" - }, - "type": { - "type": "string" - } - } - } - } - } - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1 - }, - "description": { - "type": "string", - "minLength": 1 - }, - "watchedAttributes": { - "type": "array", - "minItems": 1, - "items": { - "type": "string" - }, - "uniqueItems": true - }, - "timeInterval": { - "type": "number", - "minimum": 0 - }, - "geoQ": { - "type": "object", - "required": [ - "geometry", - "coordinates", - "georel" - ], - "properties": { - "geometry": { - "type": "string" - }, - "coordinates": { - "type": "array", - "minItems": 1, - "items": { - "type": "number" - } - }, - "georel": { - "type": "string" - } - } - }, - "notification": { - "type": "object", - "required": [ - "endpoint" - ], - "properties": { - "attributes": { - "type": "array", - "minItems": 1, - "items": { - "type": "string" - } - }, - "format": { - "type": "string" - }, - "endpoint": { - "type": "object", - "required": [ - "uri" - ], - "properties": { - "uri": { - "type": "string", - "format": "uri" - }, - "accept": { - "type": "string", - "enum": [ - "application/json", - "application/ld+json" - ] - } - } - }, - "timesSent": { - "type": "number", - "minimum": 1 - }, - "lastNotification": { - "type": "string", - "format": "date-time" - }, - "lastFailure": { - "type": "string", - "format": "date-time" - }, - "lastSuccess": { - "type": "string", - "format": "date-time" - } - } - }, - "expires": { - "type": "string", - "format": "date-time" - }, - "status": { - "type": "string", - "enum": [ - "active", - "inactive", - "failed", - "expired" - ] - }, - "throttling": { - "type": "number", - "minimum": 1 - }, - "q": { - "type": "string", - "minLength": 1 - } - } - }, - { - "type": "object", - "properties": { - "@context": { - "type": [ - "string", - "object", - "array" - ] - } - } - } - ] - } - ] - } - } - ], - "consumes": [ - "application/json", - "application/ld+json" - ], - "responses": { - "204": { - "description": "No Content. The context source discovery Subscription was updated successfully" - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - }, - "404": { - "description": "Not Found", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - } - } - } - } - } - } - } -} diff --git a/scripts/validate_all.sh b/scripts/validate_all.sh new file mode 100755 index 0000000..9b6813a --- /dev/null +++ b/scripts/validate_all.sh @@ -0,0 +1,11 @@ +#!/bin/bash +echo 'Validating everything...' +echo '-------->Validating Examples...' +sh ./scripts/validate_examples.sh +echo '-------->Validating locally...' +sh ./scripts/validate_locally.sh +echo '-------->Validating online...' +sh ./scripts/validate_online.sh +echo '-------->Validating schema...' +sh ./scripts/validate_schema.sh +echo 'Done' \ No newline at end of file diff --git a/scripts/validate_examples.sh b/scripts/validate_examples.sh index 645803c..9669b9e 100755 --- a/scripts/validate_examples.sh +++ b/scripts/validate_examples.sh @@ -1,22 +1,22 @@ #!/bin/bash -ajv validate -s $SCHEMAS/Entity.json -d $EXAMPLES/Entity-example.json -r $SCHEMAS/common.json -r $SCHEMAS/geometry-schema.json +ajv validate -s ./schema/Entity.json -d ./examples/Entity-example.json -r ./schema/common.json -r ./schema/geometry-schema.json -ajv validate -s $SCHEMAS/Entity.json -d $EXAMPLES/Vehicle_C2.2.json -r $SCHEMAS/common.json -r $SCHEMAS/geometry-schema.json +ajv validate -s ./schema/Entity.json -d ./examples/Vehicle_C2.2.json -r ./schema/common.json -r ./schema/geometry-schema.json -ajv validate -s $SCHEMAS/Entity.json -d $EXAMPLES/OffStreetParking_C2.3.json -r $SCHEMAS/common.json -r $SCHEMAS/geometry-schema.json +ajv validate -s ./schema/Entity.json -d ./examples/OffStreetParking_C2.3.json -r ./schema/common.json -r ./schema/geometry-schema.json -ajv validate -s $SCHEMAS/Entity_keyValues.json -d -d $EXAMPLES/Vehicle_keyValues_C2.2.json -r $SCHEMAS/common.json -r $SCHEMAS/geometry-schema.json +ajv validate -s ./schema/Entity_keyValues.json -d ./examples/Vehicle_keyValues_C2.2.json -r ./schema/common.json -r ./schema/geometry-schema.json -ajv validate -s $SCHEMAS/Entity_keyValues.json -d -d $EXAMPLES/OffStreetParking_keyValues_C2.3.json -r $SCHEMAS/common.json -r $SCHEMAS/geometry-schema.json +ajv validate -s ./schema/Entity_keyValues.json -d ./examples/OffStreetParking_keyValues_C2.3.json -r ./schema/common.json -r ./schema/geometry-schema.json -ajv validate -s $SCHEMAS/Entity.json -d $EXAMPLES/Vehicle_MultiAttribute_C2.2.json -r $SCHEMAS/common.json -r $SCHEMAS/geometry-schema.json +ajv validate -s ./schema/Entity.json -d ./examples/Vehicle_MultiAttribute_C2.2.json -r ./schema/common.json -r ./schema/geometry-schema.json -ajv validate -s $SCHEMAS/subscriptions/Subscription.json -d $EXAMPLES/Subscription-example_C.4.json -r $SCHEMAS/common.json -r $SCHEMAS/geometry-schema.json +ajv validate -s ./schema/subscriptions/Subscription.json -d ./examples/Subscription-example_C.4.json -r ./schema/common.json -r ./schema/geometry-schema.json -ajv validate -s $SCHEMAS/registrations/ContextSourceRegistration.json -d $EXAMPLES/ContextSourceRegistration-example_C.3.json -r $SCHEMAS/common.json -r $SCHEMAS/geometry-schema.json +ajv validate -s ./schema/registrations/ContextSourceRegistration.json -d ./examples/ContextSourceRegistration-example_C.3.json -r ./schema/common.json -r ./schema/geometry-schema.json -ajv validate -s $SCHEMAS/temporal/EntityTemporal.json -d $EXAMPLES/EntityTemporal-example_C5.5.3.json -r $SCHEMAS/common.json -r $SCHEMAS/geometry-schema.json -r $SCHEMAS/Entity.json +ajv validate -s ./schema/temporal/EntityTemporal.json -d ./examples/EntityTemporal-example_C5.5.3.json -r ./schema/common.json -r ./schema/geometry-schema.json -r ./schema/Entity.json -ajv validate -s $SCHEMAS/temporal/Entity_temporalValues.json -d $EXAMPLES/Entity_temporalValues_C.5.6.3.json -r $SCHEMAS/common.json -r $SCHEMAS/geometry-schema.json -r $SCHEMAS/Entity.json +ajv validate -s ./schema/temporal/Entity_temporalValues.json -d ./examples/Entity_temporalValues_C.5.6.3.json -r ./schema/common.json -r ./schema/geometry-schema.json -r ./schema/Entity.json diff --git a/scripts/validate_locally.sh b/scripts/validate_locally.sh old mode 100644 new mode 100755 index 57667d8..e033948 --- a/scripts/validate_locally.sh +++ b/scripts/validate_locally.sh @@ -3,19 +3,5 @@ # Requires install swagger-cli: npm install -g swagger-cli # - -# Store current directory -current_dir=${PWD} - -# Store script directory -script_directory="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" - - -# Move cd to the script directory (the script must be called from the 'script' directory) -cd $script_directory - # Validate locally the definition using the swagger-cli validate option -swagger-cli validate ../spec/ngsild_swagger.json - -# Move cd to the directory from where the script was called -cd $current_dir \ No newline at end of file +swagger-cli validate ./spec/updated/ngsi-ld-spec-open-api.json diff --git a/scripts/validate_online.sh b/scripts/validate_online.sh old mode 100644 new mode 100755 index b48c200..736deea --- a/scripts/validate_online.sh +++ b/scripts/validate_online.sh @@ -3,22 +3,10 @@ # Requires install swagger-cli: npm install -g swagger-cli # - -# Store current directory -current_dir=${PWD} - -# Store script directory -script_directory="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" - - -# Move cd to the script directory (the script must be called from the 'script' directory) -cd $script_directory - # Merge the swagger definition into an unified and de-referenced file (use this file will avoid reference resolution problems during the validation) -swagger-cli bundle -r ../spec/ngsild_swagger.json -o combined_spec/ngsild_swagger_combined_dereferenced.json - +swagger-cli bundle --dereference ./spec/updated/ngsi-ld-spec-open-api.json -o ./bundle/ngsild_swagger_combined_dereferenced.json && +# modified version to allow circular ref +# ~/work/swagger-cli/bin/swagger-cli.js bundle --dereference="ignore" ./spec/updated/ngsi-ld-spec-open-api.json -o ./bundle/ngsild_swagger_combined_dereferenced.json && +echo '--> Sending to validator.swagger.io' && # Validate the swagger definition against the official online swagger validation service -curl -X POST -d @combined_spec/ngsild_swagger_combined_dereferenced.json -H 'Content-Type:application/json' http://online.swagger.io/validator/debug - -# Move cd to the directory from where the script was called -cd $current_dir \ No newline at end of file +curl -X POST -d @bundle/ngsild_swagger_combined_dereferenced.json -H 'Content-Type:application/json' https://validator.swagger.io/validator/debug diff --git a/scripts/validate_schema.sh b/scripts/validate_schema.sh index 2704581..9c9592b 100755 --- a/scripts/validate_schema.sh +++ b/scripts/validate_schema.sh @@ -1,30 +1,29 @@ #!/bin/bash -ajv compile -s $SCHEMAS/Entity.json -r $SCHEMAS/common.json -r $SCHEMAS/geometry-schema.json +ajv compile -s ./schema/Entity.json -r ./schema/common.json -r ./schema/geometry-schema.json -ajv compile -s $SCHEMAS/subscriptions/Subscription.json -r $SCHEMAS/common.json -r $SCHEMAS/geometry-schema.json +ajv compile -s ./schema/subscriptions/Subscription.json -r ./schema/common.json -r ./schema/geometry-schema.json -ajv compile -s $SCHEMAS/temporal/EntityTemporal.json -r $SCHEMAS/common.json -r $SCHEMAS/geometry-schema.json -r $SCHEMAS/Entity.json +ajv compile -s ./schema/temporal/EntityTemporal.json -r ./schema/common.json -r ./schema/geometry-schema.json -r ./schema/Entity.json -ajv compile -s $SCHEMAS/registrations/ContextSourceRegistration.json -r $SCHEMAS/common.json -r $SCHEMAS/geometry-schema.json +ajv compile -s ./schema/registrations/ContextSourceRegistration.json -r ./schema/common.json -r ./schema/geometry-schema.json -ajv compile -s $SCHEMAS/subscriptions/Notification.json -r $SCHEMAS/common.json -r $SCHEMAS/geometry-schema.json -r $SCHEMAS/Entity.json +ajv compile -s ./schema/subscriptions/Notification.json -r ./schema/common.json -r ./schema/geometry-schema.json -r ./schema/Entity.json -ajv compile -s $SCHEMAS/registrations/ContextSourceNotification.json -r $SCHEMAS/common.json -r $SCHEMAS/geometry-schema.json -r $SCHEMAS/registrations/ContextSourceRegistration.json +ajv compile -s ./schema/registrations/ContextSourceNotification.json -r ./schema/common.json -r ./schema/geometry-schema.json -r ./schema/registrations/ContextSourceRegistration.json -ajv compile -s $SCHEMAS/EntityList.json -r $SCHEMAS/common.json -r $SCHEMAS/geometry-schema.json -r $SCHEMAS/Entity.json +ajv compile -s ./schema/EntityList.json -r ./schema/common.json -r ./schema/geometry-schema.json -r ./schema/Entity.json -ajv compile -s $SCHEMAS/subscriptions/SubscriptionList.json -r $SCHEMAS/common.json -r $SCHEMAS/geometry-schema.json -r $SCHEMAS/subscriptions/Subscription.json +ajv compile -s ./schema/subscriptions/SubscriptionList.json -r ./schema/common.json -r ./schema/geometry-schema.json -r ./schema/subscriptions/Subscription.json -ajv compile -s $SCHEMAS/registrations/ContextSourceRegistrationList.json -r $SCHEMAS/common.json -r $SCHEMAS/geometry-schema.json -r $SCHEMAS/registrations/ContextSourceRegistration.json +ajv compile -s ./schema/registrations/ContextSourceRegistrationList.json -r ./schema/common.json -r ./schema/geometry-schema.json -r ./schema/registrations/ContextSourceRegistration.json -ajv compile -s $SCHEMAS/temporal/EntityTemporalList.json -r $SCHEMAS/temporal/EntityTemporal.json -r $SCHEMAS/Entity.json -r $SCHEMAS/common.json -r $SCHEMAS/geometry-schema.json +ajv compile -s ./schema/temporal/EntityTemporalList.json -r ./schema/temporal/EntityTemporal.json -r ./schema/Entity.json -r ./schema/common.json -r ./schema/geometry-schema.json -ajv compile -s $SCHEMAS/BatchOperationResult.json -r $SCHEMAS/common.json +ajv compile -s ./schema/BatchOperationResult.json -r ./schema/common.json -ajv compile -s $SCHEMAS/UpdateResult.json +ajv compile -s ./schema/UpdateResult.json -ajv compile -s $SCHEMAS/Entity_keyValues.json -r $SCHEMAS/common.json -r $SCHEMAS/geometry-schema.json - -ajv compile -s $SCHEMAS/temporal/Entity_temporalValues.json -r $SCHEMAS/common.json -r $SCHEMAS/geometry-schema.json -r $SCHEMAS/Entity.json +ajv compile -s ./schema/Entity_keyValues.json -r ./schema/common.json -r ./schema/geometry-schema.json +ajv compile -s ./schema/temporal/Entity_temporalValues.json -r ./schema/common.json -r ./schema/geometry-schema.json -r ./schema/Entity.json diff --git a/spec/updated/csource-registration-by-id-spec.json b/spec/updated/csource-registration-by-id-spec.json index 22d637e..e15d273 100644 --- a/spec/updated/csource-registration-by-id-spec.json +++ b/spec/updated/csource-registration-by-id-spec.json @@ -35,11 +35,11 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/registrations/ContextSourceRegistration.json#/definitions/ContextSourceRegistration" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/registrations/ContextSourceRegistration.json#/definitions/ContextSourceRegistration" }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/" + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/" } } } @@ -50,7 +50,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -60,7 +60,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -85,7 +85,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -95,7 +95,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } diff --git a/spec/updated/csource-registrations-spec.json b/spec/updated/csource-registrations-spec.json index 65976a7..6e43c30 100644 --- a/spec/updated/csource-registrations-spec.json +++ b/spec/updated/csource-registrations-spec.json @@ -16,34 +16,34 @@ "tags": ["Context Sources"], "parameters": [ { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/id" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/id" }, { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/idPattern" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/idPattern" }, { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/type" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/type" }, { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/attrs" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/attrs" }, { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/q" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/q" }, { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/georel" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/georel" }, { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/geometry" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/geometry" }, { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/coordinates" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/coordinates" }, { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/geoproperty" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/geoproperty" }, { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/limit" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/limit" } ], "responses": { @@ -52,11 +52,11 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/registrations/ContextSourceRegistrationList.json#/definitions/ContextSourceRegistrationList" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/registrations/ContextSourceRegistrationList.json#/definitions/ContextSourceRegistrationList" }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/ContextSourceRegistrationList-example.json" + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/ContextSourceRegistrationList-example.json" } } } @@ -67,7 +67,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -83,7 +83,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/registrations/ContextSourceRegistration.json#/definitions/ContextSourceRegistration" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/registrations/ContextSourceRegistration.json#/definitions/ContextSourceRegistration" } } } @@ -97,7 +97,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -107,7 +107,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } diff --git a/spec/updated/csource-subscription-by-id-spec.json b/spec/updated/csource-subscription-by-id-spec.json index a9473b4..5b1b595 100644 --- a/spec/updated/csource-subscription-by-id-spec.json +++ b/spec/updated/csource-subscription-by-id-spec.json @@ -35,11 +35,11 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/subscriptions/Subscription.json#/definitions/Subscription" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/subscriptions/Subscription.json#/definitions/Subscription" }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/Subscription-example_C.4.json" + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/Subscription-example_C.4.json" } } } @@ -50,7 +50,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -60,7 +60,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -81,7 +81,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/subscriptions/Subscription.json#/definitions/SubscriptionFragment" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/subscriptions/Subscription.json#/definitions/SubscriptionFragment" } } } @@ -95,7 +95,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -105,7 +105,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -130,7 +130,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -140,7 +140,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } diff --git a/spec/updated/csource-subscriptions-spec.json b/spec/updated/csource-subscriptions-spec.json index 668ca0c..e152186 100644 --- a/spec/updated/csource-subscriptions-spec.json +++ b/spec/updated/csource-subscriptions-spec.json @@ -35,11 +35,11 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/subscriptions/SubscriptionList.json#/definitions/SubscriptionList" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/subscriptions/SubscriptionList.json#/definitions/SubscriptionList" }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/SubscriptionList-example.json" + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/SubscriptionList-example.json" } } } @@ -50,7 +50,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -66,7 +66,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/subscriptions/Subscription.json#/definitions/Subscription" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/subscriptions/Subscription.json#/definitions/Subscription" } } } @@ -80,7 +80,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -90,7 +90,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } diff --git a/spec/updated/entities-spec.json b/spec/updated/entities-spec.json index 46d3814..a55bfe8 100644 --- a/spec/updated/entities-spec.json +++ b/spec/updated/entities-spec.json @@ -62,7 +62,7 @@ "in": "query", "required": false, "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/georel" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/georel" } }, "geometry": { @@ -71,7 +71,7 @@ "in": "query", "required": false, "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/geometry" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/geometry" } }, "coordinates": { @@ -80,7 +80,7 @@ "in": "query", "required": false, "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/coordinates" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/coordinates" } }, "geoproperty": { @@ -175,11 +175,11 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/EntityList.json#/definitions/EntityList" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/EntityList.json#/definitions/EntityList" }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/EntityList-example.json" + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/EntityList-example.json" } } } @@ -190,7 +190,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -206,7 +206,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/Entity" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/Entity" } } } @@ -220,7 +220,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -230,7 +230,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -240,7 +240,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } diff --git a/spec/updated/entity-attrs-spec.json b/spec/updated/entity-attrs-spec.json index 3e8ad39..0a80b51 100644 --- a/spec/updated/entity-attrs-spec.json +++ b/spec/updated/entity-attrs-spec.json @@ -22,7 +22,7 @@ "in": "path", "required": true, "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" } }, "options": { @@ -58,7 +58,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/EntityFragment" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/EntityFragment" } } } @@ -72,7 +72,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/UpdateResult.json#" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/UpdateResult.json#" } } } @@ -82,7 +82,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -92,7 +92,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -113,7 +113,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/EntityFragment" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/EntityFragment" } } } @@ -127,7 +127,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/UpdateResult.json#" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/UpdateResult.json#" } } } @@ -137,7 +137,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -147,7 +147,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -173,7 +173,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/EntityFragment" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/EntityFragment" } } } @@ -187,7 +187,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -197,7 +197,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -225,7 +225,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -235,7 +235,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } diff --git a/spec/updated/entity-by-id-spec.json b/spec/updated/entity-by-id-spec.json index dfec25e..3c97881 100644 --- a/spec/updated/entity-by-id-spec.json +++ b/spec/updated/entity-by-id-spec.json @@ -22,7 +22,7 @@ "in": "query", "required": false, "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" } }, "attrs": { @@ -54,7 +54,7 @@ "$ref": "#/components/parameters/type" }, { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/options" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/options" } ], "responses": { @@ -63,11 +63,11 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/Entity" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/Entity" }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/Entity-example.json" + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/Entity-example.json" } } } @@ -78,7 +78,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -88,7 +88,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -116,7 +116,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -126,7 +126,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } diff --git a/spec/updated/entity-operations-spec.json b/spec/updated/entity-operations-spec.json index d70e822..fd8bc1c 100644 --- a/spec/updated/entity-operations-spec.json +++ b/spec/updated/entity-operations-spec.json @@ -16,7 +16,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/EntityList.json#/definitions/EntityList" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/EntityList.json#/definitions/EntityList" } } } @@ -27,7 +27,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/BatchOperationResult.json#/definitions/BatchOperationResult" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/BatchOperationResult.json#/definitions/BatchOperationResult" } } } @@ -37,7 +37,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -68,7 +68,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/EntityList.json#/definitions/EntityList" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/EntityList.json#/definitions/EntityList" } } } @@ -79,7 +79,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/BatchOperationResult.json#/definitions/BatchOperationResult" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/BatchOperationResult.json#/definitions/BatchOperationResult" } } } @@ -89,7 +89,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -121,7 +121,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/EntityList.json#/definitions/EntityList" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/EntityList.json#/definitions/EntityList" } } } @@ -132,7 +132,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/BatchOperationResult.json#/definitions/BatchOperationResult" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/BatchOperationResult.json#/definitions/BatchOperationResult" } } } @@ -142,7 +142,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -176,7 +176,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/BatchOperationResult.json#/definitions/BatchOperationResult" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/BatchOperationResult.json#/definitions/BatchOperationResult" } } } @@ -186,7 +186,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } diff --git a/spec/updated/full_api.json b/spec/updated/full_api.json index 5a2f077..ffae24b 100644 --- a/spec/updated/full_api.json +++ b/spec/updated/full_api.json @@ -223,7 +223,7 @@ }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/EntityList-example.json" + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/EntityList-example.json" } } } @@ -384,7 +384,7 @@ }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/Entity-example.json" + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/Entity-example.json" } } } @@ -938,7 +938,7 @@ }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/SubscriptionList-example.json" + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/SubscriptionList-example.json" } } } @@ -1143,7 +1143,7 @@ }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/Subscription-example_C.4.json" + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/Subscription-example_C.4.json" } } } @@ -1392,7 +1392,7 @@ }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/ContextSourceRegistrationList-example.json" + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/ContextSourceRegistrationList-example.json" } } } @@ -1485,7 +1485,7 @@ }, "location": { "$schema": "http://json-schema.org/draft-04/schema#", - "id": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json", + "id": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json", "title": "geometry", "description": "One geometry as defined by GeoJSON. Licensed as per original source is https://github.com/fge/sample-json-schemas/blob/master/geojson/geometry.json", "type": "object", @@ -1745,7 +1745,7 @@ }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/" + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/" } } } @@ -1840,7 +1840,7 @@ }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/SubscriptionList-example.json" + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/SubscriptionList-example.json" } } } @@ -1930,7 +1930,7 @@ }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/Subscription-example_C.4.json" + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/Subscription-example_C.4.json" } } } @@ -2383,7 +2383,7 @@ "type": "array", "items": { "$schema": "http://json-schema.org/schema#", - "id": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/temporal/EntityTemporal.json", + "id": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/temporal/EntityTemporal.json", "title": "NGSI-LD Entity", "description": "NGSI-LD Temporal Representation of an Entity", "definitions": { @@ -2484,7 +2484,7 @@ }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/EntityTemporalList-example.json" + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/EntityTemporalList-example.json" } } } @@ -2517,7 +2517,7 @@ }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/EntityTemporal-example_C5.5.3.json" + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/EntityTemporal-example_C5.5.3.json" } } } @@ -2609,7 +2609,7 @@ }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/EntityTemporal-example_C5.5.3.json" + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/EntityTemporal-example_C5.5.3.json" } } } diff --git a/spec/updated/ngsi-ld-spec-open-api.json b/spec/updated/ngsi-ld-spec-open-api.json index b66ab09..c518c58 100644 --- a/spec/updated/ngsi-ld-spec-open-api.json +++ b/spec/updated/ngsi-ld-spec-open-api.json @@ -1,5 +1,5 @@ { - "openapi": "3.0.1", + "openapi": "3.0.3", "info": { "description": "This OAS file describes the NGSI-LD API defined by the ETSI ISG CIM group. This Cross-domain Context Information Management API allows to provide, consume and subscribe to context information in multiple scenarios and involving multiple stakeholders", "version": "latest", @@ -48,61 +48,61 @@ ], "paths": { "/entities/": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/paths/%2Fentities%2F" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/paths/%2Fentities%2F" }, "/entities/{entityId}": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-by-id-spec.json#/paths/%2Fentities%2F%7BentityId%7D" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-by-id-spec.json#/paths/%2Fentities%2F%7BentityId%7D" }, "/entities/{entityId}/attrs/": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-attrs-spec.json#/paths/%2Fentities%2F%7BentityId%7D%2Fattrs%2F" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-attrs-spec.json#/paths/%2Fentities%2F%7BentityId%7D%2Fattrs%2F" }, "/entities/{entityId}/attrs/{attrId}": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-attrs-spec.json#/paths/%2Fentities%2F%7BentityId%7D%2Fattrs%2F%7BattrId%7D" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-attrs-spec.json#/paths/%2Fentities%2F%7BentityId%7D%2Fattrs%2F%7BattrId%7D" }, "/subscriptions/": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/subscriptions-spec.json#/paths/%2Fsubscriptions%2F" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/subscriptions-spec.json#/paths/%2Fsubscriptions%2F" }, "/subscriptions/{subscriptionId}": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/subscription-by-id-spec.json#/paths/%2Fsubscriptions%2F%7BsubscriptionId%7D" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/subscription-by-id-spec.json#/paths/%2Fsubscriptions%2F%7BsubscriptionId%7D" }, "/csourceRegistrations/": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/csource-registrations-spec.json#/paths/%2FcsourceRegistrations%2F" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/csource-registrations-spec.json#/paths/%2FcsourceRegistrations%2F" }, "/csourceRegistrations/{registrationId}": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/csource-registration-by-id-spec.json#/paths/%2FcsourceRegistrations%2F%7BregistrationId%7D" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/csource-registration-by-id-spec.json#/paths/%2FcsourceRegistrations%2F%7BregistrationId%7D" }, "/csourceSubscriptions/": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/csource-subscriptions-spec.json#/paths/%2FcsourceSubscriptions%2F" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/csource-subscriptions-spec.json#/paths/%2FcsourceSubscriptions%2F" }, "/csourceSubscriptions/{subscriptionId}": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/csource-subscription-by-id-spec.json#/paths/%2FcsourceSubscriptions%2F%7BsubscriptionId%7D" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/csource-subscription-by-id-spec.json#/paths/%2FcsourceSubscriptions%2F%7BsubscriptionId%7D" }, "/entityOperations/create": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-operations-spec.json#/paths/%2FentityOperations%2Fcreate" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-operations-spec.json#/paths/%2FentityOperations%2Fcreate" }, "/entityOperations/update": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-operations-spec.json#/paths/%2FentityOperations%2Fupdate" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-operations-spec.json#/paths/%2FentityOperations%2Fupdate" }, "/entityOperations/upsert": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-operations-spec.json#/paths/%2FentityOperations%2Fupsert" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-operations-spec.json#/paths/%2FentityOperations%2Fupsert" }, "/entityOperations/delete": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-operations-spec.json#/paths/%2FentityOperations%2Fdelete" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-operations-spec.json#/paths/%2FentityOperations%2Fdelete" }, "/temporal/entities/": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal/temporal-entities-spec.json#/paths/%2Ftemporal%2Fentities%2F" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal/temporal-entities-spec.json#/paths/%2Ftemporal%2Fentities%2F" }, "/temporal/entities/{entityId}": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal/temporal-entity-by-id-spec.json#/paths/%2Ftemporal%2Fentities%2F%7BentityId%7D" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal/temporal-entity-by-id-spec.json#/paths/%2Ftemporal%2Fentities%2F%7BentityId%7D" }, "/temporal/entities/{entityId}/attrs/": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal/temporal-entity-attrs-spec.json#/paths/%2Ftemporal%2Fentities%2F%7BentityId%7D%2Fattrs%2F" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal/temporal-entity-attrs-spec.json#/paths/%2Ftemporal%2Fentities%2F%7BentityId%7D%2Fattrs%2F" }, "/temporal/entities/{entityId}/attrs/{attrId}": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal/temporal-entity-attrs-spec.json#/paths/%2Ftemporal%2Fentities%2F%7BentityId%7D%2Fattrs%2F%7BattrId%7D" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal/temporal-entity-attrs-spec.json#/paths/%2Ftemporal%2Fentities%2F%7BentityId%7D%2Fattrs%2F%7BattrId%7D" }, "/temporal/entities/{entityId}/attrs/{attrId}/{instanceId}": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal/temporal-entity-attrs-spec.json#/paths/%2Ftemporal%2Fentities%2F%7BentityId%7D%2Fattrs%2F%7BattrId%7D%2F%7BinstanceId%7D" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal/temporal-entity-attrs-spec.json#/paths/%2Ftemporal%2Fentities%2F%7BentityId%7D%2Fattrs%2F%7BattrId%7D%2F%7BinstanceId%7D" } } } diff --git a/spec/updated/subscription-by-id-spec.json b/spec/updated/subscription-by-id-spec.json index ea163c2..ffcc76d 100644 --- a/spec/updated/subscription-by-id-spec.json +++ b/spec/updated/subscription-by-id-spec.json @@ -35,11 +35,11 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/subscriptions/Subscription.json#/definitions/Subscription" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/subscriptions/Subscription.json#/definitions/Subscription" }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/Subscription-example_C.4.json" + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/Subscription-example_C.4.json" } } } @@ -50,7 +50,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -60,7 +60,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -81,7 +81,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/subscriptions/Subscription.json#/definitions/SubscriptionFragment" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/subscriptions/Subscription.json#/definitions/SubscriptionFragment" } } } @@ -95,7 +95,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -105,7 +105,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -130,7 +130,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -140,7 +140,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } diff --git a/spec/updated/subscriptions-spec.json b/spec/updated/subscriptions-spec.json index 669845b..e8a79d4 100644 --- a/spec/updated/subscriptions-spec.json +++ b/spec/updated/subscriptions-spec.json @@ -37,11 +37,11 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/subscriptions/SubscriptionList.json#/definitions/SubscriptionList" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/subscriptions/SubscriptionList.json#/definitions/SubscriptionList" }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/SubscriptionList-example.json" + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/SubscriptionList-example.json" } } } @@ -52,7 +52,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -70,7 +70,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/subscriptions/Subscription.json#/definitions/Subscription" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/subscriptions/Subscription.json#/definitions/Subscription" } } } @@ -84,7 +84,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -94,7 +94,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } diff --git a/spec/updated/temporal/temporal-entities-spec.json b/spec/updated/temporal/temporal-entities-spec.json index c87695d..2f21ace 100644 --- a/spec/updated/temporal/temporal-entities-spec.json +++ b/spec/updated/temporal/temporal-entities-spec.json @@ -12,7 +12,7 @@ "in": "query", "required": false, "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/timerel" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/timerel" } }, "time": { @@ -41,7 +41,7 @@ "in": "query", "required": false, "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" } }, "lastN": { @@ -77,31 +77,31 @@ "tags": ["Temporal Evolution"], "parameters": [ { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/id" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/id" }, { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/idPattern" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/idPattern" }, { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/type" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/type" }, { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/attrs" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/attrs" }, { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/q" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/q" }, { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/georel" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/georel" }, { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/geometry" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/geometry" }, { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/coordinates" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/coordinates" }, { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/geoproperty" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/geoproperty" }, { "$ref": "#/components/parameters/timerel" @@ -116,10 +116,10 @@ "$ref": "#/components/parameters/endTime" }, { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/csf" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/csf" }, { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/limit" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/limit" }, { "$ref": "#/components/parameters/options" @@ -134,11 +134,11 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/temporal/EntityTemporalList.json#/definitions/EntityTemporalList" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/temporal/EntityTemporalList.json#/definitions/EntityTemporalList" }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/EntityTemporalList-example.json" + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/EntityTemporalList-example.json" } } } @@ -149,7 +149,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -165,11 +165,11 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/temporal/EntityTemporal.json#/definitions/EntityTemporal" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/temporal/EntityTemporal.json#/definitions/EntityTemporal" }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/EntityTemporal-example_C5.5.3.json" + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/EntityTemporal-example_C5.5.3.json" } } } @@ -187,7 +187,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -197,7 +197,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -207,7 +207,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } diff --git a/spec/updated/temporal/temporal-entity-attrs-spec.json b/spec/updated/temporal/temporal-entity-attrs-spec.json index 2059cb2..8533bd9 100644 --- a/spec/updated/temporal/temporal-entity-attrs-spec.json +++ b/spec/updated/temporal/temporal-entity-attrs-spec.json @@ -22,7 +22,7 @@ "in": "path", "required": true, "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" } }, "instanceId": { @@ -53,7 +53,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/temporal/EntityTemporal.json#/definitions/EntityTemporalFragment" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/temporal/EntityTemporal.json#/definitions/EntityTemporalFragment" } } } @@ -67,7 +67,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -77,7 +77,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -107,7 +107,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -117,7 +117,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -146,7 +146,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/temporal/EntityTemporal.json#/definitions/EntityTemporalFragment" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/temporal/EntityTemporal.json#/definitions/EntityTemporalFragment" } } } @@ -160,7 +160,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -170,7 +170,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -201,7 +201,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -211,7 +211,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } diff --git a/spec/updated/temporal/temporal-entity-by-id-spec.json b/spec/updated/temporal/temporal-entity-by-id-spec.json index 07e14f0..71e0b25 100644 --- a/spec/updated/temporal/temporal-entity-by-id-spec.json +++ b/spec/updated/temporal/temporal-entity-by-id-spec.json @@ -14,31 +14,31 @@ "tags": ["Temporal Evolution"], "parameters": [ { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-by-id-spec.json#/components/parameters/entityId" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-by-id-spec.json#/components/parameters/entityId" }, { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-by-id-spec.json#/components/parameters/attrs" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-by-id-spec.json#/components/parameters/attrs" }, { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-by-id-spec.json#/components/parameters/type" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-by-id-spec.json#/components/parameters/type" }, { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal/temporal-entities-spec.json#/components/parameters/options" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal/temporal-entities-spec.json#/components/parameters/options" }, { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal/temporal-entities-spec.json#/components/parameters/timerel" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal/temporal-entities-spec.json#/components/parameters/timerel" }, { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal/temporal-entities-spec.json#/components/parameters/timeproperty" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal/temporal-entities-spec.json#/components/parameters/timeproperty" }, { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal/temporal-entities-spec.json#/components/parameters/time" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal/temporal-entities-spec.json#/components/parameters/time" }, { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal/temporal-entities-spec.json#/components/parameters/endTime" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal/temporal-entities-spec.json#/components/parameters/endTime" }, { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal/temporal-entities-spec.json#/components/parameters/lastN" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal/temporal-entities-spec.json#/components/parameters/lastN" } ], "responses": { @@ -47,11 +47,11 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/temporal/EntityTemporal.json#/definitions/EntityTemporal" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/temporal/EntityTemporal.json#/definitions/EntityTemporal" }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/EntityTemporal-example_C5.5.3.json" + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/EntityTemporal-example_C5.5.3.json" } } } @@ -62,7 +62,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -72,7 +72,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -85,10 +85,10 @@ "tags": ["Temporal Evolution"], "parameters": [ { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-by-id-spec.json#/components/parameters/entityId" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-by-id-spec.json#/components/parameters/entityId" }, { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-by-id-spec.json#/components/parameters/type" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-by-id-spec.json#/components/parameters/type" } ], "responses": { @@ -100,7 +100,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -110,7 +110,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } diff --git a/yarn.lock b/yarn.lock new file mode 100644 index 0000000..2a72bf4 --- /dev/null +++ b/yarn.lock @@ -0,0 +1,352 @@ +# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. +# yarn lockfile v1 + + +"@apidevtools/json-schema-ref-parser@^9.0.6": + version "9.0.6" + resolved "https://registry.yarnpkg.com/@apidevtools/json-schema-ref-parser/-/json-schema-ref-parser-9.0.6.tgz#5d9000a3ac1fd25404da886da6b266adcd99cf1c" + integrity sha512-M3YgsLjI0lZxvrpeGVk9Ap032W6TPQkH6pRAZz81Ac3WUNF79VQooAFnp8umjvVzUmD93NkogxEwbSce7qMsUg== + dependencies: + "@jsdevtools/ono" "^7.1.3" + call-me-maybe "^1.0.1" + js-yaml "^3.13.1" + +"@apidevtools/openapi-schemas@^2.0.4": + version "2.0.4" + resolved "https://registry.yarnpkg.com/@apidevtools/openapi-schemas/-/openapi-schemas-2.0.4.tgz#bae1cef77ebb2b3705c7cc6911281da5153c1ab3" + integrity sha512-ob5c4UiaMYkb24pNhvfSABShAwpREvUGCkqjiz/BX9gKZ32y/S22M+ALIHftTAuv9KsFVSpVdIDzi9ZzFh5TCA== + +"@apidevtools/swagger-cli@4.0.4": + version "4.0.4" + resolved "https://registry.yarnpkg.com/@apidevtools/swagger-cli/-/swagger-cli-4.0.4.tgz#c645c291f56e4add583111aca9edeee23d60fa10" + integrity sha512-hdDT3B6GLVovCsRZYDi3+wMcB1HfetTU20l2DC8zD3iFRNMC6QNAZG5fo/6PYeHWBEv7ri4MvnlKodhNB0nt7g== + dependencies: + "@apidevtools/swagger-parser" "^10.0.1" + chalk "^4.1.0" + js-yaml "^3.14.0" + yargs "^15.4.1" + +"@apidevtools/swagger-methods@^3.0.2": + version "3.0.2" + resolved "https://registry.yarnpkg.com/@apidevtools/swagger-methods/-/swagger-methods-3.0.2.tgz#b789a362e055b0340d04712eafe7027ddc1ac267" + integrity sha512-QAkD5kK2b1WfjDS/UQn/qQkbwF31uqRjPTrsCs5ZG9BQGAkjwvqGFjjPqAuzac/IYzpPtRzjCP1WrTuAIjMrXg== + +"@apidevtools/swagger-parser@^10.0.1": + version "10.0.2" + resolved "https://registry.yarnpkg.com/@apidevtools/swagger-parser/-/swagger-parser-10.0.2.tgz#f4145afb7c3a3bafe0376f003b5c3bdeae17a952" + integrity sha512-JFxcEyp8RlNHgBCE98nwuTkZT6eNFPc1aosWV6wPcQph72TSEEu1k3baJD4/x1qznU+JiDdz8F5pTwabZh+Dhg== + dependencies: + "@apidevtools/json-schema-ref-parser" "^9.0.6" + "@apidevtools/openapi-schemas" "^2.0.4" + "@apidevtools/swagger-methods" "^3.0.2" + "@jsdevtools/ono" "^7.1.3" + call-me-maybe "^1.0.1" + z-schema "^4.2.3" + +"@jsdevtools/ono@^7.1.3": + version "7.1.3" + resolved "https://registry.yarnpkg.com/@jsdevtools/ono/-/ono-7.1.3.tgz#9df03bbd7c696a5c58885c34aa06da41c8543796" + integrity sha512-4JQNk+3mVzK3xh2rqd6RB4J46qUR19azEHBneZyTZM+c456qOrbbM/5xcR8huNCCcbVt7+UmizG6GuUvPvKUYg== + +"@types/color-name@^1.1.1": + version "1.1.1" + resolved "https://registry.yarnpkg.com/@types/color-name/-/color-name-1.1.1.tgz#1c1261bbeaa10a8055bbc5d8ab84b7b2afc846a0" + integrity sha512-rr+OQyAjxze7GgWrSaJwydHStIhHq2lvY3BOC2Mj7KnzI7XK0Uw1TOOdI9lDoajEbSWLiYgoo4f1R51erQfhPQ== + +ajv@^6.12.5: + version "6.12.5" + resolved "https://registry.yarnpkg.com/ajv/-/ajv-6.12.5.tgz#19b0e8bae8f476e5ba666300387775fb1a00a4da" + integrity sha512-lRF8RORchjpKG50/WFf8xmg7sgCLFiYNNnqdKflk63whMQcWR5ngGjiSXkL9bjxy6B2npOK2HSMN49jEBMSkag== + dependencies: + fast-deep-equal "^3.1.1" + fast-json-stable-stringify "^2.0.0" + json-schema-traverse "^0.4.1" + uri-js "^4.2.2" + +ansi-regex@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-5.0.0.tgz#388539f55179bf39339c81af30a654d69f87cb75" + integrity sha512-bY6fj56OUQ0hU1KjFNDQuJFezqKdrAyFdIevADiqrWHwSlbmBNMHp5ak2f40Pm8JTFyM2mqxkG6ngkHO11f/lg== + +ansi-styles@^4.0.0, ansi-styles@^4.1.0: + version "4.2.1" + resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-4.2.1.tgz#90ae75c424d008d2624c5bf29ead3177ebfcf359" + integrity sha512-9VGjrMsG1vePxcSweQsN20KY/c4zN0h9fLjqAbwbPfahM3t+NL+M9HC8xeXG2I8pX5NoamTGNuomEUFI7fcUjA== + dependencies: + "@types/color-name" "^1.1.1" + color-convert "^2.0.1" + +argparse@^1.0.7: + version "1.0.10" + resolved "https://registry.yarnpkg.com/argparse/-/argparse-1.0.10.tgz#bcd6791ea5ae09725e17e5ad988134cd40b3d911" + integrity sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg== + dependencies: + sprintf-js "~1.0.2" + +call-me-maybe@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/call-me-maybe/-/call-me-maybe-1.0.1.tgz#26d208ea89e37b5cbde60250a15f031c16a4d66b" + integrity sha1-JtII6onje1y95gJQoV8DHBak1ms= + +camelcase@^5.0.0: + version "5.3.1" + resolved "https://registry.yarnpkg.com/camelcase/-/camelcase-5.3.1.tgz#e3c9b31569e106811df242f715725a1f4c494320" + integrity sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg== + +chalk@^4.1.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/chalk/-/chalk-4.1.0.tgz#4e14870a618d9e2edd97dd8345fd9d9dc315646a" + integrity sha512-qwx12AxXe2Q5xQ43Ac//I6v5aXTipYrSESdOgzrN+9XjgEpyjpKuvSGaN4qE93f7TQTlerQQ8S+EQ0EyDoVL1A== + dependencies: + ansi-styles "^4.1.0" + supports-color "^7.1.0" + +cliui@^6.0.0: + version "6.0.0" + resolved "https://registry.yarnpkg.com/cliui/-/cliui-6.0.0.tgz#511d702c0c4e41ca156d7d0e96021f23e13225b1" + integrity sha512-t6wbgtoCXvAzst7QgXxJYqPt0usEfbgQdftEPbLL/cvv6HPE5VgvqCuAIDR0NgU52ds6rFwqrgakNLrHEjCbrQ== + dependencies: + string-width "^4.2.0" + strip-ansi "^6.0.0" + wrap-ansi "^6.2.0" + +color-convert@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/color-convert/-/color-convert-2.0.1.tgz#72d3a68d598c9bdb3af2ad1e84f21d896abd4de3" + integrity sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ== + dependencies: + color-name "~1.1.4" + +color-name@~1.1.4: + version "1.1.4" + resolved "https://registry.yarnpkg.com/color-name/-/color-name-1.1.4.tgz#c2a09a87acbde69543de6f63fa3995c826c536a2" + integrity sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA== + +commander@^2.7.1: + version "2.20.3" + resolved "https://registry.yarnpkg.com/commander/-/commander-2.20.3.tgz#fd485e84c03eb4881c20722ba48035e8531aeb33" + integrity sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ== + +decamelize@^1.2.0: + version "1.2.0" + resolved "https://registry.yarnpkg.com/decamelize/-/decamelize-1.2.0.tgz#f6534d15148269b20352e7bee26f501f9a191290" + integrity sha1-9lNNFRSCabIDUue+4m9QH5oZEpA= + +emoji-regex@^8.0.0: + version "8.0.0" + resolved "https://registry.yarnpkg.com/emoji-regex/-/emoji-regex-8.0.0.tgz#e818fd69ce5ccfcb404594f842963bf53164cc37" + integrity sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A== + +esprima@^4.0.0: + version "4.0.1" + resolved "https://registry.yarnpkg.com/esprima/-/esprima-4.0.1.tgz#13b04cdb3e6c5d19df91ab6987a8695619b0aa71" + integrity sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A== + +fast-deep-equal@^3.1.1: + version "3.1.3" + resolved "https://registry.yarnpkg.com/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz#3a7d56b559d6cbc3eb512325244e619a65c6c525" + integrity sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q== + +fast-json-stable-stringify@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz#874bf69c6f404c2b5d99c481341399fd55892633" + integrity sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw== + +find-up@^4.1.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/find-up/-/find-up-4.1.0.tgz#97afe7d6cdc0bc5928584b7c8d7b16e8a9aa5d19" + integrity sha512-PpOwAdQ/YlXQ2vj8a3h8IipDuYRi3wceVQQGYWxNINccq40Anw7BlsEXCMbt1Zt+OLA6Fq9suIpIWD0OsnISlw== + dependencies: + locate-path "^5.0.0" + path-exists "^4.0.0" + +get-caller-file@^2.0.1: + version "2.0.5" + resolved "https://registry.yarnpkg.com/get-caller-file/-/get-caller-file-2.0.5.tgz#4f94412a82db32f36e3b0b9741f8a97feb031f7e" + integrity sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg== + +has-flag@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/has-flag/-/has-flag-4.0.0.tgz#944771fd9c81c81265c4d6941860da06bb59479b" + integrity sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ== + +is-fullwidth-code-point@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz#f116f8064fe90b3f7844a38997c0b75051269f1d" + integrity sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg== + +js-yaml@^3.13.1, js-yaml@^3.14.0: + version "3.14.0" + resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-3.14.0.tgz#a7a34170f26a21bb162424d8adacb4113a69e482" + integrity sha512-/4IbIeHcD9VMHFqDR/gQ7EdZdLimOvW2DdcxFjdyyZ9NsbS+ccrXqVWDtab/lRl5AlUqmpBx8EhPaWR+OtY17A== + dependencies: + argparse "^1.0.7" + esprima "^4.0.0" + +json-schema-traverse@^0.4.1: + version "0.4.1" + resolved "https://registry.yarnpkg.com/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz#69f6a87d9513ab8bb8fe63bdb0979c448e684660" + integrity sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg== + +locate-path@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/locate-path/-/locate-path-5.0.0.tgz#1afba396afd676a6d42504d0a67a3a7eb9f62aa0" + integrity sha512-t7hw9pI+WvuwNJXwk5zVHpyhIqzg2qTlklJOf0mVxGSbe3Fp2VieZcduNYjaLDoy6p9uGpQEGWG87WpMKlNq8g== + dependencies: + p-locate "^4.1.0" + +lodash.get@^4.4.2: + version "4.4.2" + resolved "https://registry.yarnpkg.com/lodash.get/-/lodash.get-4.4.2.tgz#2d177f652fa31e939b4438d5341499dfa3825e99" + integrity sha1-LRd/ZS+jHpObRDjVNBSZ36OCXpk= + +lodash.isequal@^4.5.0: + version "4.5.0" + resolved "https://registry.yarnpkg.com/lodash.isequal/-/lodash.isequal-4.5.0.tgz#415c4478f2bcc30120c22ce10ed3226f7d3e18e0" + integrity sha1-QVxEePK8wwEgwizhDtMib30+GOA= + +p-limit@^2.2.0: + version "2.3.0" + resolved "https://registry.yarnpkg.com/p-limit/-/p-limit-2.3.0.tgz#3dd33c647a214fdfffd835933eb086da0dc21db1" + integrity sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w== + dependencies: + p-try "^2.0.0" + +p-locate@^4.1.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/p-locate/-/p-locate-4.1.0.tgz#a3428bb7088b3a60292f66919278b7c297ad4f07" + integrity sha512-R79ZZ/0wAxKGu3oYMlz8jy/kbhsNrS7SKZ7PxEHBgJ5+F2mtFW2fK2cOtBh1cHYkQsbzFV7I+EoRKe6Yt0oK7A== + dependencies: + p-limit "^2.2.0" + +p-try@^2.0.0: + version "2.2.0" + resolved "https://registry.yarnpkg.com/p-try/-/p-try-2.2.0.tgz#cb2868540e313d61de58fafbe35ce9004d5540e6" + integrity sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ== + +path-exists@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/path-exists/-/path-exists-4.0.0.tgz#513bdbe2d3b95d7762e8c1137efa195c6c61b5b3" + integrity sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w== + +punycode@^2.1.0: + version "2.1.1" + resolved "https://registry.yarnpkg.com/punycode/-/punycode-2.1.1.tgz#b58b010ac40c22c5657616c8d2c2c02c7bf479ec" + integrity sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A== + +require-directory@^2.1.1: + version "2.1.1" + resolved "https://registry.yarnpkg.com/require-directory/-/require-directory-2.1.1.tgz#8c64ad5fd30dab1c976e2344ffe7f792a6a6df42" + integrity sha1-jGStX9MNqxyXbiNE/+f3kqam30I= + +require-main-filename@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/require-main-filename/-/require-main-filename-2.0.0.tgz#d0b329ecc7cc0f61649f62215be69af54aa8989b" + integrity sha512-NKN5kMDylKuldxYLSUfrbo5Tuzh4hd+2E8NPPX02mZtn1VuREQToYe/ZdlJy+J3uCpfaiGF05e7B8W0iXbQHmg== + +set-blocking@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/set-blocking/-/set-blocking-2.0.0.tgz#045f9782d011ae9a6803ddd382b24392b3d890f7" + integrity sha1-BF+XgtARrppoA93TgrJDkrPYkPc= + +sprintf-js@~1.0.2: + version "1.0.3" + resolved "https://registry.yarnpkg.com/sprintf-js/-/sprintf-js-1.0.3.tgz#04e6926f662895354f3dd015203633b857297e2c" + integrity sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw= + +string-width@^4.1.0, string-width@^4.2.0: + version "4.2.0" + resolved "https://registry.yarnpkg.com/string-width/-/string-width-4.2.0.tgz#952182c46cc7b2c313d1596e623992bd163b72b5" + integrity sha512-zUz5JD+tgqtuDjMhwIg5uFVV3dtqZ9yQJlZVfq4I01/K5Paj5UHj7VyrQOJvzawSVlKpObApbfD0Ed6yJc+1eg== + dependencies: + emoji-regex "^8.0.0" + is-fullwidth-code-point "^3.0.0" + strip-ansi "^6.0.0" + +strip-ansi@^6.0.0: + version "6.0.0" + resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-6.0.0.tgz#0b1571dd7669ccd4f3e06e14ef1eed26225ae532" + integrity sha512-AuvKTrTfQNYNIctbR1K/YGTR1756GycPsg7b9bdV9Duqur4gv6aKqHXah67Z8ImS7WEz5QVcOtlfW2rZEugt6w== + dependencies: + ansi-regex "^5.0.0" + +supports-color@^7.1.0: + version "7.2.0" + resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-7.2.0.tgz#1b7dcdcb32b8138801b3e478ba6a51caa89648da" + integrity sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw== + dependencies: + has-flag "^4.0.0" + +swagger-cli@^4.0.4: + version "4.0.4" + resolved "https://registry.yarnpkg.com/swagger-cli/-/swagger-cli-4.0.4.tgz#c3f0b94277073c776b9bcc3ae7507b372f3ff414" + integrity sha512-Cp8YYuLny3RJFQ4CvOBTaqmOOgYsem52dPx1xM5S4EUWFblIh2Q8atppMZvXKUr1e9xH5RwipYpmdUzdPcxWcA== + dependencies: + "@apidevtools/swagger-cli" "4.0.4" + +uri-js@^4.2.2: + version "4.4.0" + resolved "https://registry.yarnpkg.com/uri-js/-/uri-js-4.4.0.tgz#aa714261de793e8a82347a7bcc9ce74e86f28602" + integrity sha512-B0yRTzYdUCCn9n+F4+Gh4yIDtMQcaJsmYBDsTSG8g/OejKBodLQ2IHfN3bM7jUsRXndopT7OIXWdYqc1fjmV6g== + dependencies: + punycode "^2.1.0" + +validator@^12.0.0: + version "12.2.0" + resolved "https://registry.yarnpkg.com/validator/-/validator-12.2.0.tgz#660d47e96267033fd070096c3b1a6f2db4380a0a" + integrity sha512-jJfE/DW6tIK1Ek8nCfNFqt8Wb3nzMoAbocBF6/Icgg1ZFSBpObdnwVY2jQj6qUqzhx5jc71fpvBWyLGO7Xl+nQ== + +which-module@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/which-module/-/which-module-2.0.0.tgz#d9ef07dce77b9902b8a3a8fa4b31c3e3f7e6e87a" + integrity sha1-2e8H3Od7mQK4o6j6SzHD4/fm6Ho= + +wrap-ansi@^6.2.0: + version "6.2.0" + resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-6.2.0.tgz#e9393ba07102e6c91a3b221478f0257cd2856e53" + integrity sha512-r6lPcBGxZXlIcymEu7InxDMhdW0KDxpLgoFLcguasxCaJ/SOIZwINatK9KY/tf+ZrlywOKU0UDj3ATXUBfxJXA== + dependencies: + ansi-styles "^4.0.0" + string-width "^4.1.0" + strip-ansi "^6.0.0" + +y18n@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/y18n/-/y18n-4.0.0.tgz#95ef94f85ecc81d007c264e190a120f0a3c8566b" + integrity sha512-r9S/ZyXu/Xu9q1tYlpsLIsa3EeLXXk0VwlxqTcFRfg9EhMW+17kbt9G0NrgCmhGb5vT2hyhJZLfDGx+7+5Uj/w== + +yargs-parser@^18.1.2: + version "18.1.3" + resolved "https://registry.yarnpkg.com/yargs-parser/-/yargs-parser-18.1.3.tgz#be68c4975c6b2abf469236b0c870362fab09a7b0" + integrity sha512-o50j0JeToy/4K6OZcaQmW6lyXXKhq7csREXcDwk2omFPJEwUNOVtJKvmDr9EI1fAJZUyZcRF7kxGBWmRXudrCQ== + dependencies: + camelcase "^5.0.0" + decamelize "^1.2.0" + +yargs@^15.4.1: + version "15.4.1" + resolved "https://registry.yarnpkg.com/yargs/-/yargs-15.4.1.tgz#0d87a16de01aee9d8bec2bfbf74f67851730f4f8" + integrity sha512-aePbxDmcYW++PaqBsJ+HYUFwCdv4LVvdnhBy78E57PIor8/OVvhMrADFFEDh8DHDFRv/O9i3lPhsENjO7QX0+A== + dependencies: + cliui "^6.0.0" + decamelize "^1.2.0" + find-up "^4.1.0" + get-caller-file "^2.0.1" + require-directory "^2.1.1" + require-main-filename "^2.0.0" + set-blocking "^2.0.0" + string-width "^4.2.0" + which-module "^2.0.0" + y18n "^4.0.0" + yargs-parser "^18.1.2" + +z-schema@^4.2.3: + version "4.2.3" + resolved "https://registry.yarnpkg.com/z-schema/-/z-schema-4.2.3.tgz#85f7eea7e6d4fe59a483462a98f511bd78fe9882" + integrity sha512-zkvK/9TC6p38IwcrbnT3ul9in1UX4cm1y/VZSs4GHKIiDCrlafc+YQBgQBUdDXLAoZHf2qvQ7gJJOo6yT1LH6A== + dependencies: + lodash.get "^4.4.2" + lodash.isequal "^4.5.0" + validator "^12.0.0" + optionalDependencies: + commander "^2.7.1" -- GitLab