From 0e59f0b64997251af55e2e8aa855670e560a3fbf Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Fri, 29 Jan 2021 13:52:23 +0100 Subject: [PATCH 01/43] add type --- schema/geometry-schema.json | 218 +++++++++++++++++++++++------------- 1 file changed, 141 insertions(+), 77 deletions(-) diff --git a/schema/geometry-schema.json b/schema/geometry-schema.json index ef23a8b..2cd6797 100644 --- a/schema/geometry-schema.json +++ b/schema/geometry-schema.json @@ -1,91 +1,155 @@ { - "$schema": "http://json-schema.org/draft-04/schema#", - "$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", - "required": [ "type", "coordinates" ], - "oneOf": [ - { - "title": "Point", - "properties": { - "type": { "enum": [ "Point" ] }, - "coordinates": { "$ref": "#/definitions/position" } - } + "$schema": "http://json-schema.org/draft-04/schema#", + "$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", + "required": [ + "type", + "coordinates" + ], + "oneOf": [ + { + "title": "Point", + "properties": { + "type": { + "type": "string", + "enum": [ + "Point" + ] }, - { - "title": "MultiPoint", - "properties": { - "type": { "enum": [ "MultiPoint" ] }, - "coordinates": { "$ref": "#/definitions/positionArray" } - } + "coordinates": { + "$ref": "#/definitions/position" + } + } + }, + { + "title": "MultiPoint", + "properties": { + "type": { + "type": "string", + "enum": [ + "MultiPoint" + ] }, - { - "title": "LineString", - "properties": { - "type": { "enum": [ "LineString" ] }, - "coordinates": { "$ref": "#/definitions/lineString" } - } + "coordinates": { + "$ref": "#/definitions/positionArray" + } + } + }, + { + "title": "LineString", + "properties": { + "type": { + "type": "string", + "enum": [ + "LineString" + ] }, - { - "title": "MultiLineString", - "properties": { - "type": { "enum": [ "MultiLineString" ] }, - "coordinates": { - "type": "array", - "items": { "$ref": "#/definitions/lineString" } - } - } + "coordinates": { + "$ref": "#/definitions/lineString" + } + } + }, + { + "title": "MultiLineString", + "properties": { + "type": { + "type": "string", + "enum": [ + "MultiLineString" + ] }, - { - "title": "Polygon", - "properties": { - "type": { "enum": [ "Polygon" ] }, - "coordinates": { "$ref": "#/definitions/polygon" } - } + "coordinates": { + "type": "array", + "items": { + "$ref": "#/definitions/lineString" + } + } + } + }, + { + "title": "Polygon", + "properties": { + "type": { + "type": "string", + "enum": [ + "Polygon" + ] }, - { - "title": "MultiPolygon", - "properties": { - "type": { "enum": [ "MultiPolygon" ] }, - "coordinates": { - "type": "array", - "items": { "$ref": "#/definitions/polygon" } - } - } + "coordinates": { + "$ref": "#/definitions/polygon" } - ], - "definitions": { - "position": { - "description": "A single position", - "type": "array", - "minItems": 2, - "items": [ { "type": "number" }, { "type": "number" } ], - "additionalItems": false + } + }, + { + "title": "MultiPolygon", + "properties": { + "type": { + "type": "string", + "enum": [ + "MultiPolygon" + ] }, - "positionArray": { - "description": "An array of positions", - "type": "array", - "items": { "$ref": "#/definitions/position" } + "coordinates": { + "type": "array", + "items": { + "$ref": "#/definitions/polygon" + } + } + } + } + ], + "definitions": { + "position": { + "description": "A single position", + "type": "array", + "minItems": 2, + "items": [ + { + "type": "number" }, - "lineString": { - "description": "An array of two or more positions", - "allOf": [ - { "$ref": "#/definitions/positionArray" }, - { "minItems": 2 } - ] + { + "type": "number" + } + ], + "additionalItems": false + }, + "positionArray": { + "description": "An array of positions", + "type": "array", + "items": { + "$ref": "#/definitions/position" + } + }, + "lineString": { + "description": "An array of two or more positions", + "allOf": [ + { + "$ref": "#/definitions/positionArray" }, - "linearRing": { - "description": "An array of four positions where the first equals the last", - "allOf": [ - { "$ref": "#/definitions/positionArray" }, - { "minItems": 4 } - ] + { + "minItems": 2 + } + ] + }, + "linearRing": { + "description": "An array of four positions where the first equals the last", + "allOf": [ + { + "$ref": "#/definitions/positionArray" }, - "polygon": { - "description": "An array of linear rings", - "type": "array", - "items": { "$ref": "#/definitions/linearRing" } + { + "minItems": 4 } + ] + }, + "polygon": { + "description": "An array of linear rings", + "type": "array", + "items": { + "$ref": "#/definitions/linearRing" + } } + } } -- GitLab From b4d17d3538ac79006a1e8631be5364acd2f5cfcd Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Fri, 29 Jan 2021 13:56:56 +0100 Subject: [PATCH 02/43] try to fix --- schema/registrations/ContextSourceRegistration.json | 6 +++--- spec/updated/csource-registrations-spec.json | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/schema/registrations/ContextSourceRegistration.json b/schema/registrations/ContextSourceRegistration.json index 0268021..bf937ed 100644 --- a/schema/registrations/ContextSourceRegistration.json +++ b/schema/registrations/ContextSourceRegistration.json @@ -73,13 +73,13 @@ "$ref": "#/definitions/TimeInterval" }, "location": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json#" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/fix-spec/schema/geometry-schema.json#" }, "observationSpace": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json#" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/fix-spec/schema/geometry-schema.json#" }, "operationSpace": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json#" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/fix-spec/schema/geometry-schema.json#" }, "expires": { "type": "string", diff --git a/spec/updated/csource-registrations-spec.json b/spec/updated/csource-registrations-spec.json index 6e43c30..6ecfac5 100644 --- a/spec/updated/csource-registrations-spec.json +++ b/spec/updated/csource-registrations-spec.json @@ -83,7 +83,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/registrations/ContextSourceRegistration.json#/definitions/ContextSourceRegistration" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/fix-spec/schema/registrations/ContextSourceRegistration.json#/definitions/ContextSourceRegistration" } } } -- GitLab From 530e7042b375f601b4d61686651a0ba49f085c89 Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Tue, 2 Feb 2021 14:42:31 +0100 Subject: [PATCH 03/43] update api add tools for local dev --- README.md | 18 +++ schema/BatchOperationResult.json | 19 +-- schema/Entity.json | 23 ++- schema/EntityList.json | 12 +- schema/Entity_keyValues.json | 50 ------ .../{geometry-schema.json => Geometry.json} | 152 ++++++++++-------- schema/UpdateResult.json | 21 +-- schema/common.json | 18 +-- schema/registrations/.gitkeep | 0 .../ContextSourceRegistration.json | 23 +-- schema/subscriptions/Notification.json | 8 +- schema/subscriptions/Subscription.json | 6 +- schema/subscriptions/SubscriptionList.json | 12 +- schema/temporal/EntityTemporal.json | 19 +-- schema/temporal/EntityTemporalList.json | 6 +- schema/temporal/Entity_temporalValues.json | 9 +- scripts/runLocalDevEnv.sh | 7 + scripts/setBasePath.sh | 14 ++ spec/updated/csource-registrations-spec.json | 2 +- .../csource-subscription-by-id-spec.json | 2 +- spec/updated/entity-attrs-spec.json | 4 +- spec/updated/entity-operations-spec.json | 8 +- spec/updated/subscription-by-id-spec.json | 2 +- 23 files changed, 206 insertions(+), 229 deletions(-) delete mode 100644 schema/Entity_keyValues.json rename schema/{geometry-schema.json => Geometry.json} (74%) delete mode 100644 schema/registrations/.gitkeep create mode 100755 scripts/runLocalDevEnv.sh create mode 100755 scripts/setBasePath.sh diff --git a/README.md b/README.md index 3d02808..8fe3c1e 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,24 @@ More info @ [CONTIBUTE](./CONTRIBUTE.md) Change requests are managed using [Gerrit](https://forge.etsi.org/gerrit). +### Local editing +>:warning: The described setup requires [docker](https://docs.docker.com/engine/install/) to be installed. + +In order to edit the api locally, the script [runLocalDevEnv.sh](scripts/runLocalDevEnv.sh) can be used. When executed from the root of this repository, +it replaces all paths to the master branch inside [spec](spec) and [schema](schema) and serves them through a local file-server. Without that, all +references are resolved with 'https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master' and therefore changes will not be present locally. + +With the local file-server still running, you can build the bundled api via: +``` +docker run --network host -it -v ${PWD}/:/data broothie/redoc-cli bundle spec/updated/ngsi-ld-spec-open-api.json -o spec/updated/full_api.json +``` +And validate it with: +``` +docker run --network host --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/full_api.json +``` + +When editing is finished, hit the enter button on your local dev env and push. + ## Report issues To report issues, bugs or requests please fill in a bug [at this location](https://forge.etsi.org/bugzilla/enter_bug.cgi?product=NGSI-LD). diff --git a/schema/BatchOperationResult.json b/schema/BatchOperationResult.json index bbc1c35..04fba47 100644 --- a/schema/BatchOperationResult.json +++ b/schema/BatchOperationResult.json @@ -1,16 +1,17 @@ { - "$schema": "http://json-schema.org/schema#", - "$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": { "BatchEntityError": { - "entityId": { - "type": "string", - "format": "uri" - }, - "error": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "type": "object", + "properties": { + "entityId": { + "type": "string", + "format": "uri" + }, + "error": { + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + } } }, "BatchOperationResult": { @@ -37,4 +38,4 @@ "$ref": "#/definitions/BatchOperationResult" } ] -} +} \ No newline at end of file diff --git a/schema/Entity.json b/schema/Entity.json index f04c32c..2478215 100644 --- a/schema/Entity.json +++ b/schema/Entity.json @@ -1,6 +1,4 @@ { - "$schema": "http://json-schema.org/schema#", - "$id": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json", "title": "NGSI-LD Entity", "description": "NGSI-LD Entity", "definitions": { @@ -17,10 +15,10 @@ "properties": { "type": { "type": "string", - "const": "Property" + "enum": ["Property"] }, "value": { - "type": [ + "oneOf": [ "string", "number", "boolean", @@ -49,7 +47,7 @@ "value" ], "additionalProperties": { - "anyOf": [ + "oneOf": [ { "$ref": "#/definitions/Property" }, @@ -64,7 +62,7 @@ "properties": { "type": { "type": "string", - "const": "Relationship" + "enum": ["Relationship"] }, "object": { "type": "string", @@ -91,7 +89,7 @@ "object" ], "additionalProperties": { - "anyOf": [ + "oneOf": [ { "$ref": "#/definitions/Property" }, @@ -106,10 +104,10 @@ "properties": { "type": { "type": "string", - "const": "GeoProperty" + "enum": ["GeoProperty"] }, "value": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json#" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Geometry.json#/definitions/Geometry" }, "observedAt": { "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/observedAt" @@ -132,7 +130,7 @@ "value" ], "additionalProperties": { - "anyOf": [ + "oneOf": [ { "$ref": "#/definitions/Property" }, @@ -172,7 +170,7 @@ } }, "additionalProperties": { - "anyOf": [ + "oneOf": [ { "$ref": "#/definitions/Property" }, @@ -183,9 +181,6 @@ "$ref": "#/definitions/GeoProperty" } ] - }, - "propertyNames": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/PropertyNames" } }, "Entity": { diff --git a/schema/EntityList.json b/schema/EntityList.json index bbe3817..a3fca84 100644 --- a/schema/EntityList.json +++ b/schema/EntityList.json @@ -1,6 +1,4 @@ { - "$schema": "http://json-schema.org/schema#", - "$id": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/EntityList.json", "title": "NGSI-LD EntityList", "description": "NGSI-LD EntityList", "definitions": { @@ -11,7 +9,9 @@ } } }, - "allOf": [{ - "$ref": "#/definitions/EntityList" - }] -} + "allOf": [ + { + "$ref": "#/definitions/EntityList" + } + ] +} \ No newline at end of file diff --git a/schema/Entity_keyValues.json b/schema/Entity_keyValues.json deleted file mode 100644 index c9a0342..0000000 --- a/schema/Entity_keyValues.json +++ /dev/null @@ -1,50 +0,0 @@ -{ - "$schema": "http://json-schema.org/schema#", - "$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", - "properties": { - "id": { - "type": "string", - "format": "uri" - }, - "type": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" - }, - "@context": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/LdContext" - }, - "location": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json#" - }, - "observationSpace": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json#" - }, - "operationSpace": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json#" - }, - "createdAt": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/createdAt" - }, - "modifiedAt": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/modifiedAt" - } - }, - "required": [ - "type", - "id" - ], - "additionalProperties": { - "type": [ - "string", - "number", - "boolean", - "array", - "object" - ] - }, - "propertyNames": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/PropertyNames" - } -} diff --git a/schema/geometry-schema.json b/schema/Geometry.json similarity index 74% rename from schema/geometry-schema.json rename to schema/Geometry.json index 2cd6797..f9bcda7 100644 --- a/schema/geometry-schema.json +++ b/schema/Geometry.json @@ -1,16 +1,65 @@ { - "$schema": "http://json-schema.org/draft-04/schema#", - "$id": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json", - "title": "geometry", + "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": [ + "allOf": [ { - "title": "Point", + "$ref": "#/definitions/Geometry" + } + ], + "definitions": { + "position": { + "description": "A single position", + "type": "array", + "minItems": 2, + "maxItems": 2, + "items": { + "type": "number" + }, + "additionalProperties": false + }, + "positionArray": { + "description": "An array of positions", + "type": "array", + "items": { + "$ref": "#/definitions/position" + } + }, + "lineString": { + "description": "An array of two or more positions", + "allOf": [ + { + "$ref": "#/definitions/positionArray" + }, + { + "minItems": 2 + } + ] + }, + "linearRing": { + "description": "An array of four positions where the first equals the last", + "allOf": [ + { + "$ref": "#/definitions/positionArray" + }, + { + "minItems": 4 + } + ] + }, + "polygon": { + "description": "An array of linear rings", + "type": "array", + "items": { + "$ref": "#/definitions/linearRing" + } + }, + "Point": { + "type": "object", "properties": { "type": { "type": "string", @@ -23,8 +72,8 @@ } } }, - { - "title": "MultiPoint", + "MultiPoint": { + "type": "object", "properties": { "type": { "type": "string", @@ -37,53 +86,53 @@ } } }, - { - "title": "LineString", + "Polygon": { + "type": "object", "properties": { "type": { "type": "string", "enum": [ - "LineString" + "Polygon" ] }, "coordinates": { - "$ref": "#/definitions/lineString" + "$ref": "#/definitions/polygon" } } }, - { - "title": "MultiLineString", + "LineString": { + "type": "object", "properties": { "type": { "type": "string", "enum": [ - "MultiLineString" + "LineString" ] }, "coordinates": { - "type": "array", - "items": { - "$ref": "#/definitions/lineString" - } + "$ref": "#/definitions/lineString" } } }, - { - "title": "Polygon", + "MultiLineString": { + "type": "object", "properties": { "type": { "type": "string", "enum": [ - "Polygon" + "MultiLineString" ] }, "coordinates": { - "$ref": "#/definitions/polygon" + "type": "array", + "items": { + "$ref": "#/definitions/lineString" + } } } }, - { - "title": "MultiPolygon", + "MultiPolygon": { + "type": "object", "properties": { "type": { "type": "string", @@ -98,58 +147,29 @@ } } } - } - ], - "definitions": { - "position": { - "description": "A single position", - "type": "array", - "minItems": 2, - "items": [ + }, + "Geometry": { + "description": " Avalid GeoJSON geometry object", + "oneOf": [ { - "type": "number" + "$ref": "#/definitions/Point" }, { - "type": "number" - } - ], - "additionalItems": false - }, - "positionArray": { - "description": "An array of positions", - "type": "array", - "items": { - "$ref": "#/definitions/position" - } - }, - "lineString": { - "description": "An array of two or more positions", - "allOf": [ + "$ref": "#/definitions/MultiPoint" + }, { - "$ref": "#/definitions/positionArray" + "$ref": "#/definitions/Polygon" }, { - "minItems": 2 - } - ] - }, - "linearRing": { - "description": "An array of four positions where the first equals the last", - "allOf": [ + "$ref": "#/definitions/LineString" + }, { - "$ref": "#/definitions/positionArray" + "$ref": "#/definitions/MultiLineString" }, { - "minItems": 4 + "$ref": "#/definitions/MultiPolygon" } ] - }, - "polygon": { - "description": "An array of linear rings", - "type": "array", - "items": { - "$ref": "#/definitions/linearRing" - } } } -} +} \ No newline at end of file diff --git a/schema/UpdateResult.json b/schema/UpdateResult.json index db692eb..193ef58 100644 --- a/schema/UpdateResult.json +++ b/schema/UpdateResult.json @@ -1,17 +1,18 @@ { - "$schema": "http://json-schema.org/schema#", - "$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": { "NotUpdatedDetails": { - "attributeName": { - "type": "string", - "pattern": "" - }, - "reason": { - "type": "string", - "minLenght": 1 + "type": "object", + "properties": { + "attributeName": { + "type": "string", + "pattern": "" + }, + "reason": { + "type": "string", + "minLength": 1 + } } }, "UpdateResult": { @@ -38,4 +39,4 @@ "$ref": "#/definitions/UpdateResult" } ] -} +} \ No newline at end of file diff --git a/schema/common.json b/schema/common.json index 29ea54c..a3214d7 100644 --- a/schema/common.json +++ b/schema/common.json @@ -1,6 +1,4 @@ { - "$schema": "http://json-schema.org/schema#", - "$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": { @@ -27,7 +25,7 @@ "format": "date-time" }, "LdContext": { - "anyOf": [ + "oneOf": [ { "type": "object" }, @@ -39,7 +37,7 @@ "type": "array", "minItems": 1, "items": { - "anyOf": [ + "oneOf": [ { "type": "string", "format": "uri" @@ -109,7 +107,7 @@ ] }, "georel": { - "anyOf": [ + "oneOf": [ { "type": "string", "enum": [ @@ -130,16 +128,16 @@ "coordinates": { "oneOf": [ { - "$ref": "https://forge.etsi.org/rep/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.json#/definitions/position" }, { - "$ref": "https://forge.etsi.org/rep/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.json#/definitions/positionArray" }, { - "$ref": "https://forge.etsi.org/rep/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.json#/definitions/lineString" }, { - "$ref": "https://forge.etsi.org/rep/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.json#/definitions/polygon" } ] }, @@ -163,4 +161,4 @@ ] } } -} +} \ No newline at end of file diff --git a/schema/registrations/.gitkeep b/schema/registrations/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/schema/registrations/ContextSourceRegistration.json b/schema/registrations/ContextSourceRegistration.json index bf937ed..aaae651 100644 --- a/schema/registrations/ContextSourceRegistration.json +++ b/schema/registrations/ContextSourceRegistration.json @@ -6,11 +6,6 @@ "definitions": { "RegistrationInfo": { "type": "object", - "anyOf": [ - {"required": ["entities"]}, - {"required": ["properties"]}, - {"required": ["relationships"]} - ], "properties": { "entities": { "type": "array", @@ -73,13 +68,13 @@ "$ref": "#/definitions/TimeInterval" }, "location": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/fix-spec/schema/geometry-schema.json#" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Geometry.json#/definitions/Geometry" }, "observationSpace": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/fix-spec/schema/geometry-schema.json#" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Geometry.json#/definitions/Geometry" }, "operationSpace": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/fix-spec/schema/geometry-schema.json#" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Geometry.json#/definitions/Geometry" }, "expires": { "type": "string", @@ -98,15 +93,7 @@ "format": "uri" } }, - "additionalProperties": { - "type": [ - "string", - "number", - "boolean", - "array", - "object" - ] - } + "additionalProperties": true }, "ContextSourceRegistration": { "allOf": [ @@ -122,7 +109,7 @@ }, "type": { "type": "string", - "const": "ContextSourceRegistration" + "enum": ["ContextSourceRegistration"] }, "createdAt": { "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/createdAt" diff --git a/schema/subscriptions/Notification.json b/schema/subscriptions/Notification.json index dd16e7f..a0ad339 100644 --- a/schema/subscriptions/Notification.json +++ b/schema/subscriptions/Notification.json @@ -1,6 +1,4 @@ { - "$schema": "http://json-schema.org/schema#", - "$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", @@ -11,7 +9,9 @@ }, "type": { "type": "string", - "const": "Notification" + "enum": [ + "Notification" + ] }, "subscriptionId": { "type": "string", @@ -38,4 +38,4 @@ "notifiedAt", "data" ] -} +} \ No newline at end of file diff --git a/schema/subscriptions/Subscription.json b/schema/subscriptions/Subscription.json index 794bf16..49ac3a8 100644 --- a/schema/subscriptions/Subscription.json +++ b/schema/subscriptions/Subscription.json @@ -1,6 +1,4 @@ { - "$schema": "http://json-schema.org/schema#", - "$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": { @@ -138,7 +136,7 @@ }, "type": { "type": "string", - "const": "Subscription" + "enum": ["Subscription"] }, "notification": { "$ref": "#/definitions/NotificationParams" @@ -190,4 +188,4 @@ "$ref": "#/definitions/Subscription" } ] -} +} \ No newline at end of file diff --git a/schema/subscriptions/SubscriptionList.json b/schema/subscriptions/SubscriptionList.json index 750ab3e..21a4143 100644 --- a/schema/subscriptions/SubscriptionList.json +++ b/schema/subscriptions/SubscriptionList.json @@ -1,6 +1,4 @@ { - "$schema": "http://json-schema.org/schema#", - "$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": { @@ -11,7 +9,9 @@ } } }, - "allOf": [{ - "$ref": "#/definitions/SubscriptionList" - }] -} + "allOf": [ + { + "$ref": "#/definitions/SubscriptionList" + } + ] +} \ No newline at end of file diff --git a/schema/temporal/EntityTemporal.json b/schema/temporal/EntityTemporal.json index 0cb176d..3d951d0 100644 --- a/schema/temporal/EntityTemporal.json +++ b/schema/temporal/EntityTemporal.json @@ -1,6 +1,4 @@ { - "$schema": "http://json-schema.org/schema#", - "$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": { @@ -46,7 +44,7 @@ } }, "additionalProperties": { - "anyOf": [ + "oneOf": [ { "type": "array", "items": { @@ -69,22 +67,19 @@ "minItems": 1 } ] - }, - "propertyNames": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/PropertyNames" } }, "EntityTemporal": { "allOf": [ + { + "$ref": "#/definitions/EntityTemporalFragment" + }, { "type": "object", "required": [ - "id", - "type" + "type", + "id" ] - }, - { - "$ref": "#/definitions/EntityTemporalFragment" } ] } @@ -94,4 +89,4 @@ "$ref": "#/definitions/EntityTemporal" } ] -} +} \ No newline at end of file diff --git a/schema/temporal/EntityTemporalList.json b/schema/temporal/EntityTemporalList.json index 0b92be8..4ed93d7 100644 --- a/schema/temporal/EntityTemporalList.json +++ b/schema/temporal/EntityTemporalList.json @@ -1,13 +1,11 @@ { - "$schema": "http://json-schema.org/schema#", - "$id": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/temporal/EntityTemporalList.json", "title": "NGSI-LD Entity", "description": "NGSI-LD Temporal Representation List", "definitions": { "EntityTemporalList": { "type": "array", "items": { - "$ref": "https://forge.etsi.org/rep/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#/definitions/EntityTemporal" } } }, @@ -16,4 +14,4 @@ "$ref": "#/definitions/EntityTemporalList" } ] -} +} \ No newline at end of file diff --git a/schema/temporal/Entity_temporalValues.json b/schema/temporal/Entity_temporalValues.json index 30909c3..6a2a98f 100644 --- a/schema/temporal/Entity_temporalValues.json +++ b/schema/temporal/Entity_temporalValues.json @@ -1,6 +1,4 @@ { - "$schema": "http://json-schema.org/schema#", - "$id": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/temporal/Entity_temporalValues.json", "title": "NGSI-LD Entity Temporal Values", "description": "NGSI-LD Simplified Temporal Representation of Entities", "definitions": { @@ -105,7 +103,7 @@ "id" ], "additionalProperties": { - "anyOf": [ + "oneOf": [ { "$ref": "#/definitions/PropertyTemporalValues" }, @@ -113,8 +111,5 @@ "$ref": "#/definitions/RelationshipTemporalValues" } ] - }, - "propertyNames": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/PropertyNames" } -} +} \ No newline at end of file diff --git a/scripts/runLocalDevEnv.sh b/scripts/runLocalDevEnv.sh new file mode 100755 index 0000000..88b67f7 --- /dev/null +++ b/scripts/runLocalDevEnv.sh @@ -0,0 +1,7 @@ +#!/bin/bash + +scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master http://localhost:8090 +docker run --name spec-server --rm -d -v ${PWD}/:/ngsi -e FOLDER=/ngsi -p 8090:8080 halverneus/static-file-server +read -p "Press enter to finish editing" +docker stop spec-server +scripts/setBasePath.sh http://localhost:8090 https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master diff --git a/scripts/setBasePath.sh b/scripts/setBasePath.sh new file mode 100755 index 0000000..d15255a --- /dev/null +++ b/scripts/setBasePath.sh @@ -0,0 +1,14 @@ +#!/bin/bash + +toBeReplaced=$1 +replacement=$2 + +for i in $(find spec -type f -print) +do + sed -i s,${toBeReplaced},${replacement},g "${i}" +done + +for i in $(find schema -type f -print) +do + sed -i s,${toBeReplaced},${replacement},g "${i}" +done \ No newline at end of file diff --git a/spec/updated/csource-registrations-spec.json b/spec/updated/csource-registrations-spec.json index 6ecfac5..6e43c30 100644 --- a/spec/updated/csource-registrations-spec.json +++ b/spec/updated/csource-registrations-spec.json @@ -83,7 +83,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/fix-spec/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/spec/updated/csource-subscription-by-id-spec.json b/spec/updated/csource-subscription-by-id-spec.json index 5b1b595..bc0359a 100644 --- a/spec/updated/csource-subscription-by-id-spec.json +++ b/spec/updated/csource-subscription-by-id-spec.json @@ -22,7 +22,7 @@ "/csourceSubscriptions/{subscriptionId}": { "get": { "description": "Retrieves a specific Subscription from an NGSI-LD system", - "operationId": "retrieveSubscription", + "operationId": "retrieveCSourceSubscriptionsById", "tags": ["Context Sources"], "parameters": [ { diff --git a/spec/updated/entity-attrs-spec.json b/spec/updated/entity-attrs-spec.json index 0a80b51..9b06caf 100644 --- a/spec/updated/entity-attrs-spec.json +++ b/spec/updated/entity-attrs-spec.json @@ -72,7 +72,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/UpdateResult.json#" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/UpdateResult.json#/definitions/UpdateResult" } } } @@ -127,7 +127,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/UpdateResult.json#" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/UpdateResult.json#/definitions/UpdateResult" } } } diff --git a/spec/updated/entity-operations-spec.json b/spec/updated/entity-operations-spec.json index 923aed8..fd8bc1c 100644 --- a/spec/updated/entity-operations-spec.json +++ b/spec/updated/entity-operations-spec.json @@ -6,7 +6,7 @@ }, "components": {}, "paths": { - "/entityOperations/create/": { + "/entityOperations/create": { "post": { "description": "Batch Entity creation", "operationId": "batchEntityCreation", @@ -45,7 +45,7 @@ } } }, - "/entityOperations/update/": { + "/entityOperations/update": { "post": { "description": "Batch Entity update", "operationId": "batchEntityUpdate", @@ -97,7 +97,7 @@ } } }, - "/entityOperations/upsert/": { + "/entityOperations/upsert": { "post": { "description": "Batch Entity upsert", "operationId": "batchEntityUpsert", @@ -150,7 +150,7 @@ } } }, - "/entityOperations/delete/": { + "/entityOperations/delete": { "post": { "description": "Batch Entity delete", "operationId": "batchEntityDelete", diff --git a/spec/updated/subscription-by-id-spec.json b/spec/updated/subscription-by-id-spec.json index ffcc76d..fe16781 100644 --- a/spec/updated/subscription-by-id-spec.json +++ b/spec/updated/subscription-by-id-spec.json @@ -22,7 +22,7 @@ "/subscriptions/{subscriptionId}": { "get": { "description": "Retrieves a specific Subscription from an NGSI-LD system", - "operationId": "retrieveSubscription", + "operationId": "retrieveSubscriptionById", "tags": ["Context Subscription"], "parameters": [ { -- GitLab From 3acb07b077914b4b4d206ed22d07c0bf37892787 Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Tue, 2 Feb 2021 14:42:48 +0100 Subject: [PATCH 04/43] update api, add dev tooling --- bundle/ngsild_swagger_combined.json | 3052 ----------------- .../ngsild_swagger_combined_dereferenced.json | 3052 ----------------- package-lock.json | 47 - package.json | 27 - spec/updated/full_api.json | 2892 ---------------- 5 files changed, 9070 deletions(-) delete mode 100644 bundle/ngsild_swagger_combined.json delete mode 100644 bundle/ngsild_swagger_combined_dereferenced.json delete mode 100644 package-lock.json delete mode 100644 package.json delete mode 100644 spec/updated/full_api.json diff --git a/bundle/ngsild_swagger_combined.json b/bundle/ngsild_swagger_combined.json deleted file mode 100644 index 4c94a6f..0000000 --- a/bundle/ngsild_swagger_combined.json +++ /dev/null @@ -1,3052 +0,0 @@ -{ - "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 deleted file mode 100644 index 4c94a6f..0000000 --- a/bundle/ngsild_swagger_combined_dereferenced.json +++ /dev/null @@ -1,3052 +0,0 @@ -{ - "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/package-lock.json b/package-lock.json deleted file mode 100644 index ecb77d6..0000000 --- a/package-lock.json +++ /dev/null @@ -1,47 +0,0 @@ -{ - "name": "ngsi-ld", - "version": "1.0.0", - "lockfileVersion": 1, - "requires": true, - "dependencies": { - "ajv": { - "version": "6.5.5", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.5.5.tgz", - "integrity": "sha512-7q7gtRQDJSyuEHjuVgHoUa2VuemFiCMrfQc9Tc08XTAc4Zj/5U1buQJ0HU6i7fKjXU09SVgSmxa4sLvuvS8Iyg==", - "requires": { - "fast-deep-equal": "^2.0.1", - "fast-json-stable-stringify": "^2.0.0", - "json-schema-traverse": "^0.4.1", - "uri-js": "^4.2.2" - } - }, - "fast-deep-equal": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-2.0.1.tgz", - "integrity": "sha1-ewUhjd+WZ79/Nwv3/bLLFf3Qqkk=" - }, - "fast-json-stable-stringify": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.0.0.tgz", - "integrity": "sha1-1RQsDK7msRifh9OnYREGT4bIu/I=" - }, - "json-schema-traverse": { - "version": "0.4.1", - "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", - "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==" - }, - "punycode": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.1.1.tgz", - "integrity": "sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A==" - }, - "uri-js": { - "version": "4.2.2", - "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.2.2.tgz", - "integrity": "sha512-KY9Frmirql91X2Qgjry0Wd4Y+YTdrdZheS8TFwvkbLWf/G5KNJDCh6pKL5OZctEW4+0Baa5idK2ZQuELRwPznQ==", - "requires": { - "punycode": "^2.1.0" - } - } - } -} diff --git a/package.json b/package.json deleted file mode 100644 index c816142..0000000 --- a/package.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "name": "ngsi-ld", - "version": "1.0.1", - "description": "NGSI-LD Schema Compilation", - "main": "index.js", - "scripts": { - "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/rep/NGSI-LD/NGSI-LD" - }, - "keywords": [ - "NGSI-LD" - ], - "author": "Jose Manuel Cantera", - "license": "ISC", - "dependencies": { - "ajv": "^6.12.5", - "swagger-cli": "^4.0.4" - } -} diff --git a/spec/updated/full_api.json b/spec/updated/full_api.json deleted file mode 100644 index ffae24b..0000000 --- a/spec/updated/full_api.json +++ /dev/null @@ -1,2892 +0,0 @@ -{ - "openapi": "3.0.1", - "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/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/allOf/0/properties/location/definitions/position" - }, - { - "$ref": "#/paths/~1csourceRegistrations~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/allOf/0/properties/location/definitions/positionArray" - }, - { - "$ref": "#/paths/~1csourceRegistrations~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/allOf/0/properties/location/definitions/lineString" - }, - { - "$ref": "#/paths/~1csourceRegistrations~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/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~1update/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema" - }, - "examples": { - "simple": { - "externalValue": "https://forge.etsi.org/rep/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": [ - { - "type": "object", - "properties": { - "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" - } - } - }, - { - "$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" - } - }, - { - "$ref": "#/paths/~1entities~1/get/parameters/11" - } - ], - "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/rep/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/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/allOf/0/properties/location" - }, - "observedAt": { - "type": "string", - "format": "date-time" - }, - "createdAt": { - "$ref": "#/paths/~1entities~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/allOf/0/properties/createdAt" - }, - "modifiedAt": { - "$ref": "#/paths/~1entities~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/allOf/0/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" - } - }, - "required": [ - "id", - "type" - ], - "additionalProperties": { - "anyOf": [ - { - "type": "object", - "properties": { - "type": { - "type": "string", - "const": "Property" - }, - "value": { - "type": [ - "string", - "number", - "boolean", - "array", - "object" - ] - }, - "observedAt": { - "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/location/properties/observedAt" - }, - "createdAt": { - "$ref": "#/paths/~1entities~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/allOf/0/properties/createdAt" - }, - "modifiedAt": { - "$ref": "#/paths/~1entities~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/allOf/0/properties/modifiedAt" - }, - "datasetId": { - "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/location/properties/datasetId" - }, - "instanceId": { - "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/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%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/location/properties/observedAt" - }, - "createdAt": { - "$ref": "#/paths/~1entities~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/allOf/0/properties/createdAt" - }, - "modifiedAt": { - "$ref": "#/paths/~1entities~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/allOf/0/properties/modifiedAt" - }, - "datasetId": { - "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/properties/location/properties/datasetId" - }, - "instanceId": { - "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/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+)?)$|^(@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://uri.etsi.org/ngsi-ld/schema/UpdateResult.json", - "title": "NGSI-LD Update Result", - "description": "NGSI-LD Update Result", - "definitions": { - "UnchangedDetails": { - "attributeName": { - "type": "string", - "pattern": "" - }, - "reason": { - "type": "string", - "minLenght": 1 - } - }, - "UpdateResult": { - "type": "object", - "properties": { - "updated": { - "type": "array", - "items": { - "type": "string", - "pattern": "" - } - }, - "unchanged": { - "type": "array", - "items": { - "$ref": "#/paths/~1entities~1%7BentityId%7D~1attrs~1/post/responses/207/content/application~1json%3Bapplication~1ld%2Bjson/schema/definitions/UnchangedDetails" - } - } - } - } - }, - "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/rep/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/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/allOf/0/properties/createdAt" - }, - "modifiedAt": { - "$ref": "#/paths/~1entities~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/allOf/0/properties/modifiedAt" - } - }, - "allOf": [ - { - "required": [ - "id", - "type" - ] - }, - { - "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/rep/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/~1entities~1/get/parameters/0" - }, - { - "$ref": "#/paths/~1entities~1/get/parameters/1" - }, - { - "$ref": "#/paths/~1entities~1/get/parameters/2" - }, - { - "$ref": "#/paths/~1entities~1/get/parameters/3" - }, - { - "$ref": "#/paths/~1entities~1/get/parameters/4" - }, - { - "$ref": "#/paths/~1entities~1/get/parameters/5" - }, - { - "$ref": "#/paths/~1entities~1/get/parameters/6" - }, - { - "$ref": "#/paths/~1entities~1/get/parameters/7" - }, - { - "$ref": "#/paths/~1entities~1/get/parameters/8" - }, - { - "$ref": "#/paths/~1entities~1/get/parameters/10" - } - ], - "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/rep/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", - "required": [ - "entities" - ], - "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 - } - } - } - }, - "timestamp": { - "type": "array", - "minItems": 1, - "items": { - "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/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", - "required": [ - "type", - "coordinates" - ], - "oneOf": [ - { - "title": "Point", - "properties": { - "type": { - "enum": [ - "Point" - ] - }, - "coordinates": { - "$ref": "#/paths/~1csourceRegistrations~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/allOf/0/properties/location/definitions/position" - } - } - }, - { - "title": "MultiPoint", - "properties": { - "type": { - "enum": [ - "MultiPoint" - ] - }, - "coordinates": { - "$ref": "#/paths/~1csourceRegistrations~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/allOf/0/properties/location/definitions/positionArray" - } - } - }, - { - "title": "LineString", - "properties": { - "type": { - "enum": [ - "LineString" - ] - }, - "coordinates": { - "$ref": "#/paths/~1csourceRegistrations~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/allOf/0/properties/location/definitions/lineString" - } - } - }, - { - "title": "MultiLineString", - "properties": { - "type": { - "enum": [ - "MultiLineString" - ] - }, - "coordinates": { - "type": "array", - "items": { - "$ref": "#/paths/~1csourceRegistrations~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/allOf/0/properties/location/definitions/lineString" - } - } - } - }, - { - "title": "Polygon", - "properties": { - "type": { - "enum": [ - "Polygon" - ] - }, - "coordinates": { - "$ref": "#/paths/~1csourceRegistrations~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/allOf/0/properties/location/definitions/polygon" - } - } - }, - { - "title": "MultiPolygon", - "properties": { - "type": { - "enum": [ - "MultiPolygon" - ] - }, - "coordinates": { - "type": "array", - "items": { - "$ref": "#/paths/~1csourceRegistrations~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/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/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/allOf/0/properties/location/definitions/position" - } - }, - "lineString": { - "description": "An array of two or more positions", - "allOf": [ - { - "$ref": "#/paths/~1csourceRegistrations~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/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/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/allOf/0/properties/location/definitions/positionArray" - }, - { - "minItems": 4 - } - ] - }, - "polygon": { - "description": "An array of linear rings", - "type": "array", - "items": { - "$ref": "#/paths/~1csourceRegistrations~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/allOf/0/properties/location/definitions/linearRing" - } - } - } - }, - "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/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/allOf/0/properties/createdAt" - }, - "modifiedAt": { - "$ref": "#/paths/~1entities~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/allOf/0/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/rep/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/rep/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/rep/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": { - "$ref": "#/paths/~1entityOperations~1update/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema" - } - } - } - }, - "responses": { - "200": { - "description": "Success", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/paths/~1entityOperations~1upsert/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/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": { - "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": { - "$ref": "#/paths/~1entityOperations~1upsert/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~1update/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/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~1upsert/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": [ - { - "$ref": "#/paths/~1entities~1/get/parameters/0" - }, - { - "$ref": "#/paths/~1entities~1/get/parameters/1" - }, - { - "$ref": "#/paths/~1entities~1/get/parameters/2" - }, - { - "$ref": "#/paths/~1entities~1/get/parameters/3" - }, - { - "$ref": "#/paths/~1entities~1/get/parameters/4" - }, - { - "$ref": "#/paths/~1entities~1/get/parameters/5" - }, - { - "$ref": "#/paths/~1entities~1/get/parameters/6" - }, - { - "$ref": "#/paths/~1entities~1/get/parameters/7" - }, - { - "$ref": "#/paths/~1entities~1/get/parameters/8" - }, - { - "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]|_)+$", - "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" - } - }, - { - "$ref": "#/paths/~1entities~1/get/parameters/9" - }, - { - "$ref": "#/paths/~1entities~1/get/parameters/10" - }, - { - "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/rep/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 - } - }, - "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": { - "type": "string", - "pattern": "^((\\d|[a-zA-Z]|_)+(#\\d+)?)$|^(@context)$" - } - }, - "EntityTemporal": { - "allOf": [ - { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uri" - }, - "type": { - "$ref": "#/paths/~1temporal~1entities~1/get/parameters/10/schema" - }, - "createdAt": { - "$ref": "#/paths/~1entities~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/allOf/0/properties/createdAt" - }, - "modifiedAt": { - "$ref": "#/paths/~1entities~1/post/requestBody/content/application~1json%3Bapplication~1ld%2Bjson/schema/allOf/0/properties/modifiedAt" - } - }, - "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/rep/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/rep/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": [ - { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/parameters/0" - }, - { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/parameters/1" - }, - { - "$ref": "#/paths/~1entities~1%7BentityId%7D/get/parameters/2" - }, - { - "$ref": "#/paths/~1temporal~1entities~1/get/parameters/15" - }, - { - "$ref": "#/paths/~1temporal~1entities~1/get/parameters/9" - }, - { - "$ref": "#/paths/~1temporal~1entities~1/get/parameters/10" - }, - { - "$ref": "#/paths/~1temporal~1entities~1/get/parameters/11" - }, - { - "$ref": "#/paths/~1temporal~1entities~1/get/parameters/12" - }, - { - "$ref": "#/paths/~1temporal~1entities~1/get/parameters/16" - } - ], - "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/rep/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/~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" - } - } - } - } - } - } - }, - "/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" - } - } - } - } - } - } - } - } -} - -- GitLab From 88a83753cd83665c7c2a90948b626fc75c6cdce7 Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Tue, 2 Feb 2021 14:56:33 +0100 Subject: [PATCH 05/43] update ci --- scripts/combine_files.sh | 13 ------------- 1 file changed, 13 deletions(-) delete mode 100755 scripts/combine_files.sh diff --git a/scripts/combine_files.sh b/scripts/combine_files.sh deleted file mode 100755 index ae94438..0000000 --- a/scripts/combine_files.sh +++ /dev/null @@ -1,13 +0,0 @@ -#!/bin/bash -# -# Requires install swagger-cli: npm install -g swagger-cli -# - -# Generate a file which combines all the spec files into a unique swagger definition file (maintains references) -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) -# 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 -- GitLab From 7af4b75532fd0c4b17e29e1594ecddfd8cd61c67 Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Tue, 2 Feb 2021 14:56:39 +0100 Subject: [PATCH 06/43] update ci --- .gitlab-ci.yml | 17 +- spec/updated/full_api.json | 3014 ++++++++++++++++++++++++++++++++++++ 2 files changed, 3021 insertions(+), 10 deletions(-) create mode 100644 spec/updated/full_api.json diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 2e0e51c..5b3c473 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,16 +1,10 @@ # 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::13.7-alpine - -# This folder is cached between builds -# http://docs.rep.com/ce/ci/yaml/README.html#cache -cache: - paths: - - node_modules/ +image: docker:19.03.12 before_script: - - yarn + - docker info stages: - test @@ -18,7 +12,10 @@ stages: test: stage: test script: - - echo "Running tests..." - - yarn test + - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master http://localhost:8090 + - docker run --name spec-server --rm -d -v ${PWD}/:/ngsi -e FOLDER=/ngsi -p 8090:8080 halverneus/static-file-server + - docker run --network host -it -v ${PWD}/:/data broothie/redoc-cli bundle spec/updated/ngsi-ld-spec-open-api.json -o spec/updated/full_api.json + - docker run --network host --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/full_api.json + - scripts/setBasePath.sh http://localhost:8090 https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master allow_failure: true diff --git a/spec/updated/full_api.json b/spec/updated/full_api.json new file mode 100644 index 0000000..94ed7bb --- /dev/null +++ b/spec/updated/full_api.json @@ -0,0 +1,3014 @@ +{ + "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": [ + { + "$ref": "#/components/parameters/id" + }, + { + "$ref": "#/components/parameters/idPattern" + }, + { + "$ref": "#/components/parameters/type" + }, + { + "$ref": "#/components/parameters/attrs" + }, + { + "$ref": "#/components/parameters/q" + }, + { + "$ref": "#/components/parameters/georel" + }, + { + "$ref": "#/components/parameters/geometry" + }, + { + "$ref": "#/components/parameters/coordinates" + }, + { + "$ref": "#/components/parameters/geoproperty" + }, + { + "$ref": "#/components/parameters/csf" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/options" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/EntityList" + }, + "examples": { + "simple": { + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/EntityList-example.json" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "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": { + "$ref": "#/components/schemas/Entity" + } + } + } + }, + "responses": { + "201": { + "description": "Created. Contains the resource URI of the created Entity" + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Already exists", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/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": [ + { + "$ref": "#/components/parameters/entityId" + }, + { + "$ref": "#/components/parameters/attrs" + }, + { + "$ref": "#/components/parameters/parameters-type" + }, + { + "$ref": "#/components/parameters/options" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/Entity" + }, + "examples": { + "simple": { + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/Entity-example.json" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "delete": { + "description": "Removes an specific Entity from an NGSI-LD system", + "operationId": "removeEntityById", + "tags": [ + "Context Information" + ], + "parameters": [ + { + "$ref": "#/components/parameters/entityId" + }, + { + "$ref": "#/components/parameters/parameters-type" + } + ], + "responses": { + "204": { + "description": "No Content. The entity was removed successfully" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/entities/{entityId}/attrs/": { + "post": { + "description": "Append new Entity attributes to an existing Entity within an NGSI-LD system", + "operationId": "appendEntityAttrs", + "tags": [ + "Context Information" + ], + "parameters": [ + { + "$ref": "#/components/parameters/entityId" + }, + { + "$ref": "#/components/parameters/parameters-options" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/EntityFragment" + } + } + } + }, + "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": { + "$ref": "#/components/schemas/UpdateResult" + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "patch": { + "description": "Update existing Entity attributes within an NGSI-LD system", + "operationId": "updateEntityAttrs", + "tags": [ + "Context Information" + ], + "parameters": [ + { + "$ref": "#/components/parameters/entityId" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/EntityFragment" + } + } + } + }, + "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": "#/components/schemas/UpdateResult" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/entities/{entityId}/attrs/{attrId}": { + "patch": { + "description": "Update existing Entity attributes within an NGSI-LD system", + "operationId": "partialAttrUpdate", + "tags": [ + "Context Information" + ], + "parameters": [ + { + "$ref": "#/components/parameters/entityId" + }, + { + "$ref": "#/components/parameters/attrId" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/EntityFragment" + } + } + } + }, + "responses": { + "204": { + "description": "No Content." + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "delete": { + "description": "Removes an existing Entity attribute within an NGSI-LD system", + "operationId": "removeEntityAttr", + "tags": [ + "Context Information" + ], + "parameters": [ + { + "$ref": "#/components/parameters/entityId" + }, + { + "$ref": "#/components/parameters/attrId" + } + ], + "responses": { + "204": { + "description": "No Content." + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/subscriptions/": { + "get": { + "description": "Retrieves the subscriptions available in an NGSI-LD system", + "operationId": "retrieveSubscriptions", + "tags": [ + "Context Subscription" + ], + "parameters": [ + { + "$ref": "#/components/parameters/limit" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionList" + }, + "examples": { + "simple": { + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/SubscriptionList-example.json" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "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": { + "$ref": "#/components/schemas/Subscription" + } + } + } + }, + "responses": { + "201": { + "description": "Created. Contains the resource URI of the created Subscription" + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Already exists", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}": { + "get": { + "description": "Retrieves a specific Subscription from an NGSI-LD system", + "operationId": "retrieveSubscriptionById", + "tags": [ + "Context Subscription" + ], + "parameters": [ + { + "$ref": "#/components/parameters/subscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/Subscription" + }, + "examples": { + "simple": { + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/Subscription-example_C.4.json" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "patch": { + "description": "Updates a specific Subscription within an NGSI-LD system", + "operationId": "updateSubscription", + "tags": [ + "Context Subscription" + ], + "parameters": [ + { + "$ref": "#/components/parameters/subscriptionId" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionFragment" + } + } + } + }, + "responses": { + "204": { + "description": "No Content. The Subscription was updated successfully" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "delete": { + "description": "Removes a specific Subscription from an NGSI-LD system", + "operationId": "removeSubscription", + "tags": [ + "Context Subscription" + ], + "parameters": [ + { + "$ref": "#/components/parameters/subscriptionId" + } + ], + "responses": { + "204": { + "description": "No Content. The Subscription was removed successfully" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/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": "#/components/parameters/id" + }, + { + "$ref": "#/components/parameters/idPattern" + }, + { + "$ref": "#/components/parameters/type" + }, + { + "$ref": "#/components/parameters/attrs" + }, + { + "$ref": "#/components/parameters/q" + }, + { + "$ref": "#/components/parameters/georel" + }, + { + "$ref": "#/components/parameters/geometry" + }, + { + "$ref": "#/components/parameters/coordinates" + }, + { + "$ref": "#/components/parameters/geoproperty" + }, + { + "$ref": "#/components/parameters/limit" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ContextSourceRegistrationList" + }, + "examples": { + "simple": { + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/ContextSourceRegistrationList-example.json" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "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": { + "$ref": "#/components/schemas/ContextSourceRegistration" + } + } + } + }, + "responses": { + "201": { + "description": "Created. Contains the resource URI of the created Registration" + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Already exists", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/csourceRegistrations/{registrationId}": { + "get": { + "description": "Retrieves a specific context source registration from an NGSI-LD system", + "operationId": "retrieveCsource", + "tags": [ + "Context Sources" + ], + "parameters": [ + { + "$ref": "#/components/parameters/registrationId" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ContextSourceRegistration" + }, + "examples": { + "simple": { + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "delete": { + "description": "Removes an specific context source registration within an NGSI-LD system", + "operationId": "removeCsource", + "tags": [ + "Context Sources" + ], + "parameters": [ + { + "$ref": "#/components/parameters/registrationId" + } + ], + "responses": { + "204": { + "description": "No Content. The Registration was removed successfully" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/csourceSubscriptions/": { + "get": { + "description": "Retrieves the context source discovery subscriptions available in an NGSI-LD system", + "operationId": "retrieveCSourceSubscriptions", + "tags": [ + "Context Sources" + ], + "parameters": [ + { + "$ref": "#/components/parameters/limit" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionList" + }, + "examples": { + "simple": { + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/SubscriptionList-example.json" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "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": "#/components/schemas/Subscription" + } + } + } + }, + "responses": { + "201": { + "description": "Created. Contains the resource URI of the created Subscription" + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Already exists", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/csourceSubscriptions/{subscriptionId}": { + "get": { + "description": "Retrieves a specific Subscription from an NGSI-LD system", + "operationId": "retrieveCSourceSubscriptionsById", + "tags": [ + "Context Sources" + ], + "parameters": [ + { + "$ref": "#/components/parameters/subscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/Subscription" + }, + "examples": { + "simple": { + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/Subscription-example_C.4.json" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "patch": { + "description": "Updates a specific context source discovery Subscription within an NGSI-LD system", + "operationId": "updateCSourceSubscription", + "tags": [ + "Context Sources" + ], + "parameters": [ + { + "$ref": "#/components/parameters/subscriptionId" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionFragment" + } + } + } + }, + "responses": { + "204": { + "description": "No Content. The Subscription was updated successfully" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "delete": { + "description": "Removes a specific Context Source Subscription from an NGSI-LD system", + "operationId": "removeCSourceSubscription", + "tags": [ + "Context Sources" + ], + "parameters": [ + { + "$ref": "#/components/parameters/subscriptionId" + } + ], + "responses": { + "204": { + "description": "No Content. The Subscription was removed successfully" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/entityOperations/create": { + "post": { + "description": "Batch Entity creation", + "operationId": "batchEntityCreation", + "tags": [ + "Batch Operations" + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/EntityList" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/BatchOperationResult" + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/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": "#/components/schemas/EntityList" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/BatchOperationResult" + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/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": "#/components/schemas/EntityList" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/BatchOperationResult" + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/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": "#/components/schemas/BatchOperationResult" + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/temporal/entities/": { + "get": { + "description": "Query temporal evolution of Entities from an NGSI-LD system", + "operationId": "queryTemporalEntities", + "tags": [ + "Temporal Evolution" + ], + "parameters": [ + { + "$ref": "#/components/parameters/id" + }, + { + "$ref": "#/components/parameters/idPattern" + }, + { + "$ref": "#/components/parameters/type" + }, + { + "$ref": "#/components/parameters/attrs" + }, + { + "$ref": "#/components/parameters/q" + }, + { + "$ref": "#/components/parameters/georel" + }, + { + "$ref": "#/components/parameters/geometry" + }, + { + "$ref": "#/components/parameters/coordinates" + }, + { + "$ref": "#/components/parameters/geoproperty" + }, + { + "$ref": "#/components/parameters/timerel" + }, + { + "$ref": "#/components/parameters/timeproperty" + }, + { + "$ref": "#/components/parameters/time" + }, + { + "$ref": "#/components/parameters/endTime" + }, + { + "$ref": "#/components/parameters/csf" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/components-parameters-options" + }, + { + "$ref": "#/components/parameters/lastN" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/EntityTemporalList" + }, + "examples": { + "simple": { + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/EntityTemporalList-example.json" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "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": "#/components/schemas/EntityTemporal" + }, + "examples": { + "simple": { + "externalValue": "https://forge.etsi.org/rep/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": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Already exists", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/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": [ + { + "$ref": "#/components/parameters/entityId" + }, + { + "$ref": "#/components/parameters/attrs" + }, + { + "$ref": "#/components/parameters/parameters-type" + }, + { + "$ref": "#/components/parameters/components-parameters-options" + }, + { + "$ref": "#/components/parameters/timerel" + }, + { + "$ref": "#/components/parameters/timeproperty" + }, + { + "$ref": "#/components/parameters/time" + }, + { + "$ref": "#/components/parameters/endTime" + }, + { + "$ref": "#/components/parameters/lastN" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/EntityTemporal" + }, + "examples": { + "simple": { + "externalValue": "https://forge.etsi.org/rep/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": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "delete": { + "description": "Removes the temporal representation of an Entity from an NGSI-LD system", + "operationId": "removeEntityTemporalById", + "tags": [ + "Temporal Evolution" + ], + "parameters": [ + { + "$ref": "#/components/parameters/entityId" + }, + { + "$ref": "#/components/parameters/parameters-type" + } + ], + "responses": { + "204": { + "description": "No Content. The entity was removed successfully" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/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": [ + { + "$ref": "#/components/parameters/entityId" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/EntityTemporalFragment" + } + } + } + }, + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/temporal/entities/{entityId}/attrs/{attrId}": { + "delete": { + "description": "Attribute from Temporal Representation of Entity deletion", + "operationId": "removeEntityTemporalAttr", + "tags": [ + "Temporal Evolution" + ], + "parameters": [ + { + "$ref": "#/components/parameters/entityId" + }, + { + "$ref": "#/components/parameters/attrId" + } + ], + "responses": { + "204": { + "description": "No Content." + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/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": "#/components/parameters/entityId" + }, + { + "$ref": "#/components/parameters/attrId" + }, + { + "$ref": "#/components/parameters/instanceId" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/EntityTemporalFragment" + } + } + } + }, + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "delete": { + "description": "Attribute Instance deletion by instance id.", + "operationId": "removeEntityTemporalAttrInstance", + "tags": [ + "Temporal Evolution" + ], + "parameters": [ + { + "$ref": "#/components/parameters/entityId" + }, + { + "$ref": "#/components/parameters/attrId" + }, + { + "$ref": "#/components/parameters/instanceId" + } + ], + "responses": { + "204": { + "description": "No Content." + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + } + }, + "components": { + "parameters": { + "id": { + "name": "id", + "description": "Comma separated list of URIs to be retrieved", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "uri" + } + }, + "idPattern": { + "name": "idPattern", + "description": "Regular expression that must be matched by Entity ids", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "regexp" + } + }, + "type": { + "name": "type", + "description": "Comma separated list of Entity type names to be retrieved", + "in": "query", + "required": false, + "schema": { + "type": "string", + "minLength": 1 + } + }, + "attrs": { + "name": "attrs", + "description": "Comma separated list of attribute names (properties or relationships) to be retrieved", + "in": "query", + "required": false, + "schema": { + "type": "string", + "minLength": 1 + } + }, + "q": { + "name": "q", + "description": "Query", + "in": "query", + "required": false, + "schema": { + "type": "string", + "minLength": 1 + } + }, + "georel": { + "name": "georel", + "description": "Geo-relationship", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/georel" + } + }, + "geometry": { + "name": "geometry", + "description": "Geometry", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/geometry" + } + }, + "coordinates": { + "name": "coordinates", + "description": "Coordinates serialized as a string", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/coordinates" + } + }, + "geoproperty": { + "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 + } + }, + "csf": { + "name": "csf", + "description": "Context Source Filter", + "in": "query", + "required": false, + "schema": { + "type": "string", + "minLength": 1 + } + }, + "limit": { + "name": "limit", + "description": "Pagination limit", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1 + } + }, + "options": { + "name": "options", + "description": "Options dictionary", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "keyValues", + "sysAttrs" + ] + } + }, + "entityId": { + "name": "entityId", + "description": "Entity Id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uri" + } + }, + "parameters-type": { + "name": "type", + "description": "Entity Type", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/Name" + } + }, + "parameters-options": { + "name": "options", + "description": "Indicates that no attribute overwrite shall be performed", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "noOverwrite" + ] + } + }, + "attrId": { + "name": "attrId", + "description": "Attribute Id", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Name" + } + }, + "subscriptionId": { + "name": "subscriptionId", + "description": "Subscription Id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uri" + } + }, + "registrationId": { + "name": "registrationId", + "description": "Registration Id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uri" + } + }, + "timerel": { + "name": "timerel", + "description": "Time relationship", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/timerel" + } + }, + "timeproperty": { + "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": "#/components/schemas/Name" + } + }, + "time": { + "name": "time", + "description": "start time for temporal query", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + "endTime": { + "name": "endTime", + "description": "end time for temporal query", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + "components-parameters-options": { + "name": "options", + "description": "Options dictionary", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "temporalValues", + "sysAttrs" + ] + } + }, + "lastN": { + "name": "lastN", + "description": "Only retrieve last N instances", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1 + } + }, + "instanceId": { + "name": "instanceId", + "description": "Instance Id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uri" + } + } + }, + "schemas": { + "georel": { + "oneOf": [ + { + "type": "string", + "enum": [ + "equals", + "disjoint", + "intersects", + "within", + "contains", + "overlaps" + ] + }, + { + "type": "string", + "pattern": "^near;((maxDistance==\\d+)|(minDistance==\\d+))$" + } + ] + }, + "geometry": { + "type": "string", + "enum": [ + "Point", + "MultiPoint", + "LineString", + "MultiLineString", + "Polygon", + "MultiPolygon" + ] + }, + "position": { + "description": "A single position", + "type": "array", + "minItems": 2, + "maxItems": 2, + "items": { + "type": "number" + }, + "additionalProperties": false + }, + "positionArray": { + "description": "An array of positions", + "type": "array", + "items": { + "$ref": "#/components/schemas/position" + } + }, + "lineString": { + "description": "An array of two or more positions", + "allOf": [ + { + "$ref": "#/components/schemas/positionArray" + }, + { + "minItems": 2 + } + ] + }, + "linearRing": { + "description": "An array of four positions where the first equals the last", + "allOf": [ + { + "$ref": "#/components/schemas/positionArray" + }, + { + "minItems": 4 + } + ] + }, + "polygon": { + "description": "An array of linear rings", + "type": "array", + "items": { + "$ref": "#/components/schemas/linearRing" + } + }, + "coordinates": { + "oneOf": [ + { + "$ref": "#/components/schemas/position" + }, + { + "$ref": "#/components/schemas/positionArray" + }, + { + "$ref": "#/components/schemas/lineString" + }, + { + "$ref": "#/components/schemas/polygon" + } + ] + }, + "LdContext": { + "oneOf": [ + { + "type": "object" + }, + { + "type": "string", + "format": "uri" + }, + { + "type": "array", + "minItems": 1, + "items": { + "oneOf": [ + { + "type": "string", + "format": "uri" + }, + { + "type": "object" + } + ] + } + } + ] + }, + "Point": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "Point" + ] + }, + "coordinates": { + "$ref": "#/components/schemas/position" + } + } + }, + "MultiPoint": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "MultiPoint" + ] + }, + "coordinates": { + "$ref": "#/components/schemas/positionArray" + } + } + }, + "Polygon": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "Polygon" + ] + }, + "coordinates": { + "$ref": "#/components/schemas/polygon" + } + } + }, + "LineString": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "LineString" + ] + }, + "coordinates": { + "$ref": "#/components/schemas/lineString" + } + } + }, + "MultiLineString": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "MultiLineString" + ] + }, + "coordinates": { + "type": "array", + "items": { + "$ref": "#/components/schemas/lineString" + } + } + } + }, + "MultiPolygon": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "MultiPolygon" + ] + }, + "coordinates": { + "type": "array", + "items": { + "$ref": "#/components/schemas/polygon" + } + } + } + }, + "Geometry": { + "description": " Avalid GeoJSON geometry object", + "oneOf": [ + { + "$ref": "#/components/schemas/Point" + }, + { + "$ref": "#/components/schemas/MultiPoint" + }, + { + "$ref": "#/components/schemas/Polygon" + }, + { + "$ref": "#/components/schemas/LineString" + }, + { + "$ref": "#/components/schemas/MultiLineString" + }, + { + "$ref": "#/components/schemas/MultiPolygon" + } + ] + }, + "observedAt": { + "type": "string", + "format": "date-time" + }, + "createdAt": { + "type": "string", + "format": "date-time" + }, + "modifiedAt": { + "type": "string", + "format": "date-time" + }, + "datasetId": { + "type": "string", + "format": "uri" + }, + "instanceId": { + "type": "string", + "format": "uri" + }, + "Property": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "Property" + ] + }, + "value": { + "oneOf": [ + "string", + "number", + "boolean", + "array", + "object" + ] + }, + "observedAt": { + "$ref": "#/components/schemas/observedAt" + }, + "createdAt": { + "$ref": "#/components/schemas/createdAt" + }, + "modifiedAt": { + "$ref": "#/components/schemas/modifiedAt" + }, + "datasetId": { + "$ref": "#/components/schemas/datasetId" + }, + "instanceId": { + "$ref": "#/components/schemas/instanceId" + } + }, + "required": [ + "type", + "value" + ], + "additionalProperties": { + "oneOf": [ + { + "$ref": "#/components/schemas/Property" + }, + { + "$ref": "#/components/schemas/Relationship" + } + ] + } + }, + "Relationship": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "Relationship" + ] + }, + "object": { + "type": "string", + "format": "uri" + }, + "observedAt": { + "$ref": "#/components/schemas/observedAt" + }, + "createdAt": { + "$ref": "#/components/schemas/createdAt" + }, + "modifiedAt": { + "$ref": "#/components/schemas/modifiedAt" + }, + "datasetId": { + "$ref": "#/components/schemas/datasetId" + }, + "instanceId": { + "$ref": "#/components/schemas/instanceId" + } + }, + "required": [ + "type", + "object" + ], + "additionalProperties": { + "oneOf": [ + { + "$ref": "#/components/schemas/Property" + }, + { + "$ref": "#/components/schemas/Relationship" + } + ] + } + }, + "GeoProperty": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "GeoProperty" + ] + }, + "value": { + "$ref": "#/components/schemas/Geometry" + }, + "observedAt": { + "$ref": "#/components/schemas/observedAt" + }, + "createdAt": { + "$ref": "#/components/schemas/createdAt" + }, + "modifiedAt": { + "$ref": "#/components/schemas/modifiedAt" + }, + "datasetId": { + "$ref": "#/components/schemas/datasetId" + }, + "instanceId": { + "$ref": "#/components/schemas/instanceId" + } + }, + "required": [ + "type", + "value" + ], + "additionalProperties": { + "oneOf": [ + { + "$ref": "#/components/schemas/Property" + }, + { + "$ref": "#/components/schemas/Relationship" + } + ] + } + }, + "Name": { + "type": "string", + "pattern": "^((\\d|[a-zA-Z]|_)+(:(\\d|[a-zA-Z]|_)+)?(#\\d+)?)$", + "minLength": 1, + "description": "NGSI-LD Name" + }, + "EntityFragment": { + "type": "object", + "properties": { + "@context": { + "$ref": "#/components/schemas/LdContext" + }, + "location": { + "$ref": "#/components/schemas/GeoProperty" + }, + "observationSpace": { + "$ref": "#/components/schemas/GeoProperty" + }, + "operationSpace": { + "$ref": "#/components/schemas/GeoProperty" + }, + "id": { + "type": "string", + "format": "uri" + }, + "type": { + "$ref": "#/components/schemas/Name" + }, + "createdAt": { + "$ref": "#/components/schemas/createdAt" + }, + "modifiedAt": { + "$ref": "#/components/schemas/modifiedAt" + } + }, + "additionalProperties": { + "oneOf": [ + { + "$ref": "#/components/schemas/Property" + }, + { + "$ref": "#/components/schemas/Relationship" + }, + { + "$ref": "#/components/schemas/GeoProperty" + } + ] + } + }, + "Entity": { + "allOf": [ + { + "required": [ + "id", + "type" + ] + }, + { + "$ref": "#/components/schemas/EntityFragment" + } + ] + }, + "EntityList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Entity" + } + }, + "ProblemDetails": { + "type": "object", + "properties": { + "type": { + "type": "string", + "format": "uri" + }, + "title": { + "type": "string" + }, + "detail": { + "type": "string" + } + }, + "required": [ + "type" + ] + }, + "NotUpdatedDetails": { + "type": "object", + "properties": { + "attributeName": { + "type": "string", + "pattern": "" + }, + "reason": { + "type": "string", + "minLength": 1 + } + } + }, + "UpdateResult": { + "type": "object", + "properties": { + "updated": { + "type": "array", + "items": { + "type": "string", + "pattern": "" + } + }, + "notUpdated": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NotUpdatedDetails" + } + } + } + }, + "EntityInfo": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uri" + }, + "type": { + "$ref": "#/components/schemas/Name" + }, + "idPattern": { + "type": "string", + "format": "regex" + } + }, + "required": [ + "type" + ] + }, + "GeoQuery": { + "type": "object", + "required": [ + "geometry", + "coordinates", + "georel" + ], + "properties": { + "georel": { + "$ref": "#/components/schemas/georel" + }, + "coordinates": { + "$ref": "#/components/schemas/coordinates" + }, + "geometry": { + "$ref": "#/components/schemas/geometry" + } + } + }, + "SubscriptionFragment": { + "type": "object", + "properties": { + "@context": { + "$ref": "#/components/schemas/LdContext" + }, + "entities": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EntityInfo" + }, + "minItems": 1 + }, + "name": { + "type": "string", + "minLength": 1 + }, + "description": { + "type": "string", + "minLength": 1 + }, + "watchedAttributes": { + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/components/schemas/Name" + }, + "uniqueItems": true + }, + "timeInterval": { + "type": "number", + "minimum": 0 + }, + "expires": { + "type": "string", + "format": "date-time" + }, + "isActive": { + "type": "boolean" + }, + "throttling": { + "type": "number", + "minimum": 1 + }, + "q": { + "type": "string" + }, + "geoQ": { + "$ref": "#/components/schemas/GeoQuery" + }, + "csf": { + "type": "string" + } + } + }, + "Endpoint": { + "type": "object", + "required": [ + "uri" + ], + "properties": { + "uri": { + "type": "string", + "format": "uri" + }, + "accept": { + "type": "string", + "enum": [ + "application/json", + "application/ld+json" + ] + } + } + }, + "NotificationParams": { + "type": "object", + "properties": { + "attributes": { + "type": "array", + "minItems": 1, + "items": { + "type": "string", + "minLength": 1 + }, + "uniqueItems": true + }, + "format": { + "type": "string" + }, + "endpoint": { + "$ref": "#/components/schemas/Endpoint" + }, + "status": { + "type": "string", + "enum": [ + "ok", + "failed" + ] + }, + "timesSent": { + "type": "number", + "minimum": 1 + }, + "lastNotification": { + "type": "string", + "format": "date-time" + }, + "lastFailure": { + "type": "string", + "format": "date-time" + }, + "lastSuccess": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "endpoint" + ] + }, + "Subscription": { + "allOf": [ + { + "$ref": "#/components/schemas/SubscriptionFragment" + }, + { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Subscription" + ] + }, + "notification": { + "$ref": "#/components/schemas/NotificationParams" + }, + "status": { + "type": "string", + "enum": [ + "active", + "paused", + "expired" + ] + }, + "createdAt": { + "$ref": "#/components/schemas/createdAt" + }, + "modifiedAt": { + "$ref": "#/components/schemas/modifiedAt" + } + }, + "allOf": [ + { + "required": [ + "id", + "type", + "notification" + ] + }, + { + "anyOf": [ + { + "required": [ + "entities" + ] + }, + { + "required": [ + "watchedAttributes" + ] + } + ] + } + ] + } + ] + }, + "SubscriptionList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Subscription" + } + }, + "RegistrationInfo": { + "type": "object", + "properties": { + "entities": { + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/components/schemas/EntityInfo" + } + }, + "properties": { + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/components/schemas/Name" + }, + "uniqueItems": true + }, + "relationships": { + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/components/schemas/Name" + }, + "uniqueItems": true + } + } + }, + "TimeInterval": { + "type": "object", + "required": [ + "start" + ], + "properties": { + "start": { + "type": "string", + "format": "date-time" + }, + "end": { + "type": "string", + "format": "date-time" + } + } + }, + "ContextSourceRegistrationFragment": { + "type": "object", + "properties": { + "@context": { + "$ref": "#/components/schemas/LdContext" + }, + "information": { + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/components/schemas/RegistrationInfo" + } + }, + "observationInterval": { + "$ref": "#/components/schemas/TimeInterval" + }, + "managementInterval": { + "$ref": "#/components/schemas/TimeInterval" + }, + "location": { + "$ref": "#/components/schemas/Geometry" + }, + "observationSpace": { + "$ref": "#/components/schemas/Geometry" + }, + "operationSpace": { + "$ref": "#/components/schemas/Geometry" + }, + "expires": { + "type": "string", + "format": "date-time" + }, + "name": { + "type": "string", + "minLength": 1 + }, + "description": { + "type": "string", + "minLength": 1 + }, + "endpoint": { + "type": "string", + "format": "uri" + } + }, + "additionalProperties": true + }, + "ContextSourceRegistration": { + "allOf": [ + { + "$ref": "#/components/schemas/ContextSourceRegistrationFragment" + }, + { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "ContextSourceRegistration" + ] + }, + "createdAt": { + "$ref": "#/components/schemas/createdAt" + }, + "modifiedAt": { + "$ref": "#/components/schemas/modifiedAt" + } + }, + "required": [ + "id", + "type", + "endpoint", + "information" + ] + } + ] + }, + "ContextSourceRegistrationList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ContextSourceRegistration" + } + }, + "BatchEntityError": { + "type": "object", + "properties": { + "entityId": { + "type": "string", + "format": "uri" + }, + "error": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + }, + "BatchOperationResult": { + "type": "object", + "properties": { + "success": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + } + }, + "error": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BatchEntityError" + } + } + } + }, + "timerel": { + "type": "string", + "enum": [ + "before", + "after", + "between" + ] + }, + "EntityTemporalFragment": { + "type": "object", + "properties": { + "@context": { + "$ref": "#/components/schemas/LdContext" + }, + "location": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GeoProperty" + }, + "minItems": 1 + }, + "observationSpace": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GeoProperty" + }, + "minItems": 1 + }, + "operationSpace": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GeoProperty" + }, + "minItems": 1 + }, + "id": { + "type": "string", + "format": "uri" + }, + "type": { + "$ref": "#/components/schemas/Name" + }, + "createdAt": { + "$ref": "#/components/schemas/createdAt" + }, + "modifiedAt": { + "$ref": "#/components/schemas/modifiedAt" + } + }, + "additionalProperties": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/Property" + }, + "minItems": 1 + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/Relationship" + }, + "minItems": 1 + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/GeoProperty" + }, + "minItems": 1 + } + ] + } + }, + "EntityTemporal": { + "allOf": [ + { + "$ref": "#/components/schemas/EntityTemporalFragment" + }, + { + "type": "object", + "required": [ + "type", + "id" + ] + } + ] + }, + "EntityTemporalList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EntityTemporal" + } + } + } + } +} \ No newline at end of file -- GitLab From bcb3218d6977085c6e0fbd2e3d0ccce4ab501692 Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Thu, 4 Feb 2021 11:48:16 +0100 Subject: [PATCH 07/43] restructure --- README.md | 7 +- schema/BatchOperationResult.json | 2 +- schema/Entity.json | 28 +- schema/EntityList.json | 2 +- schema/common.json | 8 +- .../ContextSourceNotification.json | 6 +- .../ContextSourceRegistration.json | 20 +- .../ContextSourceRegistrationList.json | 4 +- schema/subscriptions/Notification.json | 4 +- schema/subscriptions/Subscription.json | 18 +- schema/subscriptions/SubscriptionList.json | 2 +- schema/temporal/EntityTemporal.json | 20 +- schema/temporal/EntityTemporalList.json | 2 +- schema/temporal/Entity_temporalValues.json | 8 +- spec/updated/csource-registrations-spec.json | 119 - .../csource-registration-by-id-spec.json | 16 +- .../csource-registrations-spec.json | 119 + .../csource-subscription-by-id-spec.json | 24 +- .../csource-subscriptions-spec.json | 16 +- .../updated/{ => entities}/entities-spec.json | 24 +- .../{ => entities}/entity-attrs-spec.json | 36 +- .../{ => entities}/entity-by-id-spec.json | 20 +- .../entity-operations-spec.json | 30 +- spec/updated/full_api.json | 22 +- spec/updated/generated/full_api.json | 3048 +++++++++++++++++ spec/updated/ngsi-ld-spec-open-api.json | 38 +- .../subscription-by-id-spec.json | 24 +- .../subscriptions-spec.json | 22 +- .../temporal/temporal-entities-spec.json | 46 +- .../temporal/temporal-entity-attrs-spec.json | 30 +- .../temporal/temporal-entity-by-id-spec.json | 38 +- 31 files changed, 3427 insertions(+), 376 deletions(-) delete mode 100644 spec/updated/csource-registrations-spec.json rename spec/updated/{ => csourceRegistrations}/csource-registration-by-id-spec.json (73%) create mode 100644 spec/updated/csourceRegistrations/csource-registrations-spec.json rename spec/updated/{ => csourceSubscriptions}/csource-subscription-by-id-spec.json (73%) rename spec/updated/{ => csourceSubscriptions}/csource-subscriptions-spec.json (72%) rename spec/updated/{ => entities}/entities-spec.json (81%) rename spec/updated/{ => entities}/entity-attrs-spec.json (74%) rename spec/updated/{ => entities}/entity-by-id-spec.json (74%) rename spec/updated/{ => entities}/entity-operations-spec.json (72%) create mode 100644 spec/updated/generated/full_api.json rename spec/updated/{ => subscriptions}/subscription-by-id-spec.json (72%) rename spec/updated/{ => subscriptions}/subscriptions-spec.json (71%) diff --git a/README.md b/README.md index 8fe3c1e..ebfa038 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ This repository contains OpenAPI descriptions for the NGSI-LD interface defined 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) +More info @ [CONTRIBUTE](./CONTRIBUTE.md) Change requests are managed using [Gerrit](https://forge.etsi.org/gerrit). @@ -22,12 +22,13 @@ it replaces all paths to the master branch inside [spec](spec) and [schema](sche references are resolved with 'https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master' and therefore changes will not be present locally. With the local file-server still running, you can build the bundled api via: +TODO: change to openapi-cli image -> https://github.com/Redocly/openapi-cli/pull/247/files ``` -docker run --network host -it -v ${PWD}/:/data broothie/redoc-cli bundle spec/updated/ngsi-ld-spec-open-api.json -o spec/updated/full_api.json +docker run --network host -it -v ${PWD}/:/data broothie/redoc-cli bundle spec/updated/ngsi-ld-spec-open-api.json -o spec/updated/generated/full_api.json ``` And validate it with: ``` -docker run --network host --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/full_api.json +docker run --network host --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/generated/full_api.json ``` When editing is finished, hit the enter button on your local dev env and push. diff --git a/schema/BatchOperationResult.json b/schema/BatchOperationResult.json index 04fba47..310d0ae 100644 --- a/schema/BatchOperationResult.json +++ b/schema/BatchOperationResult.json @@ -10,7 +10,7 @@ "format": "uri" }, "error": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } }, diff --git a/schema/Entity.json b/schema/Entity.json index 2478215..c75ac9c 100644 --- a/schema/Entity.json +++ b/schema/Entity.json @@ -27,13 +27,13 @@ ] }, "observedAt": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/observedAt" + "$ref": "http://localhost:8090/schema/common.json#/definitions/observedAt" }, "createdAt": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/createdAt" + "$ref": "http://localhost:8090/schema/common.json#/definitions/createdAt" }, "modifiedAt": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/modifiedAt" + "$ref": "http://localhost:8090/schema/common.json#/definitions/modifiedAt" }, "datasetId": { "$ref": "#/definitions/datasetId" @@ -69,13 +69,13 @@ "format": "uri" }, "observedAt": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/observedAt" + "$ref": "http://localhost:8090/schema/common.json#/definitions/observedAt" }, "createdAt": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/createdAt" + "$ref": "http://localhost:8090/schema/common.json#/definitions/createdAt" }, "modifiedAt": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/modifiedAt" + "$ref": "http://localhost:8090/schema/common.json#/definitions/modifiedAt" }, "datasetId": { "$ref": "#/definitions/datasetId" @@ -107,16 +107,16 @@ "enum": ["GeoProperty"] }, "value": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Geometry.json#/definitions/Geometry" + "$ref": "http://localhost:8090/schema/Geometry.json#/definitions/Geometry" }, "observedAt": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/observedAt" + "$ref": "http://localhost:8090/schema/common.json#/definitions/observedAt" }, "createdAt": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/createdAt" + "$ref": "http://localhost:8090/schema/common.json#/definitions/createdAt" }, "modifiedAt": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/modifiedAt" + "$ref": "http://localhost:8090/schema/common.json#/definitions/modifiedAt" }, "datasetId": { "$ref": "#/definitions/datasetId" @@ -144,7 +144,7 @@ "type": "object", "properties": { "@context": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/LdContext" + "$ref": "http://localhost:8090/schema/common.json#/definitions/LdContext" }, "location": { "$ref": "#/definitions/GeoProperty" @@ -160,13 +160,13 @@ "format": "uri" }, "type": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" + "$ref": "http://localhost:8090/schema/common.json#/definitions/Name" }, "createdAt": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/createdAt" + "$ref": "http://localhost:8090/schema/common.json#/definitions/createdAt" }, "modifiedAt": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/modifiedAt" + "$ref": "http://localhost:8090/schema/common.json#/definitions/modifiedAt" } }, "additionalProperties": { diff --git a/schema/EntityList.json b/schema/EntityList.json index a3fca84..1422746 100644 --- a/schema/EntityList.json +++ b/schema/EntityList.json @@ -5,7 +5,7 @@ "EntityList": { "type": "array", "items": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/Entity" + "$ref": "http://localhost:8090/schema/Entity.json#/definitions/Entity" } } }, diff --git a/schema/common.json b/schema/common.json index a3214d7..bc09254 100644 --- a/schema/common.json +++ b/schema/common.json @@ -128,16 +128,16 @@ "coordinates": { "oneOf": [ { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Geometry.json#/definitions/position" + "$ref": "http://localhost:8090/schema/Geometry.json#/definitions/position" }, { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Geometry.json#/definitions/positionArray" + "$ref": "http://localhost:8090/schema/Geometry.json#/definitions/positionArray" }, { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Geometry.json#/definitions/lineString" + "$ref": "http://localhost:8090/schema/Geometry.json#/definitions/lineString" }, { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Geometry.json#/definitions/polygon" + "$ref": "http://localhost:8090/schema/Geometry.json#/definitions/polygon" } ] }, diff --git a/schema/registrations/ContextSourceNotification.json b/schema/registrations/ContextSourceNotification.json index b61e6e5..32960fc 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/rep/NGSI-LD/NGSI-LD/raw/master/schema/registrations/ContextSourceNotification.json", + "$id": "http://localhost:8090/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/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/LdContext" + "$ref": "http://localhost:8090/schema/common.json#/definitions/LdContext" }, "notifiedAt": { "type": "string", @@ -27,7 +27,7 @@ "data": { "type": "array", "items": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/registrations/ContextSourceRegistration.json#/definitions/ContextSourceRegistration" + "$ref": "http://localhost:8090/schema/registrations/ContextSourceRegistration.json#/definitions/ContextSourceRegistration" }, "minItems": 1 }, diff --git a/schema/registrations/ContextSourceRegistration.json b/schema/registrations/ContextSourceRegistration.json index aaae651..9f19e67 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/rep/NGSI-LD/NGSI-LD/raw/master/schema/registrations/ContextSourceRegistration.json", + "$id": "http://localhost:8090/schema/registrations/ContextSourceRegistration.json", "title": "NGSI-LD Context Source Registration", "description": "NGSI-LD Context Source Registration", "definitions": { @@ -11,14 +11,14 @@ "type": "array", "minItems": 1, "items": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/EntityInfo" + "$ref": "http://localhost:8090/schema/common.json#/definitions/EntityInfo" } }, "properties": { "type": "array", "minItems": 1, "items": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" + "$ref": "http://localhost:8090/schema/common.json#/definitions/Name" }, "uniqueItems": true }, @@ -26,7 +26,7 @@ "type": "array", "minItems": 1, "items": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" + "$ref": "http://localhost:8090/schema/common.json#/definitions/Name" }, "uniqueItems": true } @@ -52,7 +52,7 @@ "type": "object", "properties": { "@context": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/LdContext" + "$ref": "http://localhost:8090/schema/common.json#/definitions/LdContext" }, "information": { "type": "array", @@ -68,13 +68,13 @@ "$ref": "#/definitions/TimeInterval" }, "location": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Geometry.json#/definitions/Geometry" + "$ref": "http://localhost:8090/schema/Geometry.json#/definitions/Geometry" }, "observationSpace": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Geometry.json#/definitions/Geometry" + "$ref": "http://localhost:8090/schema/Geometry.json#/definitions/Geometry" }, "operationSpace": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Geometry.json#/definitions/Geometry" + "$ref": "http://localhost:8090/schema/Geometry.json#/definitions/Geometry" }, "expires": { "type": "string", @@ -112,10 +112,10 @@ "enum": ["ContextSourceRegistration"] }, "createdAt": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/createdAt" + "$ref": "http://localhost:8090/schema/common.json#/definitions/createdAt" }, "modifiedAt": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/modifiedAt" + "$ref": "http://localhost:8090/schema/common.json#/definitions/modifiedAt" } }, "required": [ diff --git a/schema/registrations/ContextSourceRegistrationList.json b/schema/registrations/ContextSourceRegistrationList.json index 0518d7a..4d4a21a 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/rep/NGSI-LD/NGSI-LD/raw/master/schema/registrations/ContextSourceRegistrationList.json", + "$id": "http://localhost:8090/schema/registrations/ContextSourceRegistrationList.json", "title": "NGSI-LD Registration List", "description": "NGSI-LD Registration List", "definitions": { "ContextSourceRegistrationList": { "type": "array", "items": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/registrations/ContextSourceRegistration.json#/definitions/ContextSourceRegistration" + "$ref": "http://localhost:8090/schema/registrations/ContextSourceRegistration.json#/definitions/ContextSourceRegistration" } } }, diff --git a/schema/subscriptions/Notification.json b/schema/subscriptions/Notification.json index a0ad339..e238120 100644 --- a/schema/subscriptions/Notification.json +++ b/schema/subscriptions/Notification.json @@ -18,7 +18,7 @@ "format": "uri" }, "@context": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/LdContext" + "$ref": "http://localhost:8090/schema/common.json#/definitions/LdContext" }, "notifiedAt": { "type": "string", @@ -27,7 +27,7 @@ "data": { "type": "array", "items": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/Entity" + "$ref": "http://localhost:8090/schema/Entity.json#/definitions/Entity" }, "minItems": 1 } diff --git a/schema/subscriptions/Subscription.json b/schema/subscriptions/Subscription.json index 49ac3a8..f549253 100644 --- a/schema/subscriptions/Subscription.json +++ b/schema/subscriptions/Subscription.json @@ -18,7 +18,7 @@ "type": "string" }, "endpoint": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Endpoint" + "$ref": "http://localhost:8090/schema/common.json#/definitions/Endpoint" }, "status": { "type": "string", @@ -57,13 +57,13 @@ ], "properties": { "georel": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/georel" + "$ref": "http://localhost:8090/schema/common.json#/definitions/georel" }, "coordinates": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/coordinates" + "$ref": "http://localhost:8090/schema/common.json#/definitions/coordinates" }, "geometry": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/geometry" + "$ref": "http://localhost:8090/schema/common.json#/definitions/geometry" } } }, @@ -71,12 +71,12 @@ "type": "object", "properties": { "@context": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/LdContext" + "$ref": "http://localhost:8090/schema/common.json#/definitions/LdContext" }, "entities": { "type": "array", "items": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/EntityInfo" + "$ref": "http://localhost:8090/schema/common.json#/definitions/EntityInfo" }, "minItems": 1 }, @@ -92,7 +92,7 @@ "type": "array", "minItems": 1, "items": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" + "$ref": "http://localhost:8090/schema/common.json#/definitions/Name" }, "uniqueItems": true }, @@ -150,10 +150,10 @@ ] }, "createdAt": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/createdAt" + "$ref": "http://localhost:8090/schema/common.json#/definitions/createdAt" }, "modifiedAt": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/modifiedAt" + "$ref": "http://localhost:8090/schema/common.json#/definitions/modifiedAt" } }, "allOf": [ diff --git a/schema/subscriptions/SubscriptionList.json b/schema/subscriptions/SubscriptionList.json index 21a4143..650ba86 100644 --- a/schema/subscriptions/SubscriptionList.json +++ b/schema/subscriptions/SubscriptionList.json @@ -5,7 +5,7 @@ "SubscriptionList": { "type": "array", "items": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/subscriptions/Subscription.json#/definitions/Subscription" + "$ref": "http://localhost:8090/schema/subscriptions/Subscription.json#/definitions/Subscription" } } }, diff --git a/schema/temporal/EntityTemporal.json b/schema/temporal/EntityTemporal.json index 3d951d0..2204071 100644 --- a/schema/temporal/EntityTemporal.json +++ b/schema/temporal/EntityTemporal.json @@ -6,26 +6,26 @@ "type": "object", "properties": { "@context": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/LdContext" + "$ref": "http://localhost:8090/schema/common.json#/definitions/LdContext" }, "location": { "type": "array", "items": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/GeoProperty" + "$ref": "http://localhost:8090/schema/Entity.json#/definitions/GeoProperty" }, "minItems": 1 }, "observationSpace": { "type": "array", "items": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/GeoProperty" + "$ref": "http://localhost:8090/schema/Entity.json#/definitions/GeoProperty" }, "minItems": 1 }, "operationSpace": { "type": "array", "items": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/GeoProperty" + "$ref": "http://localhost:8090/schema/Entity.json#/definitions/GeoProperty" }, "minItems": 1 }, @@ -34,13 +34,13 @@ "format": "uri" }, "type": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" + "$ref": "http://localhost:8090/schema/common.json#/definitions/Name" }, "createdAt": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/createdAt" + "$ref": "http://localhost:8090/schema/common.json#/definitions/createdAt" }, "modifiedAt": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/modifiedAt" + "$ref": "http://localhost:8090/schema/common.json#/definitions/modifiedAt" } }, "additionalProperties": { @@ -48,21 +48,21 @@ { "type": "array", "items": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/Property" + "$ref": "http://localhost:8090/schema/Entity.json#/definitions/Property" }, "minItems": 1 }, { "type": "array", "items": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/Relationship" + "$ref": "http://localhost:8090/schema/Entity.json#/definitions/Relationship" }, "minItems": 1 }, { "type": "array", "items": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/GeoProperty" + "$ref": "http://localhost:8090/schema/Entity.json#/definitions/GeoProperty" }, "minItems": 1 } diff --git a/schema/temporal/EntityTemporalList.json b/schema/temporal/EntityTemporalList.json index 4ed93d7..42655d3 100644 --- a/schema/temporal/EntityTemporalList.json +++ b/schema/temporal/EntityTemporalList.json @@ -5,7 +5,7 @@ "EntityTemporalList": { "type": "array", "items": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/temporal/EntityTemporal.json#/definitions/EntityTemporal" + "$ref": "http://localhost:8090/schema/temporal/EntityTemporal.json#/definitions/EntityTemporal" } } }, diff --git a/schema/temporal/Entity_temporalValues.json b/schema/temporal/Entity_temporalValues.json index 6a2a98f..2ebddcb 100644 --- a/schema/temporal/Entity_temporalValues.json +++ b/schema/temporal/Entity_temporalValues.json @@ -86,16 +86,16 @@ "format": "uri" }, "type": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" + "$ref": "http://localhost:8090/schema/common.json#/definitions/Name" }, "@context": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/LdContext" + "$ref": "http://localhost:8090/schema/common.json#/definitions/LdContext" }, "createdAt": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/createdAt" + "$ref": "http://localhost:8090/schema/common.json#/definitions/createdAt" }, "modifiedAt": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/modifiedAt" + "$ref": "http://localhost:8090/schema/common.json#/definitions/modifiedAt" } }, "required": [ diff --git a/spec/updated/csource-registrations-spec.json b/spec/updated/csource-registrations-spec.json deleted file mode 100644 index 6e43c30..0000000 --- a/spec/updated/csource-registrations-spec.json +++ /dev/null @@ -1,119 +0,0 @@ -{ - "openapi": "3.0.1", - "info": { - "title": "NGSI-LD Registrations", - "version": "latest" - }, - "components": { - "parameters": { - } - }, - "paths": { - "/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": "https://forge.etsi.org/rep/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/idPattern" - }, - { - "$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/rep/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/q" - }, - { - "$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/rep/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/coordinates" - }, - { - "$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/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/limit" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json;application/ld+json": { - "schema": { - "$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/rep/NGSI-LD/NGSI-LD/raw/master/examples/ContextSourceRegistrationList-example.json" - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" - } - } - } - } - } - }, - "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": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/registrations/ContextSourceRegistration.json#/definitions/ContextSourceRegistration" - } - } - } - }, - "responses": { - "201": { - "description": "Created. Contains the resource URI of the created Registration" - }, - "400": { - "description": "Bad request", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" - } - } - } - }, - "409": { - "description": "Already exists", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" - } - } - } - } - } - } - } - } -} diff --git a/spec/updated/csource-registration-by-id-spec.json b/spec/updated/csourceRegistrations/csource-registration-by-id-spec.json similarity index 73% rename from spec/updated/csource-registration-by-id-spec.json rename to spec/updated/csourceRegistrations/csource-registration-by-id-spec.json index e15d273..d2a39e8 100644 --- a/spec/updated/csource-registration-by-id-spec.json +++ b/spec/updated/csourceRegistrations/csource-registration-by-id-spec.json @@ -23,7 +23,7 @@ "get": { "description": "Retrieves a specific context source registration from an NGSI-LD system", "operationId": "retrieveCsource", - "tags": ["Context Sources"], + "tags": ["Context Sources", "CSourceRegistrations"], "parameters": [ { "$ref": "#/components/parameters/registrationId" @@ -35,11 +35,11 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/registrations/ContextSourceRegistration.json#/definitions/ContextSourceRegistration" + "$ref": "http://localhost:8090/schema/registrations/ContextSourceRegistration.json#/definitions/ContextSourceRegistration" }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/" + "externalValue": "http://localhost:8090/examples/" } } } @@ -50,7 +50,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -60,7 +60,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -70,7 +70,7 @@ "delete": { "description": "Removes an specific context source registration within an NGSI-LD system", "operationId": "removeCsource", - "tags": ["Context Sources"], + "tags": ["Context Sources", "CSourceRegistrations"], "parameters": [ { "$ref": "#/components/parameters/registrationId" @@ -85,7 +85,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -95,7 +95,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } diff --git a/spec/updated/csourceRegistrations/csource-registrations-spec.json b/spec/updated/csourceRegistrations/csource-registrations-spec.json new file mode 100644 index 0000000..2360b8d --- /dev/null +++ b/spec/updated/csourceRegistrations/csource-registrations-spec.json @@ -0,0 +1,119 @@ +{ + "openapi": "3.0.1", + "info": { + "title": "NGSI-LD Registrations", + "version": "latest" + }, + "components": { + "parameters": { + } + }, + "paths": { + "/csourceRegistrations/": { + "get": { + "description": "Retrieve a set of context sources which matches a specific query from an NGSI-LD system", + "operationId": "queryCsources", + "tags": ["Context Sources", "CSourceRegistrations"], + "parameters": [ + { + "$ref": "http://localhost:8090/spec/updated/entities/entities-spec.json#/components/parameters/id" + }, + { + "$ref": "http://localhost:8090/spec/updated/entities/entities-spec.json#/components/parameters/idPattern" + }, + { + "$ref": "http://localhost:8090/spec/updated/entities/entities-spec.json#/components/parameters/type" + }, + { + "$ref": "http://localhost:8090/spec/updated/entities/entities-spec.json#/components/parameters/attrs" + }, + { + "$ref": "http://localhost:8090/spec/updated/entities/entities-spec.json#/components/parameters/q" + }, + { + "$ref": "http://localhost:8090/spec/updated/entities/entities-spec.json#/components/parameters/georel" + }, + { + "$ref": "http://localhost:8090/spec/updated/entities/entities-spec.json#/components/parameters/geometry" + }, + { + "$ref": "http://localhost:8090/spec/updated/entities/entities-spec.json#/components/parameters/coordinates" + }, + { + "$ref": "http://localhost:8090/spec/updated/entities/entities-spec.json#/components/parameters/geoproperty" + }, + { + "$ref": "http://localhost:8090/spec/updated/entities/entities-spec.json#/components/parameters/limit" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "http://localhost:8090/schema/registrations/ContextSourceRegistrationList.json#/definitions/ContextSourceRegistrationList" + }, + "examples": { + "simple": { + "externalValue": "http://localhost:8090/examples/ContextSourceRegistrationList-example.json" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" + } + } + } + } + } + }, + "post": { + "description": "Registers a new context source within an NGSI-LD system", + "operationId": "registerCsource", + "tags": ["Context Sources", "CSourceRegistrations"], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "http://localhost:8090/schema/registrations/ContextSourceRegistration.json#/definitions/ContextSourceRegistration" + } + } + } + }, + "responses": { + "201": { + "description": "Created. Contains the resource URI of the created Registration" + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" + } + } + } + }, + "409": { + "description": "Already exists", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" + } + } + } + } + } + } + } + } +} diff --git a/spec/updated/csource-subscription-by-id-spec.json b/spec/updated/csourceSubscriptions/csource-subscription-by-id-spec.json similarity index 73% rename from spec/updated/csource-subscription-by-id-spec.json rename to spec/updated/csourceSubscriptions/csource-subscription-by-id-spec.json index bc0359a..5e39263 100644 --- a/spec/updated/csource-subscription-by-id-spec.json +++ b/spec/updated/csourceSubscriptions/csource-subscription-by-id-spec.json @@ -23,7 +23,7 @@ "get": { "description": "Retrieves a specific Subscription from an NGSI-LD system", "operationId": "retrieveCSourceSubscriptionsById", - "tags": ["Context Sources"], + "tags": ["Context Sources", "CSourceSubscriptions"], "parameters": [ { "$ref": "#/components/parameters/subscriptionId" @@ -35,11 +35,11 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/subscriptions/Subscription.json#/definitions/Subscription" + "$ref": "http://localhost:8090/schema/subscriptions/Subscription.json#/definitions/Subscription" }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/Subscription-example_C.4.json" + "externalValue": "http://localhost:8090/examples/Subscription-example_C.4.json" } } } @@ -50,7 +50,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -60,7 +60,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -70,7 +70,7 @@ "patch": { "description": "Updates a specific context source discovery Subscription within an NGSI-LD system", "operationId": "updateCSourceSubscription", - "tags": ["Context Sources"], + "tags": ["Context Sources", "CSourceSubscriptions"], "parameters": [ { "$ref": "#/components/parameters/subscriptionId" @@ -81,7 +81,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/subscriptions/Subscription.json#/definitions/SubscriptionFragment" + "$ref": "http://localhost:8090/schema/subscriptions/Subscription.json#/definitions/SubscriptionFragment" } } } @@ -95,7 +95,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -105,7 +105,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -115,7 +115,7 @@ "delete": { "description": "Removes a specific Context Source Subscription from an NGSI-LD system", "operationId": "removeCSourceSubscription", - "tags": ["Context Sources"], + "tags": ["Context Sources", "CSourceSubscriptions"], "parameters": [ { "$ref": "#/components/parameters/subscriptionId" @@ -130,7 +130,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -140,7 +140,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } diff --git a/spec/updated/csource-subscriptions-spec.json b/spec/updated/csourceSubscriptions/csource-subscriptions-spec.json similarity index 72% rename from spec/updated/csource-subscriptions-spec.json rename to spec/updated/csourceSubscriptions/csource-subscriptions-spec.json index e152186..68442ab 100644 --- a/spec/updated/csource-subscriptions-spec.json +++ b/spec/updated/csourceSubscriptions/csource-subscriptions-spec.json @@ -23,7 +23,7 @@ "get": { "description": "Retrieves the context source discovery subscriptions available in an NGSI-LD system", "operationId": "retrieveCSourceSubscriptions", - "tags": ["Context Sources"], + "tags": ["Context Sources", "CSourceSubscriptions"], "parameters": [ { "$ref": "#/components/parameters/limit" @@ -35,11 +35,11 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/subscriptions/SubscriptionList.json#/definitions/SubscriptionList" + "$ref": "http://localhost:8090/schema/subscriptions/SubscriptionList.json#/definitions/SubscriptionList" }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/SubscriptionList-example.json" + "externalValue": "http://localhost:8090/examples/SubscriptionList-example.json" } } } @@ -50,7 +50,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -60,13 +60,13 @@ "post": { "description": "Creates a context source discovery Subscription within an NGSI-LD system", "operationId": "createCSourceSubscription", - "tags": ["Context Sources"], + "tags": ["Context Sources", "CSourceSubscriptions"], "requestBody": { "required": true, "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/subscriptions/Subscription.json#/definitions/Subscription" + "$ref": "http://localhost:8090/schema/subscriptions/Subscription.json#/definitions/Subscription" } } } @@ -80,7 +80,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -90,7 +90,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } diff --git a/spec/updated/entities-spec.json b/spec/updated/entities/entities-spec.json similarity index 81% rename from spec/updated/entities-spec.json rename to spec/updated/entities/entities-spec.json index a55bfe8..e730ff1 100644 --- a/spec/updated/entities-spec.json +++ b/spec/updated/entities/entities-spec.json @@ -62,7 +62,7 @@ "in": "query", "required": false, "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/georel" + "$ref": "http://localhost:8090/schema/common.json#/definitions/georel" } }, "geometry": { @@ -71,7 +71,7 @@ "in": "query", "required": false, "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/geometry" + "$ref": "http://localhost:8090/schema/common.json#/definitions/geometry" } }, "coordinates": { @@ -80,7 +80,7 @@ "in": "query", "required": false, "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/coordinates" + "$ref": "http://localhost:8090/schema/common.json#/definitions/coordinates" } }, "geoproperty": { @@ -130,7 +130,7 @@ "get": { "description": "Retrieve a set of entities which matches a specific query from an NGSI-LD system", "operationId": "queryEntities", - "tags": ["Context Information"], + "tags": ["Context Information", "Entities"], "parameters": [ { "$ref": "#/components/parameters/id" @@ -175,11 +175,11 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/EntityList.json#/definitions/EntityList" + "$ref": "http://localhost:8090/schema/EntityList.json#/definitions/EntityList" }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/EntityList-example.json" + "externalValue": "http://localhost:8090/examples/EntityList-example.json" } } } @@ -190,7 +190,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -200,13 +200,13 @@ "post": { "description": "Create a new Entity within an NGSI-LD system", "operationId": "createEntity", - "tags": ["Context Information"], + "tags": ["Context Information", "Entities"], "requestBody": { "required": true, "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/Entity" + "$ref": "http://localhost:8090/schema/Entity.json#/definitions/Entity" } } } @@ -220,7 +220,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -230,7 +230,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -240,7 +240,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } diff --git a/spec/updated/entity-attrs-spec.json b/spec/updated/entities/entity-attrs-spec.json similarity index 74% rename from spec/updated/entity-attrs-spec.json rename to spec/updated/entities/entity-attrs-spec.json index 9b06caf..8c947b7 100644 --- a/spec/updated/entity-attrs-spec.json +++ b/spec/updated/entities/entity-attrs-spec.json @@ -22,7 +22,7 @@ "in": "path", "required": true, "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" + "$ref": "http://localhost:8090/schema/common.json#/definitions/Name" } }, "options": { @@ -44,7 +44,7 @@ "post": { "description": "Append new Entity attributes to an existing Entity within an NGSI-LD system", "operationId": "appendEntityAttrs", - "tags": ["Context Information"], + "tags": ["Context Information", "Entities"], "parameters": [ { "$ref": "#/components/parameters/entityId" @@ -58,7 +58,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/EntityFragment" + "$ref": "http://localhost:8090/schema/Entity.json#/definitions/EntityFragment" } } } @@ -72,7 +72,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/UpdateResult.json#/definitions/UpdateResult" + "$ref": "http://localhost:8090/schema/UpdateResult.json#/definitions/UpdateResult" } } } @@ -82,7 +82,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -92,7 +92,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -102,7 +102,7 @@ "patch": { "description": "Update existing Entity attributes within an NGSI-LD system", "operationId": "updateEntityAttrs", - "tags": ["Context Information"], + "tags": ["Context Information", "Entities"], "parameters": [ { "$ref": "#/components/parameters/entityId" @@ -113,7 +113,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/EntityFragment" + "$ref": "http://localhost:8090/schema/Entity.json#/definitions/EntityFragment" } } } @@ -127,7 +127,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/UpdateResult.json#/definitions/UpdateResult" + "$ref": "http://localhost:8090/schema/UpdateResult.json#/definitions/UpdateResult" } } } @@ -137,7 +137,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -147,7 +147,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -159,7 +159,7 @@ "patch": { "description": "Update existing Entity attributes within an NGSI-LD system", "operationId": "partialAttrUpdate", - "tags": ["Context Information"], + "tags": ["Context Information", "Entities"], "parameters": [ { "$ref": "#/components/parameters/entityId" @@ -173,7 +173,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/EntityFragment" + "$ref": "http://localhost:8090/schema/Entity.json#/definitions/EntityFragment" } } } @@ -187,7 +187,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -197,7 +197,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -207,7 +207,7 @@ "delete": { "description": "Removes an existing Entity attribute within an NGSI-LD system", "operationId": "removeEntityAttr", - "tags": ["Context Information"], + "tags": ["Context Information", "Entities"], "parameters": [ { "$ref": "#/components/parameters/entityId" @@ -225,7 +225,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -235,7 +235,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } diff --git a/spec/updated/entity-by-id-spec.json b/spec/updated/entities/entity-by-id-spec.json similarity index 74% rename from spec/updated/entity-by-id-spec.json rename to spec/updated/entities/entity-by-id-spec.json index 3c97881..b59af1b 100644 --- a/spec/updated/entity-by-id-spec.json +++ b/spec/updated/entities/entity-by-id-spec.json @@ -22,7 +22,7 @@ "in": "query", "required": false, "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" + "$ref": "http://localhost:8090/schema/common.json#/definitions/Name" } }, "attrs": { @@ -42,7 +42,7 @@ "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"], + "tags": ["Context Information", "Entities"], "parameters": [ { "$ref": "#/components/parameters/entityId" @@ -54,7 +54,7 @@ "$ref": "#/components/parameters/type" }, { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/options" + "$ref": "http://localhost:8090/spec/updated/entities/entities-spec.json#/components/parameters/options" } ], "responses": { @@ -63,11 +63,11 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/Entity" + "$ref": "http://localhost:8090/schema/Entity.json#/definitions/Entity" }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/Entity-example.json" + "externalValue": "http://localhost:8090/examples/Entity-example.json" } } } @@ -78,7 +78,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -88,7 +88,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -98,7 +98,7 @@ "delete": { "description": "Removes an specific Entity from an NGSI-LD system", "operationId": "removeEntityById", - "tags": ["Context Information"], + "tags": ["Context Information", "Entities"], "parameters": [ { "$ref": "#/components/parameters/entityId" @@ -116,7 +116,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -126,7 +126,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } diff --git a/spec/updated/entity-operations-spec.json b/spec/updated/entities/entity-operations-spec.json similarity index 72% rename from spec/updated/entity-operations-spec.json rename to spec/updated/entities/entity-operations-spec.json index fd8bc1c..754f279 100644 --- a/spec/updated/entity-operations-spec.json +++ b/spec/updated/entities/entity-operations-spec.json @@ -10,13 +10,13 @@ "post": { "description": "Batch Entity creation", "operationId": "batchEntityCreation", - "tags": ["Batch Operations"], + "tags": ["Batch Operations", "Entities"], "requestBody": { "required": true, "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/EntityList.json#/definitions/EntityList" + "$ref": "http://localhost:8090/schema/EntityList.json#/definitions/EntityList" } } } @@ -27,7 +27,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/BatchOperationResult.json#/definitions/BatchOperationResult" + "$ref": "http://localhost:8090/schema/BatchOperationResult.json#/definitions/BatchOperationResult" } } } @@ -37,7 +37,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -49,7 +49,7 @@ "post": { "description": "Batch Entity update", "operationId": "batchEntityUpdate", - "tags": ["Batch Operations"], + "tags": ["Batch Operations", "Entities"], "parameters": [ { "name": "options", @@ -68,7 +68,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/EntityList.json#/definitions/EntityList" + "$ref": "http://localhost:8090/schema/EntityList.json#/definitions/EntityList" } } } @@ -79,7 +79,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/BatchOperationResult.json#/definitions/BatchOperationResult" + "$ref": "http://localhost:8090/schema/BatchOperationResult.json#/definitions/BatchOperationResult" } } } @@ -89,7 +89,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -101,7 +101,7 @@ "post": { "description": "Batch Entity upsert", "operationId": "batchEntityUpsert", - "tags": ["Batch Operations"], + "tags": ["Batch Operations", "Entities"], "parameters": [ { "name": "options", @@ -121,7 +121,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/EntityList.json#/definitions/EntityList" + "$ref": "http://localhost:8090/schema/EntityList.json#/definitions/EntityList" } } } @@ -132,7 +132,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/BatchOperationResult.json#/definitions/BatchOperationResult" + "$ref": "http://localhost:8090/schema/BatchOperationResult.json#/definitions/BatchOperationResult" } } } @@ -142,7 +142,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -154,7 +154,7 @@ "post": { "description": "Batch Entity delete", "operationId": "batchEntityDelete", - "tags": ["Batch Operations"], + "tags": ["Batch Operations", "Entities"], "requestBody": { "required": true, "content": { @@ -176,7 +176,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/BatchOperationResult.json#/definitions/BatchOperationResult" + "$ref": "http://localhost:8090/schema/BatchOperationResult.json#/definitions/BatchOperationResult" } } } @@ -186,7 +186,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } diff --git a/spec/updated/full_api.json b/spec/updated/full_api.json index 94ed7bb..ea8155d 100644 --- a/spec/updated/full_api.json +++ b/spec/updated/full_api.json @@ -102,7 +102,7 @@ }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/EntityList-example.json" + "externalValue": "http://localhost:8090/examples/EntityList-example.json" } } } @@ -204,7 +204,7 @@ }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/Entity-example.json" + "externalValue": "http://localhost:8090/examples/Entity-example.json" } } } @@ -506,7 +506,7 @@ }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/SubscriptionList-example.json" + "externalValue": "http://localhost:8090/examples/SubscriptionList-example.json" } } } @@ -589,7 +589,7 @@ }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/Subscription-example_C.4.json" + "externalValue": "http://localhost:8090/examples/Subscription-example_C.4.json" } } } @@ -751,7 +751,7 @@ }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/ContextSourceRegistrationList-example.json" + "externalValue": "http://localhost:8090/examples/ContextSourceRegistrationList-example.json" } } } @@ -834,7 +834,7 @@ }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/" + "externalValue": "http://localhost:8090/examples/" } } } @@ -922,7 +922,7 @@ }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/SubscriptionList-example.json" + "externalValue": "http://localhost:8090/examples/SubscriptionList-example.json" } } } @@ -1005,7 +1005,7 @@ }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/Subscription-example_C.4.json" + "externalValue": "http://localhost:8090/examples/Subscription-example_C.4.json" } } } @@ -1384,7 +1384,7 @@ }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/EntityTemporalList-example.json" + "externalValue": "http://localhost:8090/examples/EntityTemporalList-example.json" } } } @@ -1417,7 +1417,7 @@ }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/EntityTemporal-example_C5.5.3.json" + "externalValue": "http://localhost:8090/examples/EntityTemporal-example_C5.5.3.json" } } } @@ -1509,7 +1509,7 @@ }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/EntityTemporal-example_C5.5.3.json" + "externalValue": "http://localhost:8090/examples/EntityTemporal-example_C5.5.3.json" } } } diff --git a/spec/updated/generated/full_api.json b/spec/updated/generated/full_api.json new file mode 100644 index 0000000..9417218 --- /dev/null +++ b/spec/updated/generated/full_api.json @@ -0,0 +1,3048 @@ +{ + "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", + "Entities" + ], + "parameters": [ + { + "$ref": "#/components/parameters/id" + }, + { + "$ref": "#/components/parameters/idPattern" + }, + { + "$ref": "#/components/parameters/type" + }, + { + "$ref": "#/components/parameters/attrs" + }, + { + "$ref": "#/components/parameters/q" + }, + { + "$ref": "#/components/parameters/georel" + }, + { + "$ref": "#/components/parameters/geometry" + }, + { + "$ref": "#/components/parameters/coordinates" + }, + { + "$ref": "#/components/parameters/geoproperty" + }, + { + "$ref": "#/components/parameters/csf" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/options" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/EntityList" + }, + "examples": { + "simple": { + "externalValue": "http://localhost:8090/examples/EntityList-example.json" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "post": { + "description": "Create a new Entity within an NGSI-LD system", + "operationId": "createEntity", + "tags": [ + "Context Information", + "Entities" + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/Entity" + } + } + } + }, + "responses": { + "201": { + "description": "Created. Contains the resource URI of the created Entity" + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Already exists", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/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", + "Entities" + ], + "parameters": [ + { + "$ref": "#/components/parameters/entityId" + }, + { + "$ref": "#/components/parameters/attrs" + }, + { + "$ref": "#/components/parameters/parameters-type" + }, + { + "$ref": "#/components/parameters/options" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/Entity" + }, + "examples": { + "simple": { + "externalValue": "http://localhost:8090/examples/Entity-example.json" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "delete": { + "description": "Removes an specific Entity from an NGSI-LD system", + "operationId": "removeEntityById", + "tags": [ + "Context Information", + "Entities" + ], + "parameters": [ + { + "$ref": "#/components/parameters/entityId" + }, + { + "$ref": "#/components/parameters/parameters-type" + } + ], + "responses": { + "204": { + "description": "No Content. The entity was removed successfully" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/entities/{entityId}/attrs/": { + "post": { + "description": "Append new Entity attributes to an existing Entity within an NGSI-LD system", + "operationId": "appendEntityAttrs", + "tags": [ + "Context Information", + "Entities" + ], + "parameters": [ + { + "$ref": "#/components/parameters/entityId" + }, + { + "$ref": "#/components/parameters/parameters-options" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/EntityFragment" + } + } + } + }, + "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": { + "$ref": "#/components/schemas/UpdateResult" + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "patch": { + "description": "Update existing Entity attributes within an NGSI-LD system", + "operationId": "updateEntityAttrs", + "tags": [ + "Context Information", + "Entities" + ], + "parameters": [ + { + "$ref": "#/components/parameters/entityId" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/EntityFragment" + } + } + } + }, + "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": "#/components/schemas/UpdateResult" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/entities/{entityId}/attrs/{attrId}": { + "patch": { + "description": "Update existing Entity attributes within an NGSI-LD system", + "operationId": "partialAttrUpdate", + "tags": [ + "Context Information", + "Entities" + ], + "parameters": [ + { + "$ref": "#/components/parameters/entityId" + }, + { + "$ref": "#/components/parameters/attrId" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/EntityFragment" + } + } + } + }, + "responses": { + "204": { + "description": "No Content." + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "delete": { + "description": "Removes an existing Entity attribute within an NGSI-LD system", + "operationId": "removeEntityAttr", + "tags": [ + "Context Information", + "Entities" + ], + "parameters": [ + { + "$ref": "#/components/parameters/entityId" + }, + { + "$ref": "#/components/parameters/attrId" + } + ], + "responses": { + "204": { + "description": "No Content." + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/subscriptions/": { + "get": { + "description": "Retrieves the subscriptions available in an NGSI-LD system", + "operationId": "retrieveSubscriptions", + "tags": [ + "Context Subscription", + "Subscriptions" + ], + "parameters": [ + { + "$ref": "#/components/parameters/limit" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionList" + }, + "examples": { + "simple": { + "externalValue": "http://localhost:8090/examples/SubscriptionList-example.json" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "post": { + "description": "Creates a new Subscription within an NGSI-LD system", + "operationId": "createSubscription", + "tags": [ + "Context Subscription", + "Subscriptions" + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/Subscription" + } + } + } + }, + "responses": { + "201": { + "description": "Created. Contains the resource URI of the created Subscription" + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Already exists", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}": { + "get": { + "description": "Retrieves a specific Subscription from an NGSI-LD system", + "operationId": "retrieveSubscriptionById", + "tags": [ + "Context Subscription", + "Subscriptions" + ], + "parameters": [ + { + "$ref": "#/components/parameters/subscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/Subscription" + }, + "examples": { + "simple": { + "externalValue": "http://localhost:8090/examples/Subscription-example_C.4.json" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "patch": { + "description": "Updates a specific Subscription within an NGSI-LD system", + "operationId": "updateSubscription", + "tags": [ + "Context Subscription", + "Subscriptions" + ], + "parameters": [ + { + "$ref": "#/components/parameters/subscriptionId" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionFragment" + } + } + } + }, + "responses": { + "204": { + "description": "No Content. The Subscription was updated successfully" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "delete": { + "description": "Removes a specific Subscription from an NGSI-LD system", + "operationId": "removeSubscription", + "tags": [ + "Context Subscription", + "Subscriptions" + ], + "parameters": [ + { + "$ref": "#/components/parameters/subscriptionId" + } + ], + "responses": { + "204": { + "description": "No Content. The Subscription was removed successfully" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/csourceRegistrations/": { + "get": { + "description": "Retrieve a set of context sources which matches a specific query from an NGSI-LD system", + "operationId": "queryCsources", + "tags": [ + "Context Sources", + "CSourceRegistrations" + ], + "parameters": [ + { + "$ref": "#/components/parameters/id" + }, + { + "$ref": "#/components/parameters/idPattern" + }, + { + "$ref": "#/components/parameters/type" + }, + { + "$ref": "#/components/parameters/attrs" + }, + { + "$ref": "#/components/parameters/q" + }, + { + "$ref": "#/components/parameters/georel" + }, + { + "$ref": "#/components/parameters/geometry" + }, + { + "$ref": "#/components/parameters/coordinates" + }, + { + "$ref": "#/components/parameters/geoproperty" + }, + { + "$ref": "#/components/parameters/limit" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ContextSourceRegistrationList" + }, + "examples": { + "simple": { + "externalValue": "http://localhost:8090/examples/ContextSourceRegistrationList-example.json" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "post": { + "description": "Registers a new context source within an NGSI-LD system", + "operationId": "registerCsource", + "tags": [ + "Context Sources", + "CSourceRegistrations" + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ContextSourceRegistration" + } + } + } + }, + "responses": { + "201": { + "description": "Created. Contains the resource URI of the created Registration" + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Already exists", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/csourceRegistrations/{registrationId}": { + "get": { + "description": "Retrieves a specific context source registration from an NGSI-LD system", + "operationId": "retrieveCsource", + "tags": [ + "Context Sources", + "CSourceRegistrations" + ], + "parameters": [ + { + "$ref": "#/components/parameters/registrationId" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ContextSourceRegistration" + }, + "examples": { + "simple": { + "externalValue": "http://localhost:8090/examples/" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "delete": { + "description": "Removes an specific context source registration within an NGSI-LD system", + "operationId": "removeCsource", + "tags": [ + "Context Sources", + "CSourceRegistrations" + ], + "parameters": [ + { + "$ref": "#/components/parameters/registrationId" + } + ], + "responses": { + "204": { + "description": "No Content. The Registration was removed successfully" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/csourceSubscriptions/": { + "get": { + "description": "Retrieves the context source discovery subscriptions available in an NGSI-LD system", + "operationId": "retrieveCSourceSubscriptions", + "tags": [ + "Context Sources", + "CSourceSubscriptions" + ], + "parameters": [ + { + "$ref": "#/components/parameters/limit" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionList" + }, + "examples": { + "simple": { + "externalValue": "http://localhost:8090/examples/SubscriptionList-example.json" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "post": { + "description": "Creates a context source discovery Subscription within an NGSI-LD system", + "operationId": "createCSourceSubscription", + "tags": [ + "Context Sources", + "CSourceSubscriptions" + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/Subscription" + } + } + } + }, + "responses": { + "201": { + "description": "Created. Contains the resource URI of the created Subscription" + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Already exists", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/csourceSubscriptions/{subscriptionId}": { + "get": { + "description": "Retrieves a specific Subscription from an NGSI-LD system", + "operationId": "retrieveCSourceSubscriptionsById", + "tags": [ + "Context Sources", + "CSourceSubscriptions" + ], + "parameters": [ + { + "$ref": "#/components/parameters/subscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/Subscription" + }, + "examples": { + "simple": { + "externalValue": "http://localhost:8090/examples/Subscription-example_C.4.json" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "patch": { + "description": "Updates a specific context source discovery Subscription within an NGSI-LD system", + "operationId": "updateCSourceSubscription", + "tags": [ + "Context Sources", + "CSourceSubscriptions" + ], + "parameters": [ + { + "$ref": "#/components/parameters/subscriptionId" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionFragment" + } + } + } + }, + "responses": { + "204": { + "description": "No Content. The Subscription was updated successfully" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "delete": { + "description": "Removes a specific Context Source Subscription from an NGSI-LD system", + "operationId": "removeCSourceSubscription", + "tags": [ + "Context Sources", + "CSourceSubscriptions" + ], + "parameters": [ + { + "$ref": "#/components/parameters/subscriptionId" + } + ], + "responses": { + "204": { + "description": "No Content. The Subscription was removed successfully" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/entityOperations/create": { + "post": { + "description": "Batch Entity creation", + "operationId": "batchEntityCreation", + "tags": [ + "Batch Operations", + "Entities" + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/EntityList" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/BatchOperationResult" + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/entityOperations/update": { + "post": { + "description": "Batch Entity update", + "operationId": "batchEntityUpdate", + "tags": [ + "Batch Operations", + "Entities" + ], + "parameters": [ + { + "name": "options", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "noOverwrite" + ] + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/EntityList" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/BatchOperationResult" + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/entityOperations/upsert": { + "post": { + "description": "Batch Entity upsert", + "operationId": "batchEntityUpsert", + "tags": [ + "Batch Operations", + "Entities" + ], + "parameters": [ + { + "name": "options", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "replace", + "update" + ] + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/EntityList" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/BatchOperationResult" + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/entityOperations/delete": { + "post": { + "description": "Batch Entity delete", + "operationId": "batchEntityDelete", + "tags": [ + "Batch Operations", + "Entities" + ], + "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": "#/components/schemas/BatchOperationResult" + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/temporal/entities/": { + "get": { + "description": "Query temporal evolution of Entities from an NGSI-LD system", + "operationId": "queryTemporalEntities", + "tags": [ + "Temporal Evolution", + "Temporal" + ], + "parameters": [ + { + "$ref": "#/components/parameters/id" + }, + { + "$ref": "#/components/parameters/idPattern" + }, + { + "$ref": "#/components/parameters/type" + }, + { + "$ref": "#/components/parameters/attrs" + }, + { + "$ref": "#/components/parameters/q" + }, + { + "$ref": "#/components/parameters/georel" + }, + { + "$ref": "#/components/parameters/geometry" + }, + { + "$ref": "#/components/parameters/coordinates" + }, + { + "$ref": "#/components/parameters/geoproperty" + }, + { + "$ref": "#/components/parameters/timerel" + }, + { + "$ref": "#/components/parameters/timeproperty" + }, + { + "$ref": "#/components/parameters/time" + }, + { + "$ref": "#/components/parameters/endTime" + }, + { + "$ref": "#/components/parameters/csf" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/components-parameters-options" + }, + { + "$ref": "#/components/parameters/lastN" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/EntityTemporalList" + }, + "examples": { + "simple": { + "externalValue": "http://localhost:8090/examples/EntityTemporalList-example.json" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "post": { + "description": "Create or update temporal representation of an Entity within an NGSI-LD system", + "operationId": "createUpdateEntityTemporal", + "tags": [ + "Temporal Evolution", + "Temporal" + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/EntityTemporal" + }, + "examples": { + "simple": { + "externalValue": "http://localhost:8090/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": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Already exists", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/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", + "Temporal" + ], + "parameters": [ + { + "$ref": "#/components/parameters/entityId" + }, + { + "$ref": "#/components/parameters/attrs" + }, + { + "$ref": "#/components/parameters/parameters-type" + }, + { + "$ref": "#/components/parameters/components-parameters-options" + }, + { + "$ref": "#/components/parameters/timerel" + }, + { + "$ref": "#/components/parameters/timeproperty" + }, + { + "$ref": "#/components/parameters/time" + }, + { + "$ref": "#/components/parameters/endTime" + }, + { + "$ref": "#/components/parameters/lastN" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/EntityTemporal" + }, + "examples": { + "simple": { + "externalValue": "http://localhost:8090/examples/EntityTemporal-example_C5.5.3.json" + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "delete": { + "description": "Removes the temporal representation of an Entity from an NGSI-LD system", + "operationId": "removeEntityTemporalById", + "tags": [ + "Temporal Evolution", + "Temporal" + ], + "parameters": [ + { + "$ref": "#/components/parameters/entityId" + }, + { + "$ref": "#/components/parameters/parameters-type" + } + ], + "responses": { + "204": { + "description": "No Content. The entity was removed successfully" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/temporal/entities/{entityId}/attrs/": { + "post": { + "description": "Add new attributes to an existing Temporal Entity within an NGSI-LD system", + "operationId": "addTemporalEntityAttrs", + "tags": [ + "Temporal Evolution", + "Temporal" + ], + "parameters": [ + { + "$ref": "#/components/parameters/entityId" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/EntityTemporalFragment" + } + } + } + }, + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/temporal/entities/{entityId}/attrs/{attrId}": { + "delete": { + "description": "Attribute from Temporal Representation of Entity deletion", + "operationId": "removeEntityTemporalAttr", + "tags": [ + "Temporal Evolution", + "Temporal" + ], + "parameters": [ + { + "$ref": "#/components/parameters/entityId" + }, + { + "$ref": "#/components/parameters/attrId" + } + ], + "responses": { + "204": { + "description": "No Content." + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/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", + "Temporal" + ], + "parameters": [ + { + "$ref": "#/components/parameters/entityId" + }, + { + "$ref": "#/components/parameters/attrId" + }, + { + "$ref": "#/components/parameters/instanceId" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/EntityTemporalFragment" + } + } + } + }, + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "description": "Bad request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "delete": { + "description": "Attribute Instance deletion by instance id.", + "operationId": "removeEntityTemporalAttrInstance", + "tags": [ + "Temporal Evolution", + "Temporal" + ], + "parameters": [ + { + "$ref": "#/components/parameters/entityId" + }, + { + "$ref": "#/components/parameters/attrId" + }, + { + "$ref": "#/components/parameters/instanceId" + } + ], + "responses": { + "204": { + "description": "No Content." + }, + "400": { + "description": "Bad Request", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + } + }, + "components": { + "parameters": { + "id": { + "name": "id", + "description": "Comma separated list of URIs to be retrieved", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "uri" + } + }, + "idPattern": { + "name": "idPattern", + "description": "Regular expression that must be matched by Entity ids", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "regexp" + } + }, + "type": { + "name": "type", + "description": "Comma separated list of Entity type names to be retrieved", + "in": "query", + "required": false, + "schema": { + "type": "string", + "minLength": 1 + } + }, + "attrs": { + "name": "attrs", + "description": "Comma separated list of attribute names (properties or relationships) to be retrieved", + "in": "query", + "required": false, + "schema": { + "type": "string", + "minLength": 1 + } + }, + "q": { + "name": "q", + "description": "Query", + "in": "query", + "required": false, + "schema": { + "type": "string", + "minLength": 1 + } + }, + "georel": { + "name": "georel", + "description": "Geo-relationship", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/georel" + } + }, + "geometry": { + "name": "geometry", + "description": "Geometry", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/geometry" + } + }, + "coordinates": { + "name": "coordinates", + "description": "Coordinates serialized as a string", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/coordinates" + } + }, + "geoproperty": { + "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 + } + }, + "csf": { + "name": "csf", + "description": "Context Source Filter", + "in": "query", + "required": false, + "schema": { + "type": "string", + "minLength": 1 + } + }, + "limit": { + "name": "limit", + "description": "Pagination limit", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1 + } + }, + "options": { + "name": "options", + "description": "Options dictionary", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "keyValues", + "sysAttrs" + ] + } + }, + "entityId": { + "name": "entityId", + "description": "Entity Id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uri" + } + }, + "parameters-type": { + "name": "type", + "description": "Entity Type", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/Name" + } + }, + "parameters-options": { + "name": "options", + "description": "Indicates that no attribute overwrite shall be performed", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "noOverwrite" + ] + } + }, + "attrId": { + "name": "attrId", + "description": "Attribute Id", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/Name" + } + }, + "subscriptionId": { + "name": "subscriptionId", + "description": "Subscription Id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uri" + } + }, + "registrationId": { + "name": "registrationId", + "description": "Registration Id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uri" + } + }, + "timerel": { + "name": "timerel", + "description": "Time relationship", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/timerel" + } + }, + "timeproperty": { + "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": "#/components/schemas/Name" + } + }, + "time": { + "name": "time", + "description": "start time for temporal query", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + "endTime": { + "name": "endTime", + "description": "end time for temporal query", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + "components-parameters-options": { + "name": "options", + "description": "Options dictionary", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "temporalValues", + "sysAttrs" + ] + } + }, + "lastN": { + "name": "lastN", + "description": "Only retrieve last N instances", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1 + } + }, + "instanceId": { + "name": "instanceId", + "description": "Instance Id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uri" + } + } + }, + "schemas": { + "georel": { + "oneOf": [ + { + "type": "string", + "enum": [ + "equals", + "disjoint", + "intersects", + "within", + "contains", + "overlaps" + ] + }, + { + "type": "string", + "pattern": "^near;((maxDistance==\\d+)|(minDistance==\\d+))$" + } + ] + }, + "geometry": { + "type": "string", + "enum": [ + "Point", + "MultiPoint", + "LineString", + "MultiLineString", + "Polygon", + "MultiPolygon" + ] + }, + "position": { + "description": "A single position", + "type": "array", + "minItems": 2, + "maxItems": 2, + "items": { + "type": "number" + }, + "additionalProperties": false + }, + "positionArray": { + "description": "An array of positions", + "type": "array", + "items": { + "$ref": "#/components/schemas/position" + } + }, + "lineString": { + "description": "An array of two or more positions", + "allOf": [ + { + "$ref": "#/components/schemas/positionArray" + }, + { + "minItems": 2 + } + ] + }, + "linearRing": { + "description": "An array of four positions where the first equals the last", + "allOf": [ + { + "$ref": "#/components/schemas/positionArray" + }, + { + "minItems": 4 + } + ] + }, + "polygon": { + "description": "An array of linear rings", + "type": "array", + "items": { + "$ref": "#/components/schemas/linearRing" + } + }, + "coordinates": { + "oneOf": [ + { + "$ref": "#/components/schemas/position" + }, + { + "$ref": "#/components/schemas/positionArray" + }, + { + "$ref": "#/components/schemas/lineString" + }, + { + "$ref": "#/components/schemas/polygon" + } + ] + }, + "LdContext": { + "oneOf": [ + { + "type": "object" + }, + { + "type": "string", + "format": "uri" + }, + { + "type": "array", + "minItems": 1, + "items": { + "oneOf": [ + { + "type": "string", + "format": "uri" + }, + { + "type": "object" + } + ] + } + } + ] + }, + "Point": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "Point" + ] + }, + "coordinates": { + "$ref": "#/components/schemas/position" + } + } + }, + "MultiPoint": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "MultiPoint" + ] + }, + "coordinates": { + "$ref": "#/components/schemas/positionArray" + } + } + }, + "Polygon": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "Polygon" + ] + }, + "coordinates": { + "$ref": "#/components/schemas/polygon" + } + } + }, + "LineString": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "LineString" + ] + }, + "coordinates": { + "$ref": "#/components/schemas/lineString" + } + } + }, + "MultiLineString": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "MultiLineString" + ] + }, + "coordinates": { + "type": "array", + "items": { + "$ref": "#/components/schemas/lineString" + } + } + } + }, + "MultiPolygon": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "MultiPolygon" + ] + }, + "coordinates": { + "type": "array", + "items": { + "$ref": "#/components/schemas/polygon" + } + } + } + }, + "Geometry": { + "description": " Avalid GeoJSON geometry object", + "oneOf": [ + { + "$ref": "#/components/schemas/Point" + }, + { + "$ref": "#/components/schemas/MultiPoint" + }, + { + "$ref": "#/components/schemas/Polygon" + }, + { + "$ref": "#/components/schemas/LineString" + }, + { + "$ref": "#/components/schemas/MultiLineString" + }, + { + "$ref": "#/components/schemas/MultiPolygon" + } + ] + }, + "observedAt": { + "type": "string", + "format": "date-time" + }, + "createdAt": { + "type": "string", + "format": "date-time" + }, + "modifiedAt": { + "type": "string", + "format": "date-time" + }, + "datasetId": { + "type": "string", + "format": "uri" + }, + "instanceId": { + "type": "string", + "format": "uri" + }, + "Property": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "Property" + ] + }, + "value": { + "oneOf": [ + "string", + "number", + "boolean", + "array", + "object" + ] + }, + "observedAt": { + "$ref": "#/components/schemas/observedAt" + }, + "createdAt": { + "$ref": "#/components/schemas/createdAt" + }, + "modifiedAt": { + "$ref": "#/components/schemas/modifiedAt" + }, + "datasetId": { + "$ref": "#/components/schemas/datasetId" + }, + "instanceId": { + "$ref": "#/components/schemas/instanceId" + } + }, + "required": [ + "type", + "value" + ], + "additionalProperties": { + "oneOf": [ + { + "$ref": "#/components/schemas/Property" + }, + { + "$ref": "#/components/schemas/Relationship" + } + ] + } + }, + "Relationship": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "Relationship" + ] + }, + "object": { + "type": "string", + "format": "uri" + }, + "observedAt": { + "$ref": "#/components/schemas/observedAt" + }, + "createdAt": { + "$ref": "#/components/schemas/createdAt" + }, + "modifiedAt": { + "$ref": "#/components/schemas/modifiedAt" + }, + "datasetId": { + "$ref": "#/components/schemas/datasetId" + }, + "instanceId": { + "$ref": "#/components/schemas/instanceId" + } + }, + "required": [ + "type", + "object" + ], + "additionalProperties": { + "oneOf": [ + { + "$ref": "#/components/schemas/Property" + }, + { + "$ref": "#/components/schemas/Relationship" + } + ] + } + }, + "GeoProperty": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "GeoProperty" + ] + }, + "value": { + "$ref": "#/components/schemas/Geometry" + }, + "observedAt": { + "$ref": "#/components/schemas/observedAt" + }, + "createdAt": { + "$ref": "#/components/schemas/createdAt" + }, + "modifiedAt": { + "$ref": "#/components/schemas/modifiedAt" + }, + "datasetId": { + "$ref": "#/components/schemas/datasetId" + }, + "instanceId": { + "$ref": "#/components/schemas/instanceId" + } + }, + "required": [ + "type", + "value" + ], + "additionalProperties": { + "oneOf": [ + { + "$ref": "#/components/schemas/Property" + }, + { + "$ref": "#/components/schemas/Relationship" + } + ] + } + }, + "Name": { + "type": "string", + "pattern": "^((\\d|[a-zA-Z]|_)+(:(\\d|[a-zA-Z]|_)+)?(#\\d+)?)$", + "minLength": 1, + "description": "NGSI-LD Name" + }, + "EntityFragment": { + "type": "object", + "properties": { + "@context": { + "$ref": "#/components/schemas/LdContext" + }, + "location": { + "$ref": "#/components/schemas/GeoProperty" + }, + "observationSpace": { + "$ref": "#/components/schemas/GeoProperty" + }, + "operationSpace": { + "$ref": "#/components/schemas/GeoProperty" + }, + "id": { + "type": "string", + "format": "uri" + }, + "type": { + "$ref": "#/components/schemas/Name" + }, + "createdAt": { + "$ref": "#/components/schemas/createdAt" + }, + "modifiedAt": { + "$ref": "#/components/schemas/modifiedAt" + } + }, + "additionalProperties": { + "oneOf": [ + { + "$ref": "#/components/schemas/Property" + }, + { + "$ref": "#/components/schemas/Relationship" + }, + { + "$ref": "#/components/schemas/GeoProperty" + } + ] + } + }, + "Entity": { + "allOf": [ + { + "required": [ + "id", + "type" + ] + }, + { + "$ref": "#/components/schemas/EntityFragment" + } + ] + }, + "EntityList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Entity" + } + }, + "ProblemDetails": { + "type": "object", + "properties": { + "type": { + "type": "string", + "format": "uri" + }, + "title": { + "type": "string" + }, + "detail": { + "type": "string" + } + }, + "required": [ + "type" + ] + }, + "NotUpdatedDetails": { + "type": "object", + "properties": { + "attributeName": { + "type": "string", + "pattern": "" + }, + "reason": { + "type": "string", + "minLength": 1 + } + } + }, + "UpdateResult": { + "type": "object", + "properties": { + "updated": { + "type": "array", + "items": { + "type": "string", + "pattern": "" + } + }, + "notUpdated": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NotUpdatedDetails" + } + } + } + }, + "EntityInfo": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uri" + }, + "type": { + "$ref": "#/components/schemas/Name" + }, + "idPattern": { + "type": "string", + "format": "regex" + } + }, + "required": [ + "type" + ] + }, + "GeoQuery": { + "type": "object", + "required": [ + "geometry", + "coordinates", + "georel" + ], + "properties": { + "georel": { + "$ref": "#/components/schemas/georel" + }, + "coordinates": { + "$ref": "#/components/schemas/coordinates" + }, + "geometry": { + "$ref": "#/components/schemas/geometry" + } + } + }, + "SubscriptionFragment": { + "type": "object", + "properties": { + "@context": { + "$ref": "#/components/schemas/LdContext" + }, + "entities": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EntityInfo" + }, + "minItems": 1 + }, + "name": { + "type": "string", + "minLength": 1 + }, + "description": { + "type": "string", + "minLength": 1 + }, + "watchedAttributes": { + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/components/schemas/Name" + }, + "uniqueItems": true + }, + "timeInterval": { + "type": "number", + "minimum": 0 + }, + "expires": { + "type": "string", + "format": "date-time" + }, + "isActive": { + "type": "boolean" + }, + "throttling": { + "type": "number", + "minimum": 1 + }, + "q": { + "type": "string" + }, + "geoQ": { + "$ref": "#/components/schemas/GeoQuery" + }, + "csf": { + "type": "string" + } + } + }, + "Endpoint": { + "type": "object", + "required": [ + "uri" + ], + "properties": { + "uri": { + "type": "string", + "format": "uri" + }, + "accept": { + "type": "string", + "enum": [ + "application/json", + "application/ld+json" + ] + } + } + }, + "NotificationParams": { + "type": "object", + "properties": { + "attributes": { + "type": "array", + "minItems": 1, + "items": { + "type": "string", + "minLength": 1 + }, + "uniqueItems": true + }, + "format": { + "type": "string" + }, + "endpoint": { + "$ref": "#/components/schemas/Endpoint" + }, + "status": { + "type": "string", + "enum": [ + "ok", + "failed" + ] + }, + "timesSent": { + "type": "number", + "minimum": 1 + }, + "lastNotification": { + "type": "string", + "format": "date-time" + }, + "lastFailure": { + "type": "string", + "format": "date-time" + }, + "lastSuccess": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "endpoint" + ] + }, + "Subscription": { + "allOf": [ + { + "$ref": "#/components/schemas/SubscriptionFragment" + }, + { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Subscription" + ] + }, + "notification": { + "$ref": "#/components/schemas/NotificationParams" + }, + "status": { + "type": "string", + "enum": [ + "active", + "paused", + "expired" + ] + }, + "createdAt": { + "$ref": "#/components/schemas/createdAt" + }, + "modifiedAt": { + "$ref": "#/components/schemas/modifiedAt" + } + }, + "allOf": [ + { + "required": [ + "id", + "type", + "notification" + ] + }, + { + "anyOf": [ + { + "required": [ + "entities" + ] + }, + { + "required": [ + "watchedAttributes" + ] + } + ] + } + ] + } + ] + }, + "SubscriptionList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Subscription" + } + }, + "RegistrationInfo": { + "type": "object", + "properties": { + "entities": { + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/components/schemas/EntityInfo" + } + }, + "properties": { + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/components/schemas/Name" + }, + "uniqueItems": true + }, + "relationships": { + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/components/schemas/Name" + }, + "uniqueItems": true + } + } + }, + "TimeInterval": { + "type": "object", + "required": [ + "start" + ], + "properties": { + "start": { + "type": "string", + "format": "date-time" + }, + "end": { + "type": "string", + "format": "date-time" + } + } + }, + "ContextSourceRegistrationFragment": { + "type": "object", + "properties": { + "@context": { + "$ref": "#/components/schemas/LdContext" + }, + "information": { + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/components/schemas/RegistrationInfo" + } + }, + "observationInterval": { + "$ref": "#/components/schemas/TimeInterval" + }, + "managementInterval": { + "$ref": "#/components/schemas/TimeInterval" + }, + "location": { + "$ref": "#/components/schemas/Geometry" + }, + "observationSpace": { + "$ref": "#/components/schemas/Geometry" + }, + "operationSpace": { + "$ref": "#/components/schemas/Geometry" + }, + "expires": { + "type": "string", + "format": "date-time" + }, + "name": { + "type": "string", + "minLength": 1 + }, + "description": { + "type": "string", + "minLength": 1 + }, + "endpoint": { + "type": "string", + "format": "uri" + } + }, + "additionalProperties": true + }, + "ContextSourceRegistration": { + "allOf": [ + { + "$ref": "#/components/schemas/ContextSourceRegistrationFragment" + }, + { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "ContextSourceRegistration" + ] + }, + "createdAt": { + "$ref": "#/components/schemas/createdAt" + }, + "modifiedAt": { + "$ref": "#/components/schemas/modifiedAt" + } + }, + "required": [ + "id", + "type", + "endpoint", + "information" + ] + } + ] + }, + "ContextSourceRegistrationList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ContextSourceRegistration" + } + }, + "BatchEntityError": { + "type": "object", + "properties": { + "entityId": { + "type": "string", + "format": "uri" + }, + "error": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + }, + "BatchOperationResult": { + "type": "object", + "properties": { + "success": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + } + }, + "error": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BatchEntityError" + } + } + } + }, + "timerel": { + "type": "string", + "enum": [ + "before", + "after", + "between" + ] + }, + "EntityTemporalFragment": { + "type": "object", + "properties": { + "@context": { + "$ref": "#/components/schemas/LdContext" + }, + "location": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GeoProperty" + }, + "minItems": 1 + }, + "observationSpace": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GeoProperty" + }, + "minItems": 1 + }, + "operationSpace": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GeoProperty" + }, + "minItems": 1 + }, + "id": { + "type": "string", + "format": "uri" + }, + "type": { + "$ref": "#/components/schemas/Name" + }, + "createdAt": { + "$ref": "#/components/schemas/createdAt" + }, + "modifiedAt": { + "$ref": "#/components/schemas/modifiedAt" + } + }, + "additionalProperties": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/Property" + }, + "minItems": 1 + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/Relationship" + }, + "minItems": 1 + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/GeoProperty" + }, + "minItems": 1 + } + ] + } + }, + "EntityTemporal": { + "allOf": [ + { + "$ref": "#/components/schemas/EntityTemporalFragment" + }, + { + "type": "object", + "required": [ + "type", + "id" + ] + } + ] + }, + "EntityTemporalList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EntityTemporal" + } + } + } + } +} \ No newline at end of file diff --git a/spec/updated/ngsi-ld-spec-open-api.json b/spec/updated/ngsi-ld-spec-open-api.json index c518c58..7164244 100644 --- a/spec/updated/ngsi-ld-spec-open-api.json +++ b/spec/updated/ngsi-ld-spec-open-api.json @@ -48,61 +48,61 @@ ], "paths": { "/entities/": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/paths/%2Fentities%2F" + "$ref": "http://localhost:8090/spec/updated/entities/entities-spec.json#/paths/%2Fentities%2F" }, "/entities/{entityId}": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-by-id-spec.json#/paths/%2Fentities%2F%7BentityId%7D" + "$ref": "http://localhost:8090/spec/updated/entities/entity-by-id-spec.json#/paths/%2Fentities%2F%7BentityId%7D" }, "/entities/{entityId}/attrs/": { - "$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" + "$ref": "http://localhost:8090/spec/updated/entities/entity-attrs-spec.json#/paths/%2Fentities%2F%7BentityId%7D%2Fattrs%2F" }, "/entities/{entityId}/attrs/{attrId}": { - "$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" + "$ref": "http://localhost:8090/spec/updated/entities/entity-attrs-spec.json#/paths/%2Fentities%2F%7BentityId%7D%2Fattrs%2F%7BattrId%7D" }, "/subscriptions/": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/subscriptions-spec.json#/paths/%2Fsubscriptions%2F" + "$ref": "http://localhost:8090/spec/updated/subscriptions/subscriptions-spec.json#/paths/%2Fsubscriptions%2F" }, "/subscriptions/{subscriptionId}": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/subscription-by-id-spec.json#/paths/%2Fsubscriptions%2F%7BsubscriptionId%7D" + "$ref": "http://localhost:8090/spec/updated/subscriptions/subscription-by-id-spec.json#/paths/%2Fsubscriptions%2F%7BsubscriptionId%7D" }, "/csourceRegistrations/": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/csource-registrations-spec.json#/paths/%2FcsourceRegistrations%2F" + "$ref": "http://localhost:8090/spec/updated/csourceRegistrations/csource-registrations-spec.json#/paths/%2FcsourceRegistrations%2F" }, "/csourceRegistrations/{registrationId}": { - "$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" + "$ref": "http://localhost:8090/spec/updated/csourceRegistrations/csource-registration-by-id-spec.json#/paths/%2FcsourceRegistrations%2F%7BregistrationId%7D" }, "/csourceSubscriptions/": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/csource-subscriptions-spec.json#/paths/%2FcsourceSubscriptions%2F" + "$ref": "http://localhost:8090/spec/updated/csourceSubscriptions/csource-subscriptions-spec.json#/paths/%2FcsourceSubscriptions%2F" }, "/csourceSubscriptions/{subscriptionId}": { - "$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" + "$ref": "http://localhost:8090/spec/updated/csourceSubscriptions/csource-subscription-by-id-spec.json#/paths/%2FcsourceSubscriptions%2F%7BsubscriptionId%7D" }, "/entityOperations/create": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-operations-spec.json#/paths/%2FentityOperations%2Fcreate" + "$ref": "http://localhost:8090/spec/updated/entities/entity-operations-spec.json#/paths/%2FentityOperations%2Fcreate" }, "/entityOperations/update": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-operations-spec.json#/paths/%2FentityOperations%2Fupdate" + "$ref": "http://localhost:8090/spec/updated/entities/entity-operations-spec.json#/paths/%2FentityOperations%2Fupdate" }, "/entityOperations/upsert": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-operations-spec.json#/paths/%2FentityOperations%2Fupsert" + "$ref": "http://localhost:8090/spec/updated/entities/entity-operations-spec.json#/paths/%2FentityOperations%2Fupsert" }, "/entityOperations/delete": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-operations-spec.json#/paths/%2FentityOperations%2Fdelete" + "$ref": "http://localhost:8090/spec/updated/entities/entity-operations-spec.json#/paths/%2FentityOperations%2Fdelete" }, "/temporal/entities/": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal/temporal-entities-spec.json#/paths/%2Ftemporal%2Fentities%2F" + "$ref": "http://localhost:8090/spec/updated/temporal/temporal-entities-spec.json#/paths/%2Ftemporal%2Fentities%2F" }, "/temporal/entities/{entityId}": { - "$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" + "$ref": "http://localhost:8090/spec/updated/temporal/temporal-entity-by-id-spec.json#/paths/%2Ftemporal%2Fentities%2F%7BentityId%7D" }, "/temporal/entities/{entityId}/attrs/": { - "$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" + "$ref": "http://localhost:8090/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/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" + "$ref": "http://localhost:8090/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/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" + "$ref": "http://localhost:8090/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/subscriptions/subscription-by-id-spec.json similarity index 72% rename from spec/updated/subscription-by-id-spec.json rename to spec/updated/subscriptions/subscription-by-id-spec.json index fe16781..e53310e 100644 --- a/spec/updated/subscription-by-id-spec.json +++ b/spec/updated/subscriptions/subscription-by-id-spec.json @@ -23,7 +23,7 @@ "get": { "description": "Retrieves a specific Subscription from an NGSI-LD system", "operationId": "retrieveSubscriptionById", - "tags": ["Context Subscription"], + "tags": ["Context Subscription", "Subscriptions"], "parameters": [ { "$ref": "#/components/parameters/subscriptionId" @@ -35,11 +35,11 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/subscriptions/Subscription.json#/definitions/Subscription" + "$ref": "http://localhost:8090/schema/subscriptions/Subscription.json#/definitions/Subscription" }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/Subscription-example_C.4.json" + "externalValue": "http://localhost:8090/examples/Subscription-example_C.4.json" } } } @@ -50,7 +50,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -60,7 +60,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -70,7 +70,7 @@ "patch": { "description": "Updates a specific Subscription within an NGSI-LD system", "operationId": "updateSubscription", - "tags": ["Context Subscription"], + "tags": ["Context Subscription", "Subscriptions"], "parameters": [ { "$ref": "#/components/parameters/subscriptionId" @@ -81,7 +81,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/subscriptions/Subscription.json#/definitions/SubscriptionFragment" + "$ref": "http://localhost:8090/schema/subscriptions/Subscription.json#/definitions/SubscriptionFragment" } } } @@ -95,7 +95,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -105,7 +105,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -115,7 +115,7 @@ "delete": { "description": "Removes a specific Subscription from an NGSI-LD system", "operationId": "removeSubscription", - "tags": ["Context Subscription"], + "tags": ["Context Subscription", "Subscriptions"], "parameters": [ { "$ref": "#/components/parameters/subscriptionId" @@ -130,7 +130,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -140,7 +140,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } diff --git a/spec/updated/subscriptions-spec.json b/spec/updated/subscriptions/subscriptions-spec.json similarity index 71% rename from spec/updated/subscriptions-spec.json rename to spec/updated/subscriptions/subscriptions-spec.json index e8a79d4..635cf38 100644 --- a/spec/updated/subscriptions-spec.json +++ b/spec/updated/subscriptions/subscriptions-spec.json @@ -23,8 +23,9 @@ "get": { "description": "Retrieves the subscriptions available in an NGSI-LD system", "operationId": "retrieveSubscriptions", - "tags":[ - "Context Subscription" + "tags": [ + "Context Subscription", + "Subscriptions" ], "parameters": [ { @@ -37,11 +38,11 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/subscriptions/SubscriptionList.json#/definitions/SubscriptionList" + "$ref": "http://localhost:8090/schema/subscriptions/SubscriptionList.json#/definitions/SubscriptionList" }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/SubscriptionList-example.json" + "externalValue": "http://localhost:8090/examples/SubscriptionList-example.json" } } } @@ -52,7 +53,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -62,15 +63,16 @@ "post": { "description": "Creates a new Subscription within an NGSI-LD system", "operationId": "createSubscription", - "tags":[ - "Context Subscription" + "tags": [ + "Context Subscription", + "Subscriptions" ], "requestBody": { "required": true, "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/subscriptions/Subscription.json#/definitions/Subscription" + "$ref": "http://localhost:8090/schema/subscriptions/Subscription.json#/definitions/Subscription" } } } @@ -84,7 +86,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -94,7 +96,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } diff --git a/spec/updated/temporal/temporal-entities-spec.json b/spec/updated/temporal/temporal-entities-spec.json index 2f21ace..557516e 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/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/timerel" + "$ref": "http://localhost:8090/schema/common.json#/definitions/timerel" } }, "time": { @@ -41,7 +41,7 @@ "in": "query", "required": false, "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" + "$ref": "http://localhost:8090/schema/common.json#/definitions/Name" } }, "lastN": { @@ -74,34 +74,34 @@ "get": { "description": "Query temporal evolution of Entities from an NGSI-LD system", "operationId": "queryTemporalEntities", - "tags": ["Temporal Evolution"], + "tags": ["Temporal Evolution", "Temporal"], "parameters": [ { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/id" + "$ref": "http://localhost:8090/spec/updated/entities/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/idPattern" + "$ref": "http://localhost:8090/spec/updated/entities/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/type" + "$ref": "http://localhost:8090/spec/updated/entities/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/attrs" + "$ref": "http://localhost:8090/spec/updated/entities/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/q" + "$ref": "http://localhost:8090/spec/updated/entities/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/georel" + "$ref": "http://localhost:8090/spec/updated/entities/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/geometry" + "$ref": "http://localhost:8090/spec/updated/entities/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/coordinates" + "$ref": "http://localhost:8090/spec/updated/entities/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/geoproperty" + "$ref": "http://localhost:8090/spec/updated/entities/entities-spec.json#/components/parameters/geoproperty" }, { "$ref": "#/components/parameters/timerel" @@ -116,10 +116,10 @@ "$ref": "#/components/parameters/endTime" }, { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/csf" + "$ref": "http://localhost:8090/spec/updated/entities/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/limit" + "$ref": "http://localhost:8090/spec/updated/entities/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/rep/NGSI-LD/NGSI-LD/raw/master/schema/temporal/EntityTemporalList.json#/definitions/EntityTemporalList" + "$ref": "http://localhost:8090/schema/temporal/EntityTemporalList.json#/definitions/EntityTemporalList" }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/EntityTemporalList-example.json" + "externalValue": "http://localhost:8090/examples/EntityTemporalList-example.json" } } } @@ -149,7 +149,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -159,17 +159,17 @@ "post": { "description": "Create or update temporal representation of an Entity within an NGSI-LD system", "operationId": "createUpdateEntityTemporal", - "tags": ["Temporal Evolution"], + "tags": ["Temporal Evolution", "Temporal"], "requestBody": { "required": true, "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/temporal/EntityTemporal.json#/definitions/EntityTemporal" + "$ref": "http://localhost:8090/schema/temporal/EntityTemporal.json#/definitions/EntityTemporal" }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/EntityTemporal-example_C5.5.3.json" + "externalValue": "http://localhost:8090/examples/EntityTemporal-example_C5.5.3.json" } } } @@ -187,7 +187,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -197,7 +197,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -207,7 +207,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/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 8533bd9..0508822 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/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" + "$ref": "http://localhost:8090/schema/common.json#/definitions/Name" } }, "instanceId": { @@ -42,7 +42,7 @@ "post": { "description": "Add new attributes to an existing Temporal Entity within an NGSI-LD system", "operationId": "addTemporalEntityAttrs", - "tags": ["Temporal Evolution"], + "tags": ["Temporal Evolution", "Temporal"], "parameters": [ { "$ref": "#/components/parameters/entityId" @@ -53,7 +53,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/temporal/EntityTemporal.json#/definitions/EntityTemporalFragment" + "$ref": "http://localhost:8090/schema/temporal/EntityTemporal.json#/definitions/EntityTemporalFragment" } } } @@ -67,7 +67,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -77,7 +77,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -89,7 +89,7 @@ "delete": { "description": "Attribute from Temporal Representation of Entity deletion", "operationId": "removeEntityTemporalAttr", - "tags": ["Temporal Evolution"], + "tags": ["Temporal Evolution", "Temporal"], "parameters": [ { "$ref": "#/components/parameters/entityId" @@ -107,7 +107,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -117,7 +117,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -129,7 +129,7 @@ "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"], + "tags": ["Temporal Evolution", "Temporal"], "parameters": [ { "$ref": "#/components/parameters/entityId" @@ -146,7 +146,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/temporal/EntityTemporal.json#/definitions/EntityTemporalFragment" + "$ref": "http://localhost:8090/schema/temporal/EntityTemporal.json#/definitions/EntityTemporalFragment" } } } @@ -160,7 +160,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -170,7 +170,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -180,7 +180,7 @@ "delete": { "description": "Attribute Instance deletion by instance id.", "operationId": "removeEntityTemporalAttrInstance", - "tags": ["Temporal Evolution"], + "tags": ["Temporal Evolution", "Temporal"], "parameters": [ { "$ref": "#/components/parameters/entityId" @@ -201,7 +201,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -211,7 +211,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/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 71e0b25..7810757 100644 --- a/spec/updated/temporal/temporal-entity-by-id-spec.json +++ b/spec/updated/temporal/temporal-entity-by-id-spec.json @@ -11,34 +11,34 @@ "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"], + "tags": ["Temporal Evolution", "Temporal"], "parameters": [ { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-by-id-spec.json#/components/parameters/entityId" + "$ref": "http://localhost:8090/spec/updated/entities/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/attrs" + "$ref": "http://localhost:8090/spec/updated/entities/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/type" + "$ref": "http://localhost:8090/spec/updated/entities/entity-by-id-spec.json#/components/parameters/type" }, { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal/temporal-entities-spec.json#/components/parameters/options" + "$ref": "http://localhost:8090/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/timerel" + "$ref": "http://localhost:8090/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/timeproperty" + "$ref": "http://localhost:8090/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/time" + "$ref": "http://localhost:8090/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/endTime" + "$ref": "http://localhost:8090/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/lastN" + "$ref": "http://localhost:8090/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/rep/NGSI-LD/NGSI-LD/raw/master/schema/temporal/EntityTemporal.json#/definitions/EntityTemporal" + "$ref": "http://localhost:8090/schema/temporal/EntityTemporal.json#/definitions/EntityTemporal" }, "examples": { "simple": { - "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/EntityTemporal-example_C5.5.3.json" + "externalValue": "http://localhost:8090/examples/EntityTemporal-example_C5.5.3.json" } } } @@ -62,7 +62,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -72,7 +72,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -82,13 +82,13 @@ "delete": { "description": "Removes the temporal representation of an Entity from an NGSI-LD system", "operationId": "removeEntityTemporalById", - "tags": ["Temporal Evolution"], + "tags": ["Temporal Evolution", "Temporal"], "parameters": [ { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-by-id-spec.json#/components/parameters/entityId" + "$ref": "http://localhost:8090/spec/updated/entities/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/type" + "$ref": "http://localhost:8090/spec/updated/entities/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/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } @@ -110,7 +110,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" + "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" } } } -- GitLab From 53265fefa226106fffeed83e4f795b610f8be224 Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Thu, 4 Feb 2021 11:49:28 +0100 Subject: [PATCH 08/43] warn --- spec/updated/full_api.json | 3014 ------------------------------ spec/updated/generated/README.md | 1 + 2 files changed, 1 insertion(+), 3014 deletions(-) delete mode 100644 spec/updated/full_api.json create mode 100644 spec/updated/generated/README.md diff --git a/spec/updated/full_api.json b/spec/updated/full_api.json deleted file mode 100644 index ea8155d..0000000 --- a/spec/updated/full_api.json +++ /dev/null @@ -1,3014 +0,0 @@ -{ - "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": [ - { - "$ref": "#/components/parameters/id" - }, - { - "$ref": "#/components/parameters/idPattern" - }, - { - "$ref": "#/components/parameters/type" - }, - { - "$ref": "#/components/parameters/attrs" - }, - { - "$ref": "#/components/parameters/q" - }, - { - "$ref": "#/components/parameters/georel" - }, - { - "$ref": "#/components/parameters/geometry" - }, - { - "$ref": "#/components/parameters/coordinates" - }, - { - "$ref": "#/components/parameters/geoproperty" - }, - { - "$ref": "#/components/parameters/csf" - }, - { - "$ref": "#/components/parameters/limit" - }, - { - "$ref": "#/components/parameters/options" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/EntityList" - }, - "examples": { - "simple": { - "externalValue": "http://localhost:8090/examples/EntityList-example.json" - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - }, - "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": { - "$ref": "#/components/schemas/Entity" - } - } - } - }, - "responses": { - "201": { - "description": "Created. Contains the resource URI of the created Entity" - }, - "400": { - "description": "Bad request", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "409": { - "description": "Already exists", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "422": { - "description": "Unprocessable Entity", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/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": [ - { - "$ref": "#/components/parameters/entityId" - }, - { - "$ref": "#/components/parameters/attrs" - }, - { - "$ref": "#/components/parameters/parameters-type" - }, - { - "$ref": "#/components/parameters/options" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/Entity" - }, - "examples": { - "simple": { - "externalValue": "http://localhost:8090/examples/Entity-example.json" - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - }, - "delete": { - "description": "Removes an specific Entity from an NGSI-LD system", - "operationId": "removeEntityById", - "tags": [ - "Context Information" - ], - "parameters": [ - { - "$ref": "#/components/parameters/entityId" - }, - { - "$ref": "#/components/parameters/parameters-type" - } - ], - "responses": { - "204": { - "description": "No Content. The entity was removed successfully" - }, - "400": { - "description": "Bad Request", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/entities/{entityId}/attrs/": { - "post": { - "description": "Append new Entity attributes to an existing Entity within an NGSI-LD system", - "operationId": "appendEntityAttrs", - "tags": [ - "Context Information" - ], - "parameters": [ - { - "$ref": "#/components/parameters/entityId" - }, - { - "$ref": "#/components/parameters/parameters-options" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/EntityFragment" - } - } - } - }, - "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": { - "$ref": "#/components/schemas/UpdateResult" - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - }, - "patch": { - "description": "Update existing Entity attributes within an NGSI-LD system", - "operationId": "updateEntityAttrs", - "tags": [ - "Context Information" - ], - "parameters": [ - { - "$ref": "#/components/parameters/entityId" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/EntityFragment" - } - } - } - }, - "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": "#/components/schemas/UpdateResult" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/entities/{entityId}/attrs/{attrId}": { - "patch": { - "description": "Update existing Entity attributes within an NGSI-LD system", - "operationId": "partialAttrUpdate", - "tags": [ - "Context Information" - ], - "parameters": [ - { - "$ref": "#/components/parameters/entityId" - }, - { - "$ref": "#/components/parameters/attrId" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/EntityFragment" - } - } - } - }, - "responses": { - "204": { - "description": "No Content." - }, - "400": { - "description": "Bad Request", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - }, - "delete": { - "description": "Removes an existing Entity attribute within an NGSI-LD system", - "operationId": "removeEntityAttr", - "tags": [ - "Context Information" - ], - "parameters": [ - { - "$ref": "#/components/parameters/entityId" - }, - { - "$ref": "#/components/parameters/attrId" - } - ], - "responses": { - "204": { - "description": "No Content." - }, - "400": { - "description": "Bad Request", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/subscriptions/": { - "get": { - "description": "Retrieves the subscriptions available in an NGSI-LD system", - "operationId": "retrieveSubscriptions", - "tags": [ - "Context Subscription" - ], - "parameters": [ - { - "$ref": "#/components/parameters/limit" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/SubscriptionList" - }, - "examples": { - "simple": { - "externalValue": "http://localhost:8090/examples/SubscriptionList-example.json" - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - }, - "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": { - "$ref": "#/components/schemas/Subscription" - } - } - } - }, - "responses": { - "201": { - "description": "Created. Contains the resource URI of the created Subscription" - }, - "400": { - "description": "Bad request", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "409": { - "description": "Already exists", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/subscriptions/{subscriptionId}": { - "get": { - "description": "Retrieves a specific Subscription from an NGSI-LD system", - "operationId": "retrieveSubscriptionById", - "tags": [ - "Context Subscription" - ], - "parameters": [ - { - "$ref": "#/components/parameters/subscriptionId" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/Subscription" - }, - "examples": { - "simple": { - "externalValue": "http://localhost:8090/examples/Subscription-example_C.4.json" - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - }, - "patch": { - "description": "Updates a specific Subscription within an NGSI-LD system", - "operationId": "updateSubscription", - "tags": [ - "Context Subscription" - ], - "parameters": [ - { - "$ref": "#/components/parameters/subscriptionId" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/SubscriptionFragment" - } - } - } - }, - "responses": { - "204": { - "description": "No Content. The Subscription was updated successfully" - }, - "400": { - "description": "Bad Request", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - }, - "delete": { - "description": "Removes a specific Subscription from an NGSI-LD system", - "operationId": "removeSubscription", - "tags": [ - "Context Subscription" - ], - "parameters": [ - { - "$ref": "#/components/parameters/subscriptionId" - } - ], - "responses": { - "204": { - "description": "No Content. The Subscription was removed successfully" - }, - "400": { - "description": "Bad Request", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/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": "#/components/parameters/id" - }, - { - "$ref": "#/components/parameters/idPattern" - }, - { - "$ref": "#/components/parameters/type" - }, - { - "$ref": "#/components/parameters/attrs" - }, - { - "$ref": "#/components/parameters/q" - }, - { - "$ref": "#/components/parameters/georel" - }, - { - "$ref": "#/components/parameters/geometry" - }, - { - "$ref": "#/components/parameters/coordinates" - }, - { - "$ref": "#/components/parameters/geoproperty" - }, - { - "$ref": "#/components/parameters/limit" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ContextSourceRegistrationList" - }, - "examples": { - "simple": { - "externalValue": "http://localhost:8090/examples/ContextSourceRegistrationList-example.json" - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - }, - "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": { - "$ref": "#/components/schemas/ContextSourceRegistration" - } - } - } - }, - "responses": { - "201": { - "description": "Created. Contains the resource URI of the created Registration" - }, - "400": { - "description": "Bad request", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "409": { - "description": "Already exists", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/csourceRegistrations/{registrationId}": { - "get": { - "description": "Retrieves a specific context source registration from an NGSI-LD system", - "operationId": "retrieveCsource", - "tags": [ - "Context Sources" - ], - "parameters": [ - { - "$ref": "#/components/parameters/registrationId" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ContextSourceRegistration" - }, - "examples": { - "simple": { - "externalValue": "http://localhost:8090/examples/" - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - }, - "delete": { - "description": "Removes an specific context source registration within an NGSI-LD system", - "operationId": "removeCsource", - "tags": [ - "Context Sources" - ], - "parameters": [ - { - "$ref": "#/components/parameters/registrationId" - } - ], - "responses": { - "204": { - "description": "No Content. The Registration was removed successfully" - }, - "400": { - "description": "Bad Request", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/csourceSubscriptions/": { - "get": { - "description": "Retrieves the context source discovery subscriptions available in an NGSI-LD system", - "operationId": "retrieveCSourceSubscriptions", - "tags": [ - "Context Sources" - ], - "parameters": [ - { - "$ref": "#/components/parameters/limit" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/SubscriptionList" - }, - "examples": { - "simple": { - "externalValue": "http://localhost:8090/examples/SubscriptionList-example.json" - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - }, - "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": "#/components/schemas/Subscription" - } - } - } - }, - "responses": { - "201": { - "description": "Created. Contains the resource URI of the created Subscription" - }, - "400": { - "description": "Bad request", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "409": { - "description": "Already exists", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/csourceSubscriptions/{subscriptionId}": { - "get": { - "description": "Retrieves a specific Subscription from an NGSI-LD system", - "operationId": "retrieveCSourceSubscriptionsById", - "tags": [ - "Context Sources" - ], - "parameters": [ - { - "$ref": "#/components/parameters/subscriptionId" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/Subscription" - }, - "examples": { - "simple": { - "externalValue": "http://localhost:8090/examples/Subscription-example_C.4.json" - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - }, - "patch": { - "description": "Updates a specific context source discovery Subscription within an NGSI-LD system", - "operationId": "updateCSourceSubscription", - "tags": [ - "Context Sources" - ], - "parameters": [ - { - "$ref": "#/components/parameters/subscriptionId" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/SubscriptionFragment" - } - } - } - }, - "responses": { - "204": { - "description": "No Content. The Subscription was updated successfully" - }, - "400": { - "description": "Bad Request", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - }, - "delete": { - "description": "Removes a specific Context Source Subscription from an NGSI-LD system", - "operationId": "removeCSourceSubscription", - "tags": [ - "Context Sources" - ], - "parameters": [ - { - "$ref": "#/components/parameters/subscriptionId" - } - ], - "responses": { - "204": { - "description": "No Content. The Subscription was removed successfully" - }, - "400": { - "description": "Bad Request", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/entityOperations/create": { - "post": { - "description": "Batch Entity creation", - "operationId": "batchEntityCreation", - "tags": [ - "Batch Operations" - ], - "requestBody": { - "required": true, - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/EntityList" - } - } - } - }, - "responses": { - "200": { - "description": "Success", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/BatchOperationResult" - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/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": "#/components/schemas/EntityList" - } - } - } - }, - "responses": { - "200": { - "description": "Success", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/BatchOperationResult" - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/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": "#/components/schemas/EntityList" - } - } - } - }, - "responses": { - "200": { - "description": "Success", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/BatchOperationResult" - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/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": "#/components/schemas/BatchOperationResult" - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/temporal/entities/": { - "get": { - "description": "Query temporal evolution of Entities from an NGSI-LD system", - "operationId": "queryTemporalEntities", - "tags": [ - "Temporal Evolution" - ], - "parameters": [ - { - "$ref": "#/components/parameters/id" - }, - { - "$ref": "#/components/parameters/idPattern" - }, - { - "$ref": "#/components/parameters/type" - }, - { - "$ref": "#/components/parameters/attrs" - }, - { - "$ref": "#/components/parameters/q" - }, - { - "$ref": "#/components/parameters/georel" - }, - { - "$ref": "#/components/parameters/geometry" - }, - { - "$ref": "#/components/parameters/coordinates" - }, - { - "$ref": "#/components/parameters/geoproperty" - }, - { - "$ref": "#/components/parameters/timerel" - }, - { - "$ref": "#/components/parameters/timeproperty" - }, - { - "$ref": "#/components/parameters/time" - }, - { - "$ref": "#/components/parameters/endTime" - }, - { - "$ref": "#/components/parameters/csf" - }, - { - "$ref": "#/components/parameters/limit" - }, - { - "$ref": "#/components/parameters/components-parameters-options" - }, - { - "$ref": "#/components/parameters/lastN" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/EntityTemporalList" - }, - "examples": { - "simple": { - "externalValue": "http://localhost:8090/examples/EntityTemporalList-example.json" - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - }, - "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": "#/components/schemas/EntityTemporal" - }, - "examples": { - "simple": { - "externalValue": "http://localhost:8090/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": "#/components/schemas/ProblemDetails" - } - } - } - }, - "409": { - "description": "Already exists", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "422": { - "description": "Unprocessable Entity", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/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": [ - { - "$ref": "#/components/parameters/entityId" - }, - { - "$ref": "#/components/parameters/attrs" - }, - { - "$ref": "#/components/parameters/parameters-type" - }, - { - "$ref": "#/components/parameters/components-parameters-options" - }, - { - "$ref": "#/components/parameters/timerel" - }, - { - "$ref": "#/components/parameters/timeproperty" - }, - { - "$ref": "#/components/parameters/time" - }, - { - "$ref": "#/components/parameters/endTime" - }, - { - "$ref": "#/components/parameters/lastN" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/EntityTemporal" - }, - "examples": { - "simple": { - "externalValue": "http://localhost:8090/examples/EntityTemporal-example_C5.5.3.json" - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - }, - "delete": { - "description": "Removes the temporal representation of an Entity from an NGSI-LD system", - "operationId": "removeEntityTemporalById", - "tags": [ - "Temporal Evolution" - ], - "parameters": [ - { - "$ref": "#/components/parameters/entityId" - }, - { - "$ref": "#/components/parameters/parameters-type" - } - ], - "responses": { - "204": { - "description": "No Content. The entity was removed successfully" - }, - "400": { - "description": "Bad Request", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/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": [ - { - "$ref": "#/components/parameters/entityId" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/EntityTemporalFragment" - } - } - } - }, - "responses": { - "204": { - "description": "No Content" - }, - "400": { - "description": "Bad request", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/temporal/entities/{entityId}/attrs/{attrId}": { - "delete": { - "description": "Attribute from Temporal Representation of Entity deletion", - "operationId": "removeEntityTemporalAttr", - "tags": [ - "Temporal Evolution" - ], - "parameters": [ - { - "$ref": "#/components/parameters/entityId" - }, - { - "$ref": "#/components/parameters/attrId" - } - ], - "responses": { - "204": { - "description": "No Content." - }, - "400": { - "description": "Bad Request", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/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": "#/components/parameters/entityId" - }, - { - "$ref": "#/components/parameters/attrId" - }, - { - "$ref": "#/components/parameters/instanceId" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/EntityTemporalFragment" - } - } - } - }, - "responses": { - "204": { - "description": "No Content" - }, - "400": { - "description": "Bad request", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - }, - "delete": { - "description": "Attribute Instance deletion by instance id.", - "operationId": "removeEntityTemporalAttrInstance", - "tags": [ - "Temporal Evolution" - ], - "parameters": [ - { - "$ref": "#/components/parameters/entityId" - }, - { - "$ref": "#/components/parameters/attrId" - }, - { - "$ref": "#/components/parameters/instanceId" - } - ], - "responses": { - "204": { - "description": "No Content." - }, - "400": { - "description": "Bad Request", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json;application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - } - }, - "components": { - "parameters": { - "id": { - "name": "id", - "description": "Comma separated list of URIs to be retrieved", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "uri" - } - }, - "idPattern": { - "name": "idPattern", - "description": "Regular expression that must be matched by Entity ids", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "regexp" - } - }, - "type": { - "name": "type", - "description": "Comma separated list of Entity type names to be retrieved", - "in": "query", - "required": false, - "schema": { - "type": "string", - "minLength": 1 - } - }, - "attrs": { - "name": "attrs", - "description": "Comma separated list of attribute names (properties or relationships) to be retrieved", - "in": "query", - "required": false, - "schema": { - "type": "string", - "minLength": 1 - } - }, - "q": { - "name": "q", - "description": "Query", - "in": "query", - "required": false, - "schema": { - "type": "string", - "minLength": 1 - } - }, - "georel": { - "name": "georel", - "description": "Geo-relationship", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/georel" - } - }, - "geometry": { - "name": "geometry", - "description": "Geometry", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/geometry" - } - }, - "coordinates": { - "name": "coordinates", - "description": "Coordinates serialized as a string", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/coordinates" - } - }, - "geoproperty": { - "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 - } - }, - "csf": { - "name": "csf", - "description": "Context Source Filter", - "in": "query", - "required": false, - "schema": { - "type": "string", - "minLength": 1 - } - }, - "limit": { - "name": "limit", - "description": "Pagination limit", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1 - } - }, - "options": { - "name": "options", - "description": "Options dictionary", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "keyValues", - "sysAttrs" - ] - } - }, - "entityId": { - "name": "entityId", - "description": "Entity Id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uri" - } - }, - "parameters-type": { - "name": "type", - "description": "Entity Type", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/Name" - } - }, - "parameters-options": { - "name": "options", - "description": "Indicates that no attribute overwrite shall be performed", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "noOverwrite" - ] - } - }, - "attrId": { - "name": "attrId", - "description": "Attribute Id", - "in": "path", - "required": true, - "schema": { - "$ref": "#/components/schemas/Name" - } - }, - "subscriptionId": { - "name": "subscriptionId", - "description": "Subscription Id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uri" - } - }, - "registrationId": { - "name": "registrationId", - "description": "Registration Id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uri" - } - }, - "timerel": { - "name": "timerel", - "description": "Time relationship", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/timerel" - } - }, - "timeproperty": { - "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": "#/components/schemas/Name" - } - }, - "time": { - "name": "time", - "description": "start time for temporal query", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - "endTime": { - "name": "endTime", - "description": "end time for temporal query", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - "components-parameters-options": { - "name": "options", - "description": "Options dictionary", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "temporalValues", - "sysAttrs" - ] - } - }, - "lastN": { - "name": "lastN", - "description": "Only retrieve last N instances", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1 - } - }, - "instanceId": { - "name": "instanceId", - "description": "Instance Id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uri" - } - } - }, - "schemas": { - "georel": { - "oneOf": [ - { - "type": "string", - "enum": [ - "equals", - "disjoint", - "intersects", - "within", - "contains", - "overlaps" - ] - }, - { - "type": "string", - "pattern": "^near;((maxDistance==\\d+)|(minDistance==\\d+))$" - } - ] - }, - "geometry": { - "type": "string", - "enum": [ - "Point", - "MultiPoint", - "LineString", - "MultiLineString", - "Polygon", - "MultiPolygon" - ] - }, - "position": { - "description": "A single position", - "type": "array", - "minItems": 2, - "maxItems": 2, - "items": { - "type": "number" - }, - "additionalProperties": false - }, - "positionArray": { - "description": "An array of positions", - "type": "array", - "items": { - "$ref": "#/components/schemas/position" - } - }, - "lineString": { - "description": "An array of two or more positions", - "allOf": [ - { - "$ref": "#/components/schemas/positionArray" - }, - { - "minItems": 2 - } - ] - }, - "linearRing": { - "description": "An array of four positions where the first equals the last", - "allOf": [ - { - "$ref": "#/components/schemas/positionArray" - }, - { - "minItems": 4 - } - ] - }, - "polygon": { - "description": "An array of linear rings", - "type": "array", - "items": { - "$ref": "#/components/schemas/linearRing" - } - }, - "coordinates": { - "oneOf": [ - { - "$ref": "#/components/schemas/position" - }, - { - "$ref": "#/components/schemas/positionArray" - }, - { - "$ref": "#/components/schemas/lineString" - }, - { - "$ref": "#/components/schemas/polygon" - } - ] - }, - "LdContext": { - "oneOf": [ - { - "type": "object" - }, - { - "type": "string", - "format": "uri" - }, - { - "type": "array", - "minItems": 1, - "items": { - "oneOf": [ - { - "type": "string", - "format": "uri" - }, - { - "type": "object" - } - ] - } - } - ] - }, - "Point": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Point" - ] - }, - "coordinates": { - "$ref": "#/components/schemas/position" - } - } - }, - "MultiPoint": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "MultiPoint" - ] - }, - "coordinates": { - "$ref": "#/components/schemas/positionArray" - } - } - }, - "Polygon": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Polygon" - ] - }, - "coordinates": { - "$ref": "#/components/schemas/polygon" - } - } - }, - "LineString": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "LineString" - ] - }, - "coordinates": { - "$ref": "#/components/schemas/lineString" - } - } - }, - "MultiLineString": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "MultiLineString" - ] - }, - "coordinates": { - "type": "array", - "items": { - "$ref": "#/components/schemas/lineString" - } - } - } - }, - "MultiPolygon": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "MultiPolygon" - ] - }, - "coordinates": { - "type": "array", - "items": { - "$ref": "#/components/schemas/polygon" - } - } - } - }, - "Geometry": { - "description": " Avalid GeoJSON geometry object", - "oneOf": [ - { - "$ref": "#/components/schemas/Point" - }, - { - "$ref": "#/components/schemas/MultiPoint" - }, - { - "$ref": "#/components/schemas/Polygon" - }, - { - "$ref": "#/components/schemas/LineString" - }, - { - "$ref": "#/components/schemas/MultiLineString" - }, - { - "$ref": "#/components/schemas/MultiPolygon" - } - ] - }, - "observedAt": { - "type": "string", - "format": "date-time" - }, - "createdAt": { - "type": "string", - "format": "date-time" - }, - "modifiedAt": { - "type": "string", - "format": "date-time" - }, - "datasetId": { - "type": "string", - "format": "uri" - }, - "instanceId": { - "type": "string", - "format": "uri" - }, - "Property": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Property" - ] - }, - "value": { - "oneOf": [ - "string", - "number", - "boolean", - "array", - "object" - ] - }, - "observedAt": { - "$ref": "#/components/schemas/observedAt" - }, - "createdAt": { - "$ref": "#/components/schemas/createdAt" - }, - "modifiedAt": { - "$ref": "#/components/schemas/modifiedAt" - }, - "datasetId": { - "$ref": "#/components/schemas/datasetId" - }, - "instanceId": { - "$ref": "#/components/schemas/instanceId" - } - }, - "required": [ - "type", - "value" - ], - "additionalProperties": { - "oneOf": [ - { - "$ref": "#/components/schemas/Property" - }, - { - "$ref": "#/components/schemas/Relationship" - } - ] - } - }, - "Relationship": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Relationship" - ] - }, - "object": { - "type": "string", - "format": "uri" - }, - "observedAt": { - "$ref": "#/components/schemas/observedAt" - }, - "createdAt": { - "$ref": "#/components/schemas/createdAt" - }, - "modifiedAt": { - "$ref": "#/components/schemas/modifiedAt" - }, - "datasetId": { - "$ref": "#/components/schemas/datasetId" - }, - "instanceId": { - "$ref": "#/components/schemas/instanceId" - } - }, - "required": [ - "type", - "object" - ], - "additionalProperties": { - "oneOf": [ - { - "$ref": "#/components/schemas/Property" - }, - { - "$ref": "#/components/schemas/Relationship" - } - ] - } - }, - "GeoProperty": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "GeoProperty" - ] - }, - "value": { - "$ref": "#/components/schemas/Geometry" - }, - "observedAt": { - "$ref": "#/components/schemas/observedAt" - }, - "createdAt": { - "$ref": "#/components/schemas/createdAt" - }, - "modifiedAt": { - "$ref": "#/components/schemas/modifiedAt" - }, - "datasetId": { - "$ref": "#/components/schemas/datasetId" - }, - "instanceId": { - "$ref": "#/components/schemas/instanceId" - } - }, - "required": [ - "type", - "value" - ], - "additionalProperties": { - "oneOf": [ - { - "$ref": "#/components/schemas/Property" - }, - { - "$ref": "#/components/schemas/Relationship" - } - ] - } - }, - "Name": { - "type": "string", - "pattern": "^((\\d|[a-zA-Z]|_)+(:(\\d|[a-zA-Z]|_)+)?(#\\d+)?)$", - "minLength": 1, - "description": "NGSI-LD Name" - }, - "EntityFragment": { - "type": "object", - "properties": { - "@context": { - "$ref": "#/components/schemas/LdContext" - }, - "location": { - "$ref": "#/components/schemas/GeoProperty" - }, - "observationSpace": { - "$ref": "#/components/schemas/GeoProperty" - }, - "operationSpace": { - "$ref": "#/components/schemas/GeoProperty" - }, - "id": { - "type": "string", - "format": "uri" - }, - "type": { - "$ref": "#/components/schemas/Name" - }, - "createdAt": { - "$ref": "#/components/schemas/createdAt" - }, - "modifiedAt": { - "$ref": "#/components/schemas/modifiedAt" - } - }, - "additionalProperties": { - "oneOf": [ - { - "$ref": "#/components/schemas/Property" - }, - { - "$ref": "#/components/schemas/Relationship" - }, - { - "$ref": "#/components/schemas/GeoProperty" - } - ] - } - }, - "Entity": { - "allOf": [ - { - "required": [ - "id", - "type" - ] - }, - { - "$ref": "#/components/schemas/EntityFragment" - } - ] - }, - "EntityList": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Entity" - } - }, - "ProblemDetails": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "detail": { - "type": "string" - } - }, - "required": [ - "type" - ] - }, - "NotUpdatedDetails": { - "type": "object", - "properties": { - "attributeName": { - "type": "string", - "pattern": "" - }, - "reason": { - "type": "string", - "minLength": 1 - } - } - }, - "UpdateResult": { - "type": "object", - "properties": { - "updated": { - "type": "array", - "items": { - "type": "string", - "pattern": "" - } - }, - "notUpdated": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NotUpdatedDetails" - } - } - } - }, - "EntityInfo": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uri" - }, - "type": { - "$ref": "#/components/schemas/Name" - }, - "idPattern": { - "type": "string", - "format": "regex" - } - }, - "required": [ - "type" - ] - }, - "GeoQuery": { - "type": "object", - "required": [ - "geometry", - "coordinates", - "georel" - ], - "properties": { - "georel": { - "$ref": "#/components/schemas/georel" - }, - "coordinates": { - "$ref": "#/components/schemas/coordinates" - }, - "geometry": { - "$ref": "#/components/schemas/geometry" - } - } - }, - "SubscriptionFragment": { - "type": "object", - "properties": { - "@context": { - "$ref": "#/components/schemas/LdContext" - }, - "entities": { - "type": "array", - "items": { - "$ref": "#/components/schemas/EntityInfo" - }, - "minItems": 1 - }, - "name": { - "type": "string", - "minLength": 1 - }, - "description": { - "type": "string", - "minLength": 1 - }, - "watchedAttributes": { - "type": "array", - "minItems": 1, - "items": { - "$ref": "#/components/schemas/Name" - }, - "uniqueItems": true - }, - "timeInterval": { - "type": "number", - "minimum": 0 - }, - "expires": { - "type": "string", - "format": "date-time" - }, - "isActive": { - "type": "boolean" - }, - "throttling": { - "type": "number", - "minimum": 1 - }, - "q": { - "type": "string" - }, - "geoQ": { - "$ref": "#/components/schemas/GeoQuery" - }, - "csf": { - "type": "string" - } - } - }, - "Endpoint": { - "type": "object", - "required": [ - "uri" - ], - "properties": { - "uri": { - "type": "string", - "format": "uri" - }, - "accept": { - "type": "string", - "enum": [ - "application/json", - "application/ld+json" - ] - } - } - }, - "NotificationParams": { - "type": "object", - "properties": { - "attributes": { - "type": "array", - "minItems": 1, - "items": { - "type": "string", - "minLength": 1 - }, - "uniqueItems": true - }, - "format": { - "type": "string" - }, - "endpoint": { - "$ref": "#/components/schemas/Endpoint" - }, - "status": { - "type": "string", - "enum": [ - "ok", - "failed" - ] - }, - "timesSent": { - "type": "number", - "minimum": 1 - }, - "lastNotification": { - "type": "string", - "format": "date-time" - }, - "lastFailure": { - "type": "string", - "format": "date-time" - }, - "lastSuccess": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "endpoint" - ] - }, - "Subscription": { - "allOf": [ - { - "$ref": "#/components/schemas/SubscriptionFragment" - }, - { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Subscription" - ] - }, - "notification": { - "$ref": "#/components/schemas/NotificationParams" - }, - "status": { - "type": "string", - "enum": [ - "active", - "paused", - "expired" - ] - }, - "createdAt": { - "$ref": "#/components/schemas/createdAt" - }, - "modifiedAt": { - "$ref": "#/components/schemas/modifiedAt" - } - }, - "allOf": [ - { - "required": [ - "id", - "type", - "notification" - ] - }, - { - "anyOf": [ - { - "required": [ - "entities" - ] - }, - { - "required": [ - "watchedAttributes" - ] - } - ] - } - ] - } - ] - }, - "SubscriptionList": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Subscription" - } - }, - "RegistrationInfo": { - "type": "object", - "properties": { - "entities": { - "type": "array", - "minItems": 1, - "items": { - "$ref": "#/components/schemas/EntityInfo" - } - }, - "properties": { - "type": "array", - "minItems": 1, - "items": { - "$ref": "#/components/schemas/Name" - }, - "uniqueItems": true - }, - "relationships": { - "type": "array", - "minItems": 1, - "items": { - "$ref": "#/components/schemas/Name" - }, - "uniqueItems": true - } - } - }, - "TimeInterval": { - "type": "object", - "required": [ - "start" - ], - "properties": { - "start": { - "type": "string", - "format": "date-time" - }, - "end": { - "type": "string", - "format": "date-time" - } - } - }, - "ContextSourceRegistrationFragment": { - "type": "object", - "properties": { - "@context": { - "$ref": "#/components/schemas/LdContext" - }, - "information": { - "type": "array", - "minItems": 1, - "items": { - "$ref": "#/components/schemas/RegistrationInfo" - } - }, - "observationInterval": { - "$ref": "#/components/schemas/TimeInterval" - }, - "managementInterval": { - "$ref": "#/components/schemas/TimeInterval" - }, - "location": { - "$ref": "#/components/schemas/Geometry" - }, - "observationSpace": { - "$ref": "#/components/schemas/Geometry" - }, - "operationSpace": { - "$ref": "#/components/schemas/Geometry" - }, - "expires": { - "type": "string", - "format": "date-time" - }, - "name": { - "type": "string", - "minLength": 1 - }, - "description": { - "type": "string", - "minLength": 1 - }, - "endpoint": { - "type": "string", - "format": "uri" - } - }, - "additionalProperties": true - }, - "ContextSourceRegistration": { - "allOf": [ - { - "$ref": "#/components/schemas/ContextSourceRegistrationFragment" - }, - { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "ContextSourceRegistration" - ] - }, - "createdAt": { - "$ref": "#/components/schemas/createdAt" - }, - "modifiedAt": { - "$ref": "#/components/schemas/modifiedAt" - } - }, - "required": [ - "id", - "type", - "endpoint", - "information" - ] - } - ] - }, - "ContextSourceRegistrationList": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ContextSourceRegistration" - } - }, - "BatchEntityError": { - "type": "object", - "properties": { - "entityId": { - "type": "string", - "format": "uri" - }, - "error": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - }, - "BatchOperationResult": { - "type": "object", - "properties": { - "success": { - "type": "array", - "items": { - "type": "string", - "format": "uri" - } - }, - "error": { - "type": "array", - "items": { - "$ref": "#/components/schemas/BatchEntityError" - } - } - } - }, - "timerel": { - "type": "string", - "enum": [ - "before", - "after", - "between" - ] - }, - "EntityTemporalFragment": { - "type": "object", - "properties": { - "@context": { - "$ref": "#/components/schemas/LdContext" - }, - "location": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GeoProperty" - }, - "minItems": 1 - }, - "observationSpace": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GeoProperty" - }, - "minItems": 1 - }, - "operationSpace": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GeoProperty" - }, - "minItems": 1 - }, - "id": { - "type": "string", - "format": "uri" - }, - "type": { - "$ref": "#/components/schemas/Name" - }, - "createdAt": { - "$ref": "#/components/schemas/createdAt" - }, - "modifiedAt": { - "$ref": "#/components/schemas/modifiedAt" - } - }, - "additionalProperties": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/Property" - }, - "minItems": 1 - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/Relationship" - }, - "minItems": 1 - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GeoProperty" - }, - "minItems": 1 - } - ] - } - }, - "EntityTemporal": { - "allOf": [ - { - "$ref": "#/components/schemas/EntityTemporalFragment" - }, - { - "type": "object", - "required": [ - "type", - "id" - ] - } - ] - }, - "EntityTemporalList": { - "type": "array", - "items": { - "$ref": "#/components/schemas/EntityTemporal" - } - } - } - } -} \ No newline at end of file diff --git a/spec/updated/generated/README.md b/spec/updated/generated/README.md new file mode 100644 index 0000000..fc6b767 --- /dev/null +++ b/spec/updated/generated/README.md @@ -0,0 +1 @@ +>:warning: **Don't edit files in this folder, they are automatically generated and will be overwritten.** \ No newline at end of file -- GitLab From 3c5e7f2cd40071d3adfc4f320698422a394423ef Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Thu, 4 Feb 2021 12:48:07 +0100 Subject: [PATCH 09/43] set back master --- schema/BatchOperationResult.json | 2 +- schema/Entity.json | 28 ++++++------- schema/EntityList.json | 2 +- schema/common.json | 8 ++-- .../ContextSourceNotification.json | 6 +-- .../ContextSourceRegistration.json | 20 ++++----- .../ContextSourceRegistrationList.json | 4 +- schema/subscriptions/Notification.json | 4 +- schema/subscriptions/Subscription.json | 18 ++++---- schema/subscriptions/SubscriptionList.json | 2 +- schema/temporal/EntityTemporal.json | 20 ++++----- schema/temporal/EntityTemporalList.json | 2 +- schema/temporal/Entity_temporalValues.json | 8 ++-- .../csource-registration-by-id-spec.json | 12 +++--- .../csource-registrations-spec.json | 32 +++++++------- .../csource-subscription-by-id-spec.json | 18 ++++---- .../csource-subscriptions-spec.json | 12 +++--- spec/updated/entities/entities-spec.json | 20 ++++----- spec/updated/entities/entity-attrs-spec.json | 28 ++++++------- spec/updated/entities/entity-by-id-spec.json | 16 +++---- .../entities/entity-operations-spec.json | 22 +++++----- spec/updated/generated/full_api.json | 22 +++++----- spec/updated/ngsi-ld-spec-open-api.json | 38 ++++++++--------- .../subscription-by-id-spec.json | 18 ++++---- .../subscriptions/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 +++++++-------- 28 files changed, 236 insertions(+), 236 deletions(-) diff --git a/schema/BatchOperationResult.json b/schema/BatchOperationResult.json index 310d0ae..04fba47 100644 --- a/schema/BatchOperationResult.json +++ b/schema/BatchOperationResult.json @@ -10,7 +10,7 @@ "format": "uri" }, "error": { - "$ref": "http://localhost:8090/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/schema/Entity.json b/schema/Entity.json index c75ac9c..2478215 100644 --- a/schema/Entity.json +++ b/schema/Entity.json @@ -27,13 +27,13 @@ ] }, "observedAt": { - "$ref": "http://localhost:8090/schema/common.json#/definitions/observedAt" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/observedAt" }, "createdAt": { - "$ref": "http://localhost:8090/schema/common.json#/definitions/createdAt" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/createdAt" }, "modifiedAt": { - "$ref": "http://localhost:8090/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" @@ -69,13 +69,13 @@ "format": "uri" }, "observedAt": { - "$ref": "http://localhost:8090/schema/common.json#/definitions/observedAt" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/observedAt" }, "createdAt": { - "$ref": "http://localhost:8090/schema/common.json#/definitions/createdAt" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/createdAt" }, "modifiedAt": { - "$ref": "http://localhost:8090/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" @@ -107,16 +107,16 @@ "enum": ["GeoProperty"] }, "value": { - "$ref": "http://localhost:8090/schema/Geometry.json#/definitions/Geometry" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Geometry.json#/definitions/Geometry" }, "observedAt": { - "$ref": "http://localhost:8090/schema/common.json#/definitions/observedAt" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/observedAt" }, "createdAt": { - "$ref": "http://localhost:8090/schema/common.json#/definitions/createdAt" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/createdAt" }, "modifiedAt": { - "$ref": "http://localhost:8090/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" @@ -144,7 +144,7 @@ "type": "object", "properties": { "@context": { - "$ref": "http://localhost:8090/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" @@ -160,13 +160,13 @@ "format": "uri" }, "type": { - "$ref": "http://localhost:8090/schema/common.json#/definitions/Name" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" }, "createdAt": { - "$ref": "http://localhost:8090/schema/common.json#/definitions/createdAt" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/createdAt" }, "modifiedAt": { - "$ref": "http://localhost:8090/schema/common.json#/definitions/modifiedAt" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/modifiedAt" } }, "additionalProperties": { diff --git a/schema/EntityList.json b/schema/EntityList.json index 1422746..a3fca84 100644 --- a/schema/EntityList.json +++ b/schema/EntityList.json @@ -5,7 +5,7 @@ "EntityList": { "type": "array", "items": { - "$ref": "http://localhost:8090/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/common.json b/schema/common.json index bc09254..a3214d7 100644 --- a/schema/common.json +++ b/schema/common.json @@ -128,16 +128,16 @@ "coordinates": { "oneOf": [ { - "$ref": "http://localhost:8090/schema/Geometry.json#/definitions/position" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Geometry.json#/definitions/position" }, { - "$ref": "http://localhost:8090/schema/Geometry.json#/definitions/positionArray" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Geometry.json#/definitions/positionArray" }, { - "$ref": "http://localhost:8090/schema/Geometry.json#/definitions/lineString" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Geometry.json#/definitions/lineString" }, { - "$ref": "http://localhost:8090/schema/Geometry.json#/definitions/polygon" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Geometry.json#/definitions/polygon" } ] }, diff --git a/schema/registrations/ContextSourceNotification.json b/schema/registrations/ContextSourceNotification.json index 32960fc..b61e6e5 100644 --- a/schema/registrations/ContextSourceNotification.json +++ b/schema/registrations/ContextSourceNotification.json @@ -1,6 +1,6 @@ { "$schema": "http://json-schema.org/schema#", - "$id": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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 9f19e67..aaae651 100644 --- a/schema/registrations/ContextSourceRegistration.json +++ b/schema/registrations/ContextSourceRegistration.json @@ -1,6 +1,6 @@ { "$schema": "http://json-schema.org/schema#", - "$id": "http://localhost:8090/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": { @@ -11,14 +11,14 @@ "type": "array", "minItems": 1, "items": { - "$ref": "http://localhost:8090/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": "http://localhost:8090/schema/common.json#/definitions/Name" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" }, "uniqueItems": true }, @@ -26,7 +26,7 @@ "type": "array", "minItems": 1, "items": { - "$ref": "http://localhost:8090/schema/common.json#/definitions/Name" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" }, "uniqueItems": true } @@ -52,7 +52,7 @@ "type": "object", "properties": { "@context": { - "$ref": "http://localhost:8090/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", @@ -68,13 +68,13 @@ "$ref": "#/definitions/TimeInterval" }, "location": { - "$ref": "http://localhost:8090/schema/Geometry.json#/definitions/Geometry" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Geometry.json#/definitions/Geometry" }, "observationSpace": { - "$ref": "http://localhost:8090/schema/Geometry.json#/definitions/Geometry" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Geometry.json#/definitions/Geometry" }, "operationSpace": { - "$ref": "http://localhost:8090/schema/Geometry.json#/definitions/Geometry" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Geometry.json#/definitions/Geometry" }, "expires": { "type": "string", @@ -112,10 +112,10 @@ "enum": ["ContextSourceRegistration"] }, "createdAt": { - "$ref": "http://localhost:8090/schema/common.json#/definitions/createdAt" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/createdAt" }, "modifiedAt": { - "$ref": "http://localhost:8090/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 4d4a21a..0518d7a 100644 --- a/schema/registrations/ContextSourceRegistrationList.json +++ b/schema/registrations/ContextSourceRegistrationList.json @@ -1,13 +1,13 @@ { "$schema": "http://json-schema.org/schema#", - "$id": "http://localhost:8090/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": "http://localhost:8090/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 e238120..a0ad339 100644 --- a/schema/subscriptions/Notification.json +++ b/schema/subscriptions/Notification.json @@ -18,7 +18,7 @@ "format": "uri" }, "@context": { - "$ref": "http://localhost:8090/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": "http://localhost:8090/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 f549253..49ac3a8 100644 --- a/schema/subscriptions/Subscription.json +++ b/schema/subscriptions/Subscription.json @@ -18,7 +18,7 @@ "type": "string" }, "endpoint": { - "$ref": "http://localhost:8090/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", @@ -57,13 +57,13 @@ ], "properties": { "georel": { - "$ref": "http://localhost:8090/schema/common.json#/definitions/georel" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/georel" }, "coordinates": { - "$ref": "http://localhost:8090/schema/common.json#/definitions/coordinates" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/coordinates" }, "geometry": { - "$ref": "http://localhost:8090/schema/common.json#/definitions/geometry" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/geometry" } } }, @@ -71,12 +71,12 @@ "type": "object", "properties": { "@context": { - "$ref": "http://localhost:8090/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": "http://localhost:8090/schema/common.json#/definitions/EntityInfo" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/EntityInfo" }, "minItems": 1 }, @@ -92,7 +92,7 @@ "type": "array", "minItems": 1, "items": { - "$ref": "http://localhost:8090/schema/common.json#/definitions/Name" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" }, "uniqueItems": true }, @@ -150,10 +150,10 @@ ] }, "createdAt": { - "$ref": "http://localhost:8090/schema/common.json#/definitions/createdAt" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/createdAt" }, "modifiedAt": { - "$ref": "http://localhost:8090/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 650ba86..21a4143 100644 --- a/schema/subscriptions/SubscriptionList.json +++ b/schema/subscriptions/SubscriptionList.json @@ -5,7 +5,7 @@ "SubscriptionList": { "type": "array", "items": { - "$ref": "http://localhost:8090/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 2204071..3d951d0 100644 --- a/schema/temporal/EntityTemporal.json +++ b/schema/temporal/EntityTemporal.json @@ -6,26 +6,26 @@ "type": "object", "properties": { "@context": { - "$ref": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/schema/Entity.json#/definitions/GeoProperty" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/GeoProperty" }, "minItems": 1 }, @@ -34,13 +34,13 @@ "format": "uri" }, "type": { - "$ref": "http://localhost:8090/schema/common.json#/definitions/Name" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" }, "createdAt": { - "$ref": "http://localhost:8090/schema/common.json#/definitions/createdAt" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/createdAt" }, "modifiedAt": { - "$ref": "http://localhost:8090/schema/common.json#/definitions/modifiedAt" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/modifiedAt" } }, "additionalProperties": { @@ -48,21 +48,21 @@ { "type": "array", "items": { - "$ref": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/schema/Entity.json#/definitions/GeoProperty" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/GeoProperty" }, "minItems": 1 } diff --git a/schema/temporal/EntityTemporalList.json b/schema/temporal/EntityTemporalList.json index 42655d3..4ed93d7 100644 --- a/schema/temporal/EntityTemporalList.json +++ b/schema/temporal/EntityTemporalList.json @@ -5,7 +5,7 @@ "EntityTemporalList": { "type": "array", "items": { - "$ref": "http://localhost:8090/schema/temporal/EntityTemporal.json#/definitions/EntityTemporal" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/temporal/EntityTemporal.json#/definitions/EntityTemporal" } } }, diff --git a/schema/temporal/Entity_temporalValues.json b/schema/temporal/Entity_temporalValues.json index 2ebddcb..6a2a98f 100644 --- a/schema/temporal/Entity_temporalValues.json +++ b/schema/temporal/Entity_temporalValues.json @@ -86,16 +86,16 @@ "format": "uri" }, "type": { - "$ref": "http://localhost:8090/schema/common.json#/definitions/Name" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" }, "@context": { - "$ref": "http://localhost:8090/schema/common.json#/definitions/LdContext" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/LdContext" }, "createdAt": { - "$ref": "http://localhost:8090/schema/common.json#/definitions/createdAt" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/createdAt" }, "modifiedAt": { - "$ref": "http://localhost:8090/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/spec/updated/csourceRegistrations/csource-registration-by-id-spec.json b/spec/updated/csourceRegistrations/csource-registration-by-id-spec.json index d2a39e8..47f386e 100644 --- a/spec/updated/csourceRegistrations/csource-registration-by-id-spec.json +++ b/spec/updated/csourceRegistrations/csource-registration-by-id-spec.json @@ -35,11 +35,11 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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/csourceRegistrations/csource-registrations-spec.json b/spec/updated/csourceRegistrations/csource-registrations-spec.json index 2360b8d..b4221a3 100644 --- a/spec/updated/csourceRegistrations/csource-registrations-spec.json +++ b/spec/updated/csourceRegistrations/csource-registrations-spec.json @@ -16,34 +16,34 @@ "tags": ["Context Sources", "CSourceRegistrations"], "parameters": [ { - "$ref": "http://localhost:8090/spec/updated/entities/entities-spec.json#/components/parameters/id" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities/entities-spec.json#/components/parameters/id" }, { - "$ref": "http://localhost:8090/spec/updated/entities/entities-spec.json#/components/parameters/idPattern" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities/entities-spec.json#/components/parameters/idPattern" }, { - "$ref": "http://localhost:8090/spec/updated/entities/entities-spec.json#/components/parameters/type" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities/entities-spec.json#/components/parameters/type" }, { - "$ref": "http://localhost:8090/spec/updated/entities/entities-spec.json#/components/parameters/attrs" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities/entities-spec.json#/components/parameters/attrs" }, { - "$ref": "http://localhost:8090/spec/updated/entities/entities-spec.json#/components/parameters/q" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities/entities-spec.json#/components/parameters/q" }, { - "$ref": "http://localhost:8090/spec/updated/entities/entities-spec.json#/components/parameters/georel" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities/entities-spec.json#/components/parameters/georel" }, { - "$ref": "http://localhost:8090/spec/updated/entities/entities-spec.json#/components/parameters/geometry" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities/entities-spec.json#/components/parameters/geometry" }, { - "$ref": "http://localhost:8090/spec/updated/entities/entities-spec.json#/components/parameters/coordinates" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities/entities-spec.json#/components/parameters/coordinates" }, { - "$ref": "http://localhost:8090/spec/updated/entities/entities-spec.json#/components/parameters/geoproperty" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities/entities-spec.json#/components/parameters/geoproperty" }, { - "$ref": "http://localhost:8090/spec/updated/entities/entities-spec.json#/components/parameters/limit" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities/entities-spec.json#/components/parameters/limit" } ], "responses": { @@ -52,11 +52,11 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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/csourceSubscriptions/csource-subscription-by-id-spec.json b/spec/updated/csourceSubscriptions/csource-subscription-by-id-spec.json index 5e39263..eaff1bf 100644 --- a/spec/updated/csourceSubscriptions/csource-subscription-by-id-spec.json +++ b/spec/updated/csourceSubscriptions/csource-subscription-by-id-spec.json @@ -35,11 +35,11 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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/csourceSubscriptions/csource-subscriptions-spec.json b/spec/updated/csourceSubscriptions/csource-subscriptions-spec.json index 68442ab..350aefe 100644 --- a/spec/updated/csourceSubscriptions/csource-subscriptions-spec.json +++ b/spec/updated/csourceSubscriptions/csource-subscriptions-spec.json @@ -35,11 +35,11 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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/entities-spec.json b/spec/updated/entities/entities-spec.json index e730ff1..6fe923b 100644 --- a/spec/updated/entities/entities-spec.json +++ b/spec/updated/entities/entities-spec.json @@ -62,7 +62,7 @@ "in": "query", "required": false, "schema": { - "$ref": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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/entity-attrs-spec.json b/spec/updated/entities/entity-attrs-spec.json index 8c947b7..8cc6028 100644 --- a/spec/updated/entities/entity-attrs-spec.json +++ b/spec/updated/entities/entity-attrs-spec.json @@ -22,7 +22,7 @@ "in": "path", "required": true, "schema": { - "$ref": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/schema/UpdateResult.json#/definitions/UpdateResult" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/UpdateResult.json#/definitions/UpdateResult" } } } @@ -82,7 +82,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/schema/UpdateResult.json#/definitions/UpdateResult" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/UpdateResult.json#/definitions/UpdateResult" } } } @@ -137,7 +137,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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/entity-by-id-spec.json b/spec/updated/entities/entity-by-id-spec.json index b59af1b..2890992 100644 --- a/spec/updated/entities/entity-by-id-spec.json +++ b/spec/updated/entities/entity-by-id-spec.json @@ -22,7 +22,7 @@ "in": "query", "required": false, "schema": { - "$ref": "http://localhost:8090/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": "http://localhost:8090/spec/updated/entities/entities-spec.json#/components/parameters/options" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities/entities-spec.json#/components/parameters/options" } ], "responses": { @@ -63,11 +63,11 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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/entity-operations-spec.json b/spec/updated/entities/entity-operations-spec.json index 754f279..2dc6ab2 100644 --- a/spec/updated/entities/entity-operations-spec.json +++ b/spec/updated/entities/entity-operations-spec.json @@ -16,7 +16,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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/generated/full_api.json b/spec/updated/generated/full_api.json index 9417218..baa9baa 100644 --- a/spec/updated/generated/full_api.json +++ b/spec/updated/generated/full_api.json @@ -103,7 +103,7 @@ }, "examples": { "simple": { - "externalValue": "http://localhost:8090/examples/EntityList-example.json" + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/EntityList-example.json" } } } @@ -207,7 +207,7 @@ }, "examples": { "simple": { - "externalValue": "http://localhost:8090/examples/Entity-example.json" + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/Entity-example.json" } } } @@ -515,7 +515,7 @@ }, "examples": { "simple": { - "externalValue": "http://localhost:8090/examples/SubscriptionList-example.json" + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/SubscriptionList-example.json" } } } @@ -600,7 +600,7 @@ }, "examples": { "simple": { - "externalValue": "http://localhost:8090/examples/Subscription-example_C.4.json" + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/Subscription-example_C.4.json" } } } @@ -765,7 +765,7 @@ }, "examples": { "simple": { - "externalValue": "http://localhost:8090/examples/ContextSourceRegistrationList-example.json" + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/ContextSourceRegistrationList-example.json" } } } @@ -850,7 +850,7 @@ }, "examples": { "simple": { - "externalValue": "http://localhost:8090/examples/" + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/" } } } @@ -940,7 +940,7 @@ }, "examples": { "simple": { - "externalValue": "http://localhost:8090/examples/SubscriptionList-example.json" + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/SubscriptionList-example.json" } } } @@ -1025,7 +1025,7 @@ }, "examples": { "simple": { - "externalValue": "http://localhost:8090/examples/Subscription-example_C.4.json" + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/Subscription-example_C.4.json" } } } @@ -1411,7 +1411,7 @@ }, "examples": { "simple": { - "externalValue": "http://localhost:8090/examples/EntityTemporalList-example.json" + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/EntityTemporalList-example.json" } } } @@ -1445,7 +1445,7 @@ }, "examples": { "simple": { - "externalValue": "http://localhost:8090/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" } } } @@ -1538,7 +1538,7 @@ }, "examples": { "simple": { - "externalValue": "http://localhost:8090/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 7164244..23c91b4 100644 --- a/spec/updated/ngsi-ld-spec-open-api.json +++ b/spec/updated/ngsi-ld-spec-open-api.json @@ -48,61 +48,61 @@ ], "paths": { "/entities/": { - "$ref": "http://localhost:8090/spec/updated/entities/entities-spec.json#/paths/%2Fentities%2F" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities/entities-spec.json#/paths/%2Fentities%2F" }, "/entities/{entityId}": { - "$ref": "http://localhost:8090/spec/updated/entities/entity-by-id-spec.json#/paths/%2Fentities%2F%7BentityId%7D" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities/entity-by-id-spec.json#/paths/%2Fentities%2F%7BentityId%7D" }, "/entities/{entityId}/attrs/": { - "$ref": "http://localhost:8090/spec/updated/entities/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/entities/entity-attrs-spec.json#/paths/%2Fentities%2F%7BentityId%7D%2Fattrs%2F" }, "/entities/{entityId}/attrs/{attrId}": { - "$ref": "http://localhost:8090/spec/updated/entities/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/entities/entity-attrs-spec.json#/paths/%2Fentities%2F%7BentityId%7D%2Fattrs%2F%7BattrId%7D" }, "/subscriptions/": { - "$ref": "http://localhost:8090/spec/updated/subscriptions/subscriptions-spec.json#/paths/%2Fsubscriptions%2F" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/subscriptions/subscriptions-spec.json#/paths/%2Fsubscriptions%2F" }, "/subscriptions/{subscriptionId}": { - "$ref": "http://localhost:8090/spec/updated/subscriptions/subscription-by-id-spec.json#/paths/%2Fsubscriptions%2F%7BsubscriptionId%7D" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/subscriptions/subscription-by-id-spec.json#/paths/%2Fsubscriptions%2F%7BsubscriptionId%7D" }, "/csourceRegistrations/": { - "$ref": "http://localhost:8090/spec/updated/csourceRegistrations/csource-registrations-spec.json#/paths/%2FcsourceRegistrations%2F" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/csourceRegistrations/csource-registrations-spec.json#/paths/%2FcsourceRegistrations%2F" }, "/csourceRegistrations/{registrationId}": { - "$ref": "http://localhost:8090/spec/updated/csourceRegistrations/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/csourceRegistrations/csource-registration-by-id-spec.json#/paths/%2FcsourceRegistrations%2F%7BregistrationId%7D" }, "/csourceSubscriptions/": { - "$ref": "http://localhost:8090/spec/updated/csourceSubscriptions/csource-subscriptions-spec.json#/paths/%2FcsourceSubscriptions%2F" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/csourceSubscriptions/csource-subscriptions-spec.json#/paths/%2FcsourceSubscriptions%2F" }, "/csourceSubscriptions/{subscriptionId}": { - "$ref": "http://localhost:8090/spec/updated/csourceSubscriptions/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/csourceSubscriptions/csource-subscription-by-id-spec.json#/paths/%2FcsourceSubscriptions%2F%7BsubscriptionId%7D" }, "/entityOperations/create": { - "$ref": "http://localhost:8090/spec/updated/entities/entity-operations-spec.json#/paths/%2FentityOperations%2Fcreate" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities/entity-operations-spec.json#/paths/%2FentityOperations%2Fcreate" }, "/entityOperations/update": { - "$ref": "http://localhost:8090/spec/updated/entities/entity-operations-spec.json#/paths/%2FentityOperations%2Fupdate" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities/entity-operations-spec.json#/paths/%2FentityOperations%2Fupdate" }, "/entityOperations/upsert": { - "$ref": "http://localhost:8090/spec/updated/entities/entity-operations-spec.json#/paths/%2FentityOperations%2Fupsert" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities/entity-operations-spec.json#/paths/%2FentityOperations%2Fupsert" }, "/entityOperations/delete": { - "$ref": "http://localhost:8090/spec/updated/entities/entity-operations-spec.json#/paths/%2FentityOperations%2Fdelete" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities/entity-operations-spec.json#/paths/%2FentityOperations%2Fdelete" }, "/temporal/entities/": { - "$ref": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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/subscriptions/subscription-by-id-spec.json b/spec/updated/subscriptions/subscription-by-id-spec.json index e53310e..614f951 100644 --- a/spec/updated/subscriptions/subscription-by-id-spec.json +++ b/spec/updated/subscriptions/subscription-by-id-spec.json @@ -35,11 +35,11 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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/subscriptions-spec.json b/spec/updated/subscriptions/subscriptions-spec.json index 635cf38..b4f935b 100644 --- a/spec/updated/subscriptions/subscriptions-spec.json +++ b/spec/updated/subscriptions/subscriptions-spec.json @@ -38,11 +38,11 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "http://localhost:8090/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": "http://localhost:8090/examples/SubscriptionList-example.json" + "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/SubscriptionList-example.json" } } } @@ -53,7 +53,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "http://localhost:8090/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": "http://localhost:8090/schema/subscriptions/Subscription.json#/definitions/Subscription" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/subscriptions/Subscription.json#/definitions/Subscription" } } } @@ -86,7 +86,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } @@ -96,7 +96,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "http://localhost:8090/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 557516e..dbf5257 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": "http://localhost:8090/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": "http://localhost:8090/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", "Temporal"], "parameters": [ { - "$ref": "http://localhost:8090/spec/updated/entities/entities-spec.json#/components/parameters/id" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities/entities-spec.json#/components/parameters/id" }, { - "$ref": "http://localhost:8090/spec/updated/entities/entities-spec.json#/components/parameters/idPattern" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities/entities-spec.json#/components/parameters/idPattern" }, { - "$ref": "http://localhost:8090/spec/updated/entities/entities-spec.json#/components/parameters/type" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities/entities-spec.json#/components/parameters/type" }, { - "$ref": "http://localhost:8090/spec/updated/entities/entities-spec.json#/components/parameters/attrs" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities/entities-spec.json#/components/parameters/attrs" }, { - "$ref": "http://localhost:8090/spec/updated/entities/entities-spec.json#/components/parameters/q" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities/entities-spec.json#/components/parameters/q" }, { - "$ref": "http://localhost:8090/spec/updated/entities/entities-spec.json#/components/parameters/georel" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities/entities-spec.json#/components/parameters/georel" }, { - "$ref": "http://localhost:8090/spec/updated/entities/entities-spec.json#/components/parameters/geometry" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities/entities-spec.json#/components/parameters/geometry" }, { - "$ref": "http://localhost:8090/spec/updated/entities/entities-spec.json#/components/parameters/coordinates" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities/entities-spec.json#/components/parameters/coordinates" }, { - "$ref": "http://localhost:8090/spec/updated/entities/entities-spec.json#/components/parameters/geoproperty" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities/entities-spec.json#/components/parameters/geoproperty" }, { "$ref": "#/components/parameters/timerel" @@ -116,10 +116,10 @@ "$ref": "#/components/parameters/endTime" }, { - "$ref": "http://localhost:8090/spec/updated/entities/entities-spec.json#/components/parameters/csf" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities/entities-spec.json#/components/parameters/csf" }, { - "$ref": "http://localhost:8090/spec/updated/entities/entities-spec.json#/components/parameters/limit" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities/entities-spec.json#/components/parameters/limit" }, { "$ref": "#/components/parameters/options" @@ -134,11 +134,11 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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 0508822..e345169 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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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 7810757..80336f8 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", "Temporal"], "parameters": [ { - "$ref": "http://localhost:8090/spec/updated/entities/entity-by-id-spec.json#/components/parameters/entityId" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities/entity-by-id-spec.json#/components/parameters/entityId" }, { - "$ref": "http://localhost:8090/spec/updated/entities/entity-by-id-spec.json#/components/parameters/attrs" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities/entity-by-id-spec.json#/components/parameters/attrs" }, { - "$ref": "http://localhost:8090/spec/updated/entities/entity-by-id-spec.json#/components/parameters/type" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities/entity-by-id-spec.json#/components/parameters/type" }, { - "$ref": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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": "http://localhost:8090/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", "Temporal"], "parameters": [ { - "$ref": "http://localhost:8090/spec/updated/entities/entity-by-id-spec.json#/components/parameters/entityId" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities/entity-by-id-spec.json#/components/parameters/entityId" }, { - "$ref": "http://localhost:8090/spec/updated/entities/entity-by-id-spec.json#/components/parameters/type" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities/entity-by-id-spec.json#/components/parameters/type" } ], "responses": { @@ -100,7 +100,7 @@ "content": { "application/json;application/ld+json": { "schema": { - "$ref": "http://localhost:8090/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": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails" + "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } -- GitLab From ea6268ce9a7cde1e4c576240539208aaccc74f2d Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Fri, 19 Feb 2021 11:47:52 +0100 Subject: [PATCH 10/43] fix ci --- .gitlab-ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 5b3c473..01cf47c 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -14,7 +14,7 @@ test: script: - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master http://localhost:8090 - docker run --name spec-server --rm -d -v ${PWD}/:/ngsi -e FOLDER=/ngsi -p 8090:8080 halverneus/static-file-server - - docker run --network host -it -v ${PWD}/:/data broothie/redoc-cli bundle spec/updated/ngsi-ld-spec-open-api.json -o spec/updated/full_api.json + - docker run --network host -i -v ${PWD}/:/data broothie/redoc-cli bundle spec/updated/ngsi-ld-spec-open-api.json -o spec/updated/full_api.json - docker run --network host --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/full_api.json - scripts/setBasePath.sh http://localhost:8090 https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master allow_failure: true -- GitLab From ca81c036f24c6c443ed00f771e3a395cef8d7cd2 Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Mon, 22 Feb 2021 11:42:29 +0100 Subject: [PATCH 11/43] update ci --- .gitlab-ci.yml | 2 +- README.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 01cf47c..15bf04a 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -14,7 +14,7 @@ test: script: - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master http://localhost:8090 - docker run --name spec-server --rm -d -v ${PWD}/:/ngsi -e FOLDER=/ngsi -p 8090:8080 halverneus/static-file-server - - docker run --network host -i -v ${PWD}/:/data broothie/redoc-cli bundle spec/updated/ngsi-ld-spec-open-api.json -o spec/updated/full_api.json + - docker run --network host -i -v ${PWD}/:/data wistefan/redocly-openapi-cli bundle /data/spec/updated/ngsi-ld-spec-open-api.json -o /data/spec/updated/full_api.json - docker run --network host --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/full_api.json - scripts/setBasePath.sh http://localhost:8090 https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master allow_failure: true diff --git a/README.md b/README.md index ebfa038..68c243d 100644 --- a/README.md +++ b/README.md @@ -22,9 +22,9 @@ it replaces all paths to the master branch inside [spec](spec) and [schema](sche references are resolved with 'https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master' and therefore changes will not be present locally. With the local file-server still running, you can build the bundled api via: -TODO: change to openapi-cli image -> https://github.com/Redocly/openapi-cli/pull/247/files + ``` -docker run --network host -it -v ${PWD}/:/data broothie/redoc-cli bundle spec/updated/ngsi-ld-spec-open-api.json -o spec/updated/generated/full_api.json +docker run --network host -it -v ${PWD}/:/data wistefan/redocly-openapi-cli bundle /data/spec/updated/ngsi-ld-spec-open-api.json -o /data/spec/updated/generated/full_api.json ``` And validate it with: ``` -- GitLab From ec98b530bd67c1e902806d1e3f96de9c659c3cff Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Mon, 22 Feb 2021 11:43:45 +0100 Subject: [PATCH 12/43] update ci --- .gitlab-ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 15bf04a..770d507 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -13,7 +13,7 @@ test: stage: test script: - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master http://localhost:8090 - - docker run --name spec-server --rm -d -v ${PWD}/:/ngsi -e FOLDER=/ngsi -p 8090:8080 halverneus/static-file-server + - docker run --rm -d -v ${PWD}/:/ngsi -e FOLDER=/ngsi -p 8090:8080 halverneus/static-file-server - docker run --network host -i -v ${PWD}/:/data wistefan/redocly-openapi-cli bundle /data/spec/updated/ngsi-ld-spec-open-api.json -o /data/spec/updated/full_api.json - docker run --network host --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/full_api.json - scripts/setBasePath.sh http://localhost:8090 https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master -- GitLab From d64f13bb86bc200f1f5e6056e2dc49958b615c86 Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Mon, 22 Feb 2021 11:45:44 +0100 Subject: [PATCH 13/43] update ci --- .gitlab-ci.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 770d507..d711434 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -12,6 +12,9 @@ stages: test: stage: test script: + # clean all dangaling containers + - docker kill $(docker ps -q) + - docker rm $(docker ps -a -q) - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master http://localhost:8090 - docker run --rm -d -v ${PWD}/:/ngsi -e FOLDER=/ngsi -p 8090:8080 halverneus/static-file-server - docker run --network host -i -v ${PWD}/:/data wistefan/redocly-openapi-cli bundle /data/spec/updated/ngsi-ld-spec-open-api.json -o /data/spec/updated/full_api.json -- GitLab From 39304fadc3092644e20833a79c02c20a5436b95f Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Mon, 22 Feb 2021 11:46:26 +0100 Subject: [PATCH 14/43] update ci --- .gitlab-ci.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index d711434..95a6768 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -13,8 +13,8 @@ test: stage: test script: # clean all dangaling containers - - docker kill $(docker ps -q) - - docker rm $(docker ps -a -q) + - sudo docker kill $(docker ps -q) + - sudo docker rm $(docker ps -a -q) - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master http://localhost:8090 - docker run --rm -d -v ${PWD}/:/ngsi -e FOLDER=/ngsi -p 8090:8080 halverneus/static-file-server - docker run --network host -i -v ${PWD}/:/data wistefan/redocly-openapi-cli bundle /data/spec/updated/ngsi-ld-spec-open-api.json -o /data/spec/updated/full_api.json -- GitLab From 5e41cf2be368df7323cc7af24ea1b86723f4d69a Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Mon, 22 Feb 2021 11:47:28 +0100 Subject: [PATCH 15/43] update ci --- .gitlab-ci.yml | 3 --- 1 file changed, 3 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 95a6768..770d507 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -12,9 +12,6 @@ stages: test: stage: test script: - # clean all dangaling containers - - sudo docker kill $(docker ps -q) - - sudo docker rm $(docker ps -a -q) - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master http://localhost:8090 - docker run --rm -d -v ${PWD}/:/ngsi -e FOLDER=/ngsi -p 8090:8080 halverneus/static-file-server - docker run --network host -i -v ${PWD}/:/data wistefan/redocly-openapi-cli bundle /data/spec/updated/ngsi-ld-spec-open-api.json -o /data/spec/updated/full_api.json -- GitLab From 9a8764440d4ade5c68c9a381734befa6d4e19185 Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Mon, 22 Feb 2021 11:49:33 +0100 Subject: [PATCH 16/43] update ci --- .gitlab-ci.yml | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 770d507..b65d6fb 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -12,10 +12,12 @@ stages: test: stage: test script: - - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master http://localhost:8090 - - docker run --rm -d -v ${PWD}/:/ngsi -e FOLDER=/ngsi -p 8090:8080 halverneus/static-file-server + - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master http://localhost:9090 + - docker run --name file-server --rm -d -v ${PWD}/:/ngsi -e FOLDER=/ngsi -p 9090:8080 halverneus/static-file-server - docker run --network host -i -v ${PWD}/:/data wistefan/redocly-openapi-cli bundle /data/spec/updated/ngsi-ld-spec-open-api.json -o /data/spec/updated/full_api.json - docker run --network host --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/full_api.json - scripts/setBasePath.sh http://localhost:8090 https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master - allow_failure: true + after_script: + - docker stop file-server + allow_failure: false -- GitLab From 0997ae156f63b655acc54458d1f42ee7c1496c94 Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Mon, 22 Feb 2021 11:53:16 +0100 Subject: [PATCH 17/43] update ci --- .gitlab-ci.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index b65d6fb..3f141fd 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -13,11 +13,11 @@ test: stage: test script: - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master http://localhost:9090 - - docker run --name file-server --rm -d -v ${PWD}/:/ngsi -e FOLDER=/ngsi -p 9090:8080 halverneus/static-file-server + - docker run --name fileserver --rm -d -v ${PWD}/:/ngsi -e FOLDER=/ngsi -p 9090:8080 halverneus/static-file-server - docker run --network host -i -v ${PWD}/:/data wistefan/redocly-openapi-cli bundle /data/spec/updated/ngsi-ld-spec-open-api.json -o /data/spec/updated/full_api.json - docker run --network host --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/full_api.json - scripts/setBasePath.sh http://localhost:8090 https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master after_script: - - docker stop file-server + - docker stop fileserver allow_failure: false -- GitLab From 65aa4ac958d2f5355846912264c79bfd43ef6ee8 Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Tue, 2 Mar 2021 16:05:37 +0100 Subject: [PATCH 18/43] try with branch name --- .gitlab-ci.yml | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 3f141fd..0d2bf28 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -9,15 +9,20 @@ before_script: stages: - test -test: +test-pr: + only: [ merge_requests ] stage: test script: - - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master http://localhost:9090 - - docker run --name fileserver --rm -d -v ${PWD}/:/ngsi -e FOLDER=/ngsi -p 9090:8080 halverneus/static-file-server - - docker run --network host -i -v ${PWD}/:/data wistefan/redocly-openapi-cli bundle /data/spec/updated/ngsi-ld-spec-open-api.json -o /data/spec/updated/full_api.json - - docker run --network host --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/full_api.json - - scripts/setBasePath.sh http://localhost:8090 https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master - after_script: - - docker stop fileserver + - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/$CI_MERGE_REQUEST_SOURCE_BRANCH_NAME http://localhost:9090 + - docker run -i -v ${PWD}/:/data wistefan/redocly-openapi-cli bundle /data/spec/updated/ngsi-ld-spec-open-api.json -o /data/spec/updated/full_api.json + - docker run --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/full_api.json allow_failure: false +test-branch: + only: [ branches ] + stage: test + script: + - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/$CI_COMMIT_BRANCH http://localhost:9090 + - docker run -i -v ${PWD}/:/data wistefan/redocly-openapi-cli bundle /data/spec/updated/ngsi-ld-spec-open-api.json -o /data/spec/updated/full_api.json + - docker run --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/full_api.json + allow_failure: false -- GitLab From f9976943463469b064b65580cdb3446ab9cfc63d Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Tue, 2 Mar 2021 16:07:27 +0100 Subject: [PATCH 19/43] try with branch name --- .gitlab-ci.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 0d2bf28..6f46135 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -13,7 +13,7 @@ test-pr: only: [ merge_requests ] stage: test script: - - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/$CI_MERGE_REQUEST_SOURCE_BRANCH_NAME http://localhost:9090 + - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/$CI_MERGE_REQUEST_SOURCE_BRANCH_NAME - docker run -i -v ${PWD}/:/data wistefan/redocly-openapi-cli bundle /data/spec/updated/ngsi-ld-spec-open-api.json -o /data/spec/updated/full_api.json - docker run --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/full_api.json allow_failure: false @@ -22,7 +22,7 @@ test-branch: only: [ branches ] stage: test script: - - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/$CI_COMMIT_BRANCH http://localhost:9090 + - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/$CI_COMMIT_BRANCH - docker run -i -v ${PWD}/:/data wistefan/redocly-openapi-cli bundle /data/spec/updated/ngsi-ld-spec-open-api.json -o /data/spec/updated/full_api.json - docker run --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/full_api.json allow_failure: false -- GitLab From f9b68d34ef255cef9080879582c60b52761ec840 Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Tue, 2 Mar 2021 16:12:18 +0100 Subject: [PATCH 20/43] try with branch name --- .gitlab-ci.yml | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 6f46135..9b01979 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -13,15 +13,17 @@ test-pr: only: [ merge_requests ] stage: test script: - - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/$CI_MERGE_REQUEST_SOURCE_BRANCH_NAME - - docker run -i -v ${PWD}/:/data wistefan/redocly-openapi-cli bundle /data/spec/updated/ngsi-ld-spec-open-api.json -o /data/spec/updated/full_api.json - - docker run --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/full_api.json + - echo $CI_MERGE_REQUEST_SOURCE_BRANCH_NAME + - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/$CI_MERGE_REQUEST_SOURCE_BRANCH_NAME + - docker run -i -v ${PWD}/:/data wistefan/redocly-openapi-cli bundle /data/spec/updated/ngsi-ld-spec-open-api.json -o /data/spec/updated/full_api.json +- docker run --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/full_api.json allow_failure: false test-branch: only: [ branches ] stage: test script: + - echo $CI_COMMIT_BRANCH - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/$CI_COMMIT_BRANCH - docker run -i -v ${PWD}/:/data wistefan/redocly-openapi-cli bundle /data/spec/updated/ngsi-ld-spec-open-api.json -o /data/spec/updated/full_api.json - docker run --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/full_api.json -- GitLab From bf4aa587b31d335c057ab364ab49a0f956ecb687 Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Tue, 2 Mar 2021 16:12:57 +0100 Subject: [PATCH 21/43] fix yaml --- .gitlab-ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 9b01979..2cd3a3f 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -16,7 +16,7 @@ test-pr: - echo $CI_MERGE_REQUEST_SOURCE_BRANCH_NAME - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/$CI_MERGE_REQUEST_SOURCE_BRANCH_NAME - docker run -i -v ${PWD}/:/data wistefan/redocly-openapi-cli bundle /data/spec/updated/ngsi-ld-spec-open-api.json -o /data/spec/updated/full_api.json -- docker run --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/full_api.json + - docker run --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/full_api.json allow_failure: false test-branch: -- GitLab From 4e0c3864d7f28b256901b4fa8cc35ffc9a7f18c1 Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Tue, 2 Mar 2021 16:15:29 +0100 Subject: [PATCH 22/43] fix yaml --- .gitlab-ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 2cd3a3f..96de8ef 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -23,7 +23,7 @@ test-branch: only: [ branches ] stage: test script: - - echo $CI_COMMIT_BRANCH + - echo $CI_COMMIT_REF_NAME - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/$CI_COMMIT_BRANCH - docker run -i -v ${PWD}/:/data wistefan/redocly-openapi-cli bundle /data/spec/updated/ngsi-ld-spec-open-api.json -o /data/spec/updated/full_api.json - docker run --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/full_api.json -- GitLab From 81da9925a7c4685f5292ffa6dca51080e0505546 Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Tue, 2 Mar 2021 16:16:19 +0100 Subject: [PATCH 23/43] fix yaml --- .gitlab-ci.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 96de8ef..1f6f052 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -13,7 +13,7 @@ test-pr: only: [ merge_requests ] stage: test script: - - echo $CI_MERGE_REQUEST_SOURCE_BRANCH_NAME + - echo $(CI_MERGE_REQUEST_SOURCE_BRANCH_NAME) - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/$CI_MERGE_REQUEST_SOURCE_BRANCH_NAME - docker run -i -v ${PWD}/:/data wistefan/redocly-openapi-cli bundle /data/spec/updated/ngsi-ld-spec-open-api.json -o /data/spec/updated/full_api.json - docker run --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/full_api.json @@ -23,7 +23,7 @@ test-branch: only: [ branches ] stage: test script: - - echo $CI_COMMIT_REF_NAME + - echo $(CI_COMMIT_REF_NAME) - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/$CI_COMMIT_BRANCH - docker run -i -v ${PWD}/:/data wistefan/redocly-openapi-cli bundle /data/spec/updated/ngsi-ld-spec-open-api.json -o /data/spec/updated/full_api.json - docker run --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/full_api.json -- GitLab From cc0b7b41d98463a618cdee40a0ed4fc8261d0dfd Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Tue, 2 Mar 2021 16:17:49 +0100 Subject: [PATCH 24/43] fix yaml --- .gitlab-ci.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 1f6f052..75e0d2c 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -23,7 +23,8 @@ test-branch: only: [ branches ] stage: test script: - - echo $(CI_COMMIT_REF_NAME) + - echo $CI_JOB_STAGE + - echo $CI_COMMIT_REF_NAME - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/$CI_COMMIT_BRANCH - docker run -i -v ${PWD}/:/data wistefan/redocly-openapi-cli bundle /data/spec/updated/ngsi-ld-spec-open-api.json -o /data/spec/updated/full_api.json - docker run --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/full_api.json -- GitLab From 1dbcff2cec910b0492c2061c9d3c563c868deda0 Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Tue, 2 Mar 2021 16:18:29 +0100 Subject: [PATCH 25/43] fix yaml --- .gitlab-ci.yml | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 75e0d2c..baf8bf5 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -13,7 +13,6 @@ test-pr: only: [ merge_requests ] stage: test script: - - echo $(CI_MERGE_REQUEST_SOURCE_BRANCH_NAME) - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/$CI_MERGE_REQUEST_SOURCE_BRANCH_NAME - docker run -i -v ${PWD}/:/data wistefan/redocly-openapi-cli bundle /data/spec/updated/ngsi-ld-spec-open-api.json -o /data/spec/updated/full_api.json - docker run --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/full_api.json @@ -23,9 +22,7 @@ test-branch: only: [ branches ] stage: test script: - - echo $CI_JOB_STAGE - - echo $CI_COMMIT_REF_NAME - - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/$CI_COMMIT_BRANCH + - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/$CI_COMMIT_REF_NAME - docker run -i -v ${PWD}/:/data wistefan/redocly-openapi-cli bundle /data/spec/updated/ngsi-ld-spec-open-api.json -o /data/spec/updated/full_api.json - docker run --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/full_api.json allow_failure: false -- GitLab From be673efa126da31ef354f9433215b91331dd10fb Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Tue, 2 Mar 2021 16:41:44 +0100 Subject: [PATCH 26/43] fix yaml --- .gitlab-ci.yml | 28 +++++++++++----------------- 1 file changed, 11 insertions(+), 17 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index baf8bf5..d1fc585 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,7 +1,3 @@ -# 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: docker:19.03.12 before_script: - docker info @@ -9,20 +5,18 @@ before_script: stages: - test -test-pr: - only: [ merge_requests ] +test: stage: test + image: docker:19.03.12 +# needs: +# - job:build script: - - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/$CI_MERGE_REQUEST_SOURCE_BRANCH_NAME - - docker run -i -v ${PWD}/:/data wistefan/redocly-openapi-cli bundle /data/spec/updated/ngsi-ld-spec-open-api.json -o /data/spec/updated/full_api.json - - docker run --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/full_api.json + - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master http://localhost:9090 + - docker run --name fileserver --rm -d -v ${PWD}/:/ngsi -e FOLDER=/ngsi -p 9090:8080 halverneus/static-file-server + - docker run --network host -i -v ${PWD}/:/data wistefan/redocly-openapi-cli bundle /data/spec/updated/ngsi-ld-spec-open-api.json -o /data/spec/updated/full_api.json + - docker run --network host --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/full_api.json + - scripts/setBasePath.sh http://localhost:8090 https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master + after_script: + - docker stop fileserver allow_failure: false -test-branch: - only: [ branches ] - stage: test - script: - - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/$CI_COMMIT_REF_NAME - - docker run -i -v ${PWD}/:/data wistefan/redocly-openapi-cli bundle /data/spec/updated/ngsi-ld-spec-open-api.json -o /data/spec/updated/full_api.json - - docker run --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/full_api.json - allow_failure: false -- GitLab From 7e7348344c074c9de981f692ede6e65e262ce482 Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Fri, 5 Mar 2021 11:09:12 +0100 Subject: [PATCH 27/43] try with services --- .gitlab-ci.yml | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index d1fc585..645ff4a 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -5,18 +5,25 @@ before_script: stages: - test +build: + stage: test + image: docker:19.03.12 + script: + - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master http://localhost:8080 + - docker build -t ngsi-local -f docker/Dockerfile . + test: stage: test image: docker:19.03.12 -# needs: -# - job:build + services: + - image: ngsi-local + environment: + - FOLDER=/ngsi + needs: + - job:build script: - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master http://localhost:9090 - - docker run --name fileserver --rm -d -v ${PWD}/:/ngsi -e FOLDER=/ngsi -p 9090:8080 halverneus/static-file-server - docker run --network host -i -v ${PWD}/:/data wistefan/redocly-openapi-cli bundle /data/spec/updated/ngsi-ld-spec-open-api.json -o /data/spec/updated/full_api.json - docker run --network host --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/full_api.json - - scripts/setBasePath.sh http://localhost:8090 https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master - after_script: - - docker stop fileserver allow_failure: false -- GitLab From 86d0f63e6feb89b6de3cc8c67936f031cf3b13d2 Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Fri, 5 Mar 2021 11:18:43 +0100 Subject: [PATCH 28/43] try with services --- .gitlab-ci.yml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 645ff4a..3b4d458 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -3,14 +3,16 @@ before_script: - docker info stages: + - prepare - test build: - stage: test + stage: prepare image: docker:19.03.12 script: - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master http://localhost:8080 - docker build -t ngsi-local -f docker/Dockerfile . + allow_failure: false test: stage: test @@ -19,11 +21,9 @@ test: - image: ngsi-local environment: - FOLDER=/ngsi - needs: - - job:build script: - - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master http://localhost:9090 - - docker run --network host -i -v ${PWD}/:/data wistefan/redocly-openapi-cli bundle /data/spec/updated/ngsi-ld-spec-open-api.json -o /data/spec/updated/full_api.json - - docker run --network host --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/full_api.json + - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master http://localhost:9090 + - docker run --network host -i -v ${PWD}/:/data wistefan/redocly-openapi-cli bundle /data/spec/updated/ngsi-ld-spec-open-api.json -o /data/spec/updated/full_api.json + - docker run --network host --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/full_api.json allow_failure: false -- GitLab From 890c0ea46935165be622d3228061e96d3be746a8 Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Fri, 5 Mar 2021 11:22:28 +0100 Subject: [PATCH 29/43] try with services --- .gitlab-ci.yml | 4 +--- docker/Dockerfile | 2 ++ 2 files changed, 3 insertions(+), 3 deletions(-) create mode 100644 docker/Dockerfile diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 3b4d458..e024340 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -18,9 +18,7 @@ test: stage: test image: docker:19.03.12 services: - - image: ngsi-local - environment: - - FOLDER=/ngsi + - ngsi-local script: - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master http://localhost:9090 - docker run --network host -i -v ${PWD}/:/data wistefan/redocly-openapi-cli bundle /data/spec/updated/ngsi-ld-spec-open-api.json -o /data/spec/updated/full_api.json diff --git a/docker/Dockerfile b/docker/Dockerfile new file mode 100644 index 0000000..ade0699 --- /dev/null +++ b/docker/Dockerfile @@ -0,0 +1,2 @@ +FROM halverneus/static-file-server +ADD . /web \ No newline at end of file -- GitLab From b670ab038589ebfb037912637ad923ee85c5e53b Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Fri, 5 Mar 2021 11:30:25 +0100 Subject: [PATCH 30/43] commit bundled api --- .gitlab-ci.yml | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index e024340..e7f5b0a 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -19,9 +19,23 @@ test: image: docker:19.03.12 services: - ngsi-local + before_script: + - 'which ssh-agent || ( apt-get update -qy && apt-get install openssh-client -qqy )' + - eval `ssh-agent -s` + - echo "${SSH_PRIVATE_KEY}" | tr -d '\r' | ssh-add - > /dev/null # add ssh ke + - mkdir -p ~/.ssh + - chmod 700 ~/.ssh + - echo "$SSH_PUBLIC_KEY" >> ~/.ssh/id_rsa.pub + - '[[ -f /.dockerenv ]] && echo -e "Host *\n\tStrictHostKeyChecking no\n\n" > ~/.ssh/config' script: - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master http://localhost:9090 - - docker run --network host -i -v ${PWD}/:/data wistefan/redocly-openapi-cli bundle /data/spec/updated/ngsi-ld-spec-open-api.json -o /data/spec/updated/full_api.json - - docker run --network host --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/full_api.json + - docker run --network host -i -v ${PWD}/:/data wistefan/redocly-openapi-cli bundle /data/spec/updated/ngsi-ld-spec-open-api.json -o /data/spec/updated/generated/full_api.json + - docker run --network host --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/generated/full_api.json + - git config --global user.email "${CI_EMAIL}" + - git config --global user.name "${CI_USERNAME}" + - git add -f /spec/updated/generated/full_api.json + - git commit -m "Update bundled spec." || echo "No changes, nothing to commit!" + - git remote rm origin && git remote add origin git@gitlab.com:$CI_PROJECT_PATH.git + - git push origin HEAD:$CI_COMMIT_REF_NAME allow_failure: false -- GitLab From 415f5df69963f6e58c83648ef8f372b0f74cf045 Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Fri, 5 Mar 2021 11:33:11 +0100 Subject: [PATCH 31/43] commit bundled api --- .gitlab-ci.yml | 8 -------- 1 file changed, 8 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index e7f5b0a..4faf4f8 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -19,14 +19,6 @@ test: image: docker:19.03.12 services: - ngsi-local - before_script: - - 'which ssh-agent || ( apt-get update -qy && apt-get install openssh-client -qqy )' - - eval `ssh-agent -s` - - echo "${SSH_PRIVATE_KEY}" | tr -d '\r' | ssh-add - > /dev/null # add ssh ke - - mkdir -p ~/.ssh - - chmod 700 ~/.ssh - - echo "$SSH_PUBLIC_KEY" >> ~/.ssh/id_rsa.pub - - '[[ -f /.dockerenv ]] && echo -e "Host *\n\tStrictHostKeyChecking no\n\n" > ~/.ssh/config' script: - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master http://localhost:9090 - docker run --network host -i -v ${PWD}/:/data wistefan/redocly-openapi-cli bundle /data/spec/updated/ngsi-ld-spec-open-api.json -o /data/spec/updated/generated/full_api.json -- GitLab From fa1b987855b1c35cc8301504ba6df54f9f29f33b Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Fri, 5 Mar 2021 11:36:07 +0100 Subject: [PATCH 32/43] commit bundled api --- .gitlab-ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 4faf4f8..2424b7d 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -25,7 +25,7 @@ test: - docker run --network host --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/generated/full_api.json - git config --global user.email "${CI_EMAIL}" - git config --global user.name "${CI_USERNAME}" - - git add -f /spec/updated/generated/full_api.json + - git add -f ${PWD}/spec/updated/generated/full_api.json - git commit -m "Update bundled spec." || echo "No changes, nothing to commit!" - git remote rm origin && git remote add origin git@gitlab.com:$CI_PROJECT_PATH.git - git push origin HEAD:$CI_COMMIT_REF_NAME -- GitLab From 596135860f673b7cb9c0910ab8fe8d9bd7b2f6ba Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Fri, 5 Mar 2021 11:39:38 +0100 Subject: [PATCH 33/43] commit bundled api --- .gitlab-ci.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 2424b7d..180aa25 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -23,6 +23,8 @@ test: - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master http://localhost:9090 - docker run --network host -i -v ${PWD}/:/data wistefan/redocly-openapi-cli bundle /data/spec/updated/ngsi-ld-spec-open-api.json -o /data/spec/updated/generated/full_api.json - docker run --network host --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/generated/full_api.json + - echo ${PWD} + - ls /spec/updated/generated/ - git config --global user.email "${CI_EMAIL}" - git config --global user.name "${CI_USERNAME}" - git add -f ${PWD}/spec/updated/generated/full_api.json -- GitLab From 437ecb273c25679dbf34ee5427d0387583a5070e Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Fri, 5 Mar 2021 11:40:36 +0100 Subject: [PATCH 34/43] commit bundled api --- .gitlab-ci.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 180aa25..e4b90dc 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -25,8 +25,7 @@ test: - docker run --network host --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/generated/full_api.json - echo ${PWD} - ls /spec/updated/generated/ - - git config --global user.email "${CI_EMAIL}" - - git config --global user.name "${CI_USERNAME}" + - git config --global user.name "${CI_DEPLOY_USER}" - git add -f ${PWD}/spec/updated/generated/full_api.json - git commit -m "Update bundled spec." || echo "No changes, nothing to commit!" - git remote rm origin && git remote add origin git@gitlab.com:$CI_PROJECT_PATH.git -- GitLab From dd00515861d44ada6f463c1ff067d7ed8614645e Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Fri, 5 Mar 2021 11:41:19 +0100 Subject: [PATCH 35/43] commit bundled api --- .gitlab-ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index e4b90dc..36ba3e7 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -24,7 +24,7 @@ test: - docker run --network host -i -v ${PWD}/:/data wistefan/redocly-openapi-cli bundle /data/spec/updated/ngsi-ld-spec-open-api.json -o /data/spec/updated/generated/full_api.json - docker run --network host --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/generated/full_api.json - echo ${PWD} - - ls /spec/updated/generated/ + - ls ${PWD}/spec/updated/generated/ - git config --global user.name "${CI_DEPLOY_USER}" - git add -f ${PWD}/spec/updated/generated/full_api.json - git commit -m "Update bundled spec." || echo "No changes, nothing to commit!" -- GitLab From 19d96e96bfbc75f6b9d02d0c9ce3ab0ac5ea188b Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Fri, 5 Mar 2021 11:46:03 +0100 Subject: [PATCH 36/43] commit bundled api --- .gitlab-ci.yml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 36ba3e7..dacb8dd 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -23,9 +23,8 @@ test: - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master http://localhost:9090 - docker run --network host -i -v ${PWD}/:/data wistefan/redocly-openapi-cli bundle /data/spec/updated/ngsi-ld-spec-open-api.json -o /data/spec/updated/generated/full_api.json - docker run --network host --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/generated/full_api.json - - echo ${PWD} - - ls ${PWD}/spec/updated/generated/ - - git config --global user.name "${CI_DEPLOY_USER}" + - git config --global user.email "ci@etsi.org" + - git config --global user.name "Gitlab runner" - git add -f ${PWD}/spec/updated/generated/full_api.json - git commit -m "Update bundled spec." || echo "No changes, nothing to commit!" - git remote rm origin && git remote add origin git@gitlab.com:$CI_PROJECT_PATH.git -- GitLab From a58e8eb4eed9aefe8552ef9554d0a4a506cfd45e Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Fri, 5 Mar 2021 11:49:08 +0100 Subject: [PATCH 37/43] commit bundled api --- .gitlab-ci.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index dacb8dd..7df17ac 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -27,7 +27,6 @@ test: - git config --global user.name "Gitlab runner" - git add -f ${PWD}/spec/updated/generated/full_api.json - git commit -m "Update bundled spec." || echo "No changes, nothing to commit!" - - git remote rm origin && git remote add origin git@gitlab.com:$CI_PROJECT_PATH.git - - git push origin HEAD:$CI_COMMIT_REF_NAME + - git push allow_failure: false -- GitLab From e0f9a604d67597a952f88c6412dcdf722383a097 Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Fri, 5 Mar 2021 11:51:02 +0100 Subject: [PATCH 38/43] commit bundled api --- .gitlab-ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 7df17ac..ae39838 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -27,6 +27,6 @@ test: - git config --global user.name "Gitlab runner" - git add -f ${PWD}/spec/updated/generated/full_api.json - git commit -m "Update bundled spec." || echo "No changes, nothing to commit!" - - git push + - git push origin HEAD:$CI_COMMIT_REF_NAME allow_failure: false -- GitLab From 29c1ed836d97a8c7e09dc8177264be114813872f Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Fri, 5 Mar 2021 12:01:00 +0100 Subject: [PATCH 39/43] commit bundled api --- .gitlab-ci.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index ae39838..dd3c25a 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -27,6 +27,8 @@ test: - git config --global user.name "Gitlab runner" - git add -f ${PWD}/spec/updated/generated/full_api.json - git commit -m "Update bundled spec." || echo "No changes, nothing to commit!" + - url_host=`git remote get-url origin | sed -e "s/https:\/\/gitlab-ci-token:.*@//g"` + - git remote set-url origin "https://gitlab-ci-token:${GIT_PUSH_TOKEN}@${url_host}" - git push origin HEAD:$CI_COMMIT_REF_NAME allow_failure: false -- GitLab From 449e70a297924115f98e26ba85dee11c2ab790bd Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Fri, 5 Mar 2021 12:03:00 +0100 Subject: [PATCH 40/43] commit bundled api --- .gitlab-ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index dd3c25a..01aec23 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -28,7 +28,7 @@ test: - git add -f ${PWD}/spec/updated/generated/full_api.json - git commit -m "Update bundled spec." || echo "No changes, nothing to commit!" - url_host=`git remote get-url origin | sed -e "s/https:\/\/gitlab-ci-token:.*@//g"` - - git remote set-url origin "https://gitlab-ci-token:${GIT_PUSH_TOKEN}@${url_host}" + - git remote set-url origin "https://gitlab-ci-token:$GIT_PUSH_TOKEN@${url_host}" - git push origin HEAD:$CI_COMMIT_REF_NAME allow_failure: false -- GitLab From b6ee8ad499f47fa6da2bf91bc305b00c646e2102 Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Fri, 5 Mar 2021 12:03:10 +0100 Subject: [PATCH 41/43] commit bundled api --- .gitlab-ci.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 01aec23..4998007 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -20,6 +20,7 @@ test: services: - ngsi-local script: + - echo $TEST - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master http://localhost:9090 - docker run --network host -i -v ${PWD}/:/data wistefan/redocly-openapi-cli bundle /data/spec/updated/ngsi-ld-spec-open-api.json -o /data/spec/updated/generated/full_api.json - docker run --network host --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/generated/full_api.json -- GitLab From a99a0f0c1e49ef9d18795433c0f07ccea559feec Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Fri, 5 Mar 2021 12:05:46 +0100 Subject: [PATCH 42/43] commit bundled api --- .gitlab-ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 4998007..211fd19 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -20,7 +20,7 @@ test: services: - ngsi-local script: - - echo $TEST + - echo ${TEST} - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master http://localhost:9090 - docker run --network host -i -v ${PWD}/:/data wistefan/redocly-openapi-cli bundle /data/spec/updated/ngsi-ld-spec-open-api.json -o /data/spec/updated/generated/full_api.json - docker run --network host --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/generated/full_api.json -- GitLab From 18e91b13aee45c90931d0ed62b911ead1ffaa8a5 Mon Sep 17 00:00:00 2001 From: Stefan Wiedemann Date: Fri, 5 Mar 2021 12:09:42 +0100 Subject: [PATCH 43/43] commit bundled api --- .gitlab-ci.yml | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 211fd19..5faabfb 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -24,12 +24,6 @@ test: - scripts/setBasePath.sh https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master http://localhost:9090 - docker run --network host -i -v ${PWD}/:/data wistefan/redocly-openapi-cli bundle /data/spec/updated/ngsi-ld-spec-open-api.json -o /data/spec/updated/generated/full_api.json - docker run --network host --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/generated/full_api.json - - git config --global user.email "ci@etsi.org" - - git config --global user.name "Gitlab runner" - - git add -f ${PWD}/spec/updated/generated/full_api.json - - git commit -m "Update bundled spec." || echo "No changes, nothing to commit!" - - url_host=`git remote get-url origin | sed -e "s/https:\/\/gitlab-ci-token:.*@//g"` - - git remote set-url origin "https://gitlab-ci-token:$GIT_PUSH_TOKEN@${url_host}" - - git push origin HEAD:$CI_COMMIT_REF_NAME allow_failure: false +# TODO: after gitlab update, the ci should publish the bundled api -- GitLab