Commit 47846e2c authored by canterafonsj's avatar canterafonsj
Browse files

Fixing enumeration

parent 6602d101
......@@ -141,7 +141,7 @@
},
"geometry": {
"type": "string",
"enumeration": [
"enum": [
"Point",
"MultiPoint",
"LineString",
......@@ -152,7 +152,7 @@
},
"timerel": {
"type": "string",
"enumeration": [
"enum": [
"before",
"after",
"between"
......
{
"openapi": "3.0.1",
"info": {
"title": "NGSI-LD Entities",
"version": "latest"
"title": "NGSI-LD Entity Operations",
"version": "0.1"
},
"components": {
"parameters": {
"id": {
"name": "id",
"description": "Comma separated list of URIs to be retrieved",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "uri"
}
},
"type": {
"name": "type",
"description": "Comma separated list of Entity type names to be retrieved",
"in": "query",
"required": false,
"schema": {
"type": "string",
"minLength": 1
}
},
"idPattern": {
"name": "idPattern",
"description": "Regular expression that must be matched by Entity ids",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "regexp"
}
},
"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": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/georel"
}
},
"geometry": {
"name": "geometry",
"description": "Geometry",
"in": "query",
"required": false,
"schema": {
"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/geometry"
}
},
"coordinates": {
"name": "coordinates",
"description": "Coordinates serialized as a string",
"in": "query",
"required": false,
"schema": {
"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/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"]
"components": {},
"paths": {
"/entityOperations/create": {
"post": {
"description": "Batch Entity creation",
"operationId": "batchEntityCreation",
"requestBody": {
"required": true,
"content": {
"application/json;application/ld+json": {
"schema": {
"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/EntityList.json#/definitions/EntityList"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json;application/ld+json": {
"schema": {
"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/BatchOperationResult.json#/definitions/BatchOperationResult"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json;application/ld+json": {
"schema": {
"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails"
}
}
}
}
}
}
}
},
"paths": {
"/entities/": {
"get": {
"description": "Retrieve a set of entities which matches a specific query from an NGSI-LD system",
"operationId": "queryEntities",
},
"/entityOperations/update": {
"post": {
"description": "Batch Entity update",
"operationId": "batchEntityUpdate",
"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"
"name": "options",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"noOverwrite"
]
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json;application/ld+json": {
"schema": {
"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/EntityList.json#/definitions/EntityList"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"description": "Success",
"content": {
"application/json;application/ld+json": {
"schema": {
"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/EntityList.json#/definitions/EntityList"
},
"examples": {
"simple": {
"externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/EntityList-example.json"
}
"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/BatchOperationResult.json#/definitions/BatchOperationResult"
}
}
}
......@@ -195,23 +93,46 @@
}
}
}
},
}
},
"/entityOperations/upsert": {
"post": {
"description": "Create a new Entity within an NGSI-LD system",
"operationId": "createEntity",
"description": "Batch Entity upsert",
"operationId": "batchEntityUpsert",
"parameters": [
{
"name": "options",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"replace",
"update"
]
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json;application/ld+json": {
"schema": {
"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/Entity"
"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/EntityList.json#/definitions/EntityList"
}
}
}
},
"responses": {
"201": {
"description": "Created. Contains the resource URI of the created Entity"
"200": {
"description": "Success",
"content": {
"application/json;application/ld+json": {
"schema": {
"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/BatchOperationResult.json#/definitions/BatchOperationResult"
}
}
}
},
"400": {
"description": "Bad request",
......@@ -222,19 +143,42 @@
}
}
}
},
"409": {
"description": "Already exists",
}
}
}
},
"/entityOperations/delete": {
"post": {
"description": "Batch Entity delete",
"operationId": "batchEntityDelete",
"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": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails"
"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/BatchOperationResult.json#/definitions/BatchOperationResult"
}
}
}
},
"422": {
"description": "Unprocessable Entity",
"400": {
"description": "Bad request",
"content": {
"application/json;application/ld+json": {
"schema": {
......
......@@ -2,14 +2,13 @@
"openapi": "3.0.1",
"info": {
"title": "NGSI-LD Entity Operations",
"version": "latest"
},
"components": {
"version": "0.1"
},
"components": {},
"paths": {
"/entityOperations/create": {
"post": {
"description": "Batch Entity creation",
"description": "Batch Entity creation",
"operationId": "batchEntityCreation",
"requestBody": {
"required": true,
......@@ -25,12 +24,63 @@
"200": {
"description": "Success",
"content": {
"application/json;application/ld+json": {
"schema": {
"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/BatchOperationResult.json#/definitions/BatchOperationResult"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json;application/ld+json": {
"schema": {
"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails"
}
}
}
}
}
}
},
"/entityOperations/update": {
"post": {
"description": "Batch Entity update",
"operationId": "batchEntityUpdate",
"parameters": [
{
"name": "options",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"noOverwrite"
]
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json;application/ld+json": {
"schema": {
"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/BatchOperationResult.json#/definitions/BatchOperationResult"
"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/EntityList.json#/definitions/EntityList"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json;application/ld+json": {
"schema": {
"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/BatchOperationResult.json#/definitions/BatchOperationResult"
}
}
}
},
"400": {
"description": "Bad request",
......@@ -41,16 +91,104 @@
}
}
}
},
}
}
}
},
"/entityOperations/update": {
},
"/entityOperations/upsert": {
"post": {
"description": "Batch Entity upsert",
"operationId": "batchEntityUpsert",
"parameters": [
{
"name": "options",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"replace",
"update"
]
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json;application/ld+json": {
"schema": {
"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/EntityList.json#/definitions/EntityList"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json;application/ld+json": {
"schema": {
"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/BatchOperationResult.json#/definitions/BatchOperationResult"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json;application/ld+json": {
"schema": {
"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails"
}
}
}
}
}
}
},
"/entityOperations/delete": {
"post": {
"description": "Batch Entity delete",
"operationId": "batchEntityDelete",
"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": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/BatchOperationResult.json#/definitions/BatchOperationResult"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json;application/ld+json": {
"schema": {
"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails"
}
}
}
}
}
}
}
}
}
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment