diff --git a/spec/updated/common.json b/spec/updated/common.json new file mode 100644 index 0000000000000000000000000000000000000000..b30ed695ee6a0a4c27f0048723f08b30a0bd8e1e --- /dev/null +++ b/spec/updated/common.json @@ -0,0 +1,70 @@ +{ + "openapi": "3.0.1", + "components": { + "parameters": [ + { + "name": "id", + "description": "Comma separated list of URIs to be retrieved", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "type", + "description": "Comma separated list of Entity type names to be retrieved", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "idPattern", + "description": "Regular expression that must be matched by Entity ids", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "attrs", + "description": "Comma separated list of attribute names (properties or relationships) to be retrieved", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "q", + "description": "Query", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "georel", + "description": "Geo-relationship", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "geometry", + "description": "Geometry", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "coordinates", + "description": "Coordinates serialized as a string", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "geoproperty", + "description": "The name of the property that contains the geo-spatial data that will be used to resolve the geoquery", + "in": "query", + "required": false, + "type": "string" + } + ] + } +} diff --git a/spec/updated/entities-spec.json b/spec/updated/entities-spec.json new file mode 100644 index 0000000000000000000000000000000000000000..eea871aa1e1a0c3f191bcd15f2b2f0bd1cc8672b --- /dev/null +++ b/spec/updated/entities-spec.json @@ -0,0 +1,42 @@ +{ + "openapi": "3.0.1", + "info": { + "title": "NGSI-LD Entities", + "version": "latest" + }, + "paths": { + "/entities/": { + "get": { + "description": "Retrieve a set of entities which matches a specific query from an NGSI-LD system", + "operationId": "queryEntities", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json;application/ld+json": { + "schema": { + "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/EntityList.json#" + }, + "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": { + "schema": { + "$ref": "" + } + } + } + } + } + } + } + } +} diff --git a/spec/updated/ngsi-ld-spec-open-api.json b/spec/updated/ngsi-ld-spec-open-api.json new file mode 100644 index 0000000000000000000000000000000000000000..4f10ec8fccb7d4bbf848552f03bc4de004ecb7c6 --- /dev/null +++ b/spec/updated/ngsi-ld-spec-open-api.json @@ -0,0 +1,107 @@ +{ + "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" + }, + "basePath": "ngsi-ld/v1", + "tags": [ + { + "name": "ETSI", + "description": "European Telecommunications Standards Institute", + "externalDocs": { + "description": "Find out more", + "url": "http://www.etsi.org" + } + },{ + "name": "CIM", + "description": "Context Information Management", + "externalDocs": { + "description": "Find out more", + "url": "https://portal.etsi.org/tb.aspx?tbid=854&SubTB=854" + } + },{ + "name": "JSON-LD", + "description": "JSON for Linking Data", + "externalDocs": { + "description": "Find out more", + "url": "https://json-ld.org/" + } + },{ + "name": "NGSI-LD API", + "description": "API defined by the ETSI ISG CIM", + "externalDocs": { + "description": "Find out more", + "url": "http://www.etsi.org/deliver/etsi_gs/CIM/001_099/004/01.01.01_60/gs_CIM004v010101p.pdf" + } + } + ], + "schemes": [ + "http", + "https" + ], + "paths": { + "/entities/": { + "$ref": "" + }, + "/entities/{entityId}": { + "$ref": "" + }, + "/entities/{entityId}/attrs/": { + "$ref": "" + }, + "/entities/{entityId}/attrs/{attrId}": { + "$ref": "" + }, + "/csourceRegistrations/": { + "$ref": "" + }, + "/csourceRegistrations/{registrationId}": { + "$ref": "" + }, + "/subscriptions/": { + "$ref": "" + }, + "/subscriptions/{subscriptionId}": { + "$ref": "" + }, + "/csourceSubscriptions/": { + "$ref": "" + }, + "/entityOperations/create": { + "$ref": "" + }, + "/entityOperations/upsert": { + "$ref": "" + }, + "/entityOperations/update": { + "$ref": "" + }, + "/entityOperations/delete": { + "$ref": "" + }, + "/temporal/entities/": { + "$ref": "" + }, + "/temporal/entities/{entityId}": { + "$ref": "" + }, + "/temporal/entities/{entityId}/attrs/{attrId}": { + "$ref": "" + }, + "/temporal/entities/{entityId}/attrs/{attrId}/": { + "$ref": "" + }, + "/temporal/entities/{entityId}/attrs/{attrId}/{instanceId}": { + "$ref": "" + }, + } +} diff --git a/spec/updated/query_entities_parameters.json b/spec/updated/query_entities_parameters.json new file mode 100644 index 0000000000000000000000000000000000000000..b30ed695ee6a0a4c27f0048723f08b30a0bd8e1e --- /dev/null +++ b/spec/updated/query_entities_parameters.json @@ -0,0 +1,70 @@ +{ + "openapi": "3.0.1", + "components": { + "parameters": [ + { + "name": "id", + "description": "Comma separated list of URIs to be retrieved", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "type", + "description": "Comma separated list of Entity type names to be retrieved", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "idPattern", + "description": "Regular expression that must be matched by Entity ids", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "attrs", + "description": "Comma separated list of attribute names (properties or relationships) to be retrieved", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "q", + "description": "Query", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "georel", + "description": "Geo-relationship", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "geometry", + "description": "Geometry", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "coordinates", + "description": "Coordinates serialized as a string", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "geoproperty", + "description": "The name of the property that contains the geo-spatial data that will be used to resolve the geoquery", + "in": "query", + "required": false, + "type": "string" + } + ] + } +}