Commit 4a610861 authored by canterafonsj's avatar canterafonsj

First stab of Swagger content

parent 869c752f
{
"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"
}
]
}
}
{
"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": ""
}
}
}
}
}
}
}
}
}
{
"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": ""
},
}
}
{
"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"
}
]
}
}
Markdown is supported
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