ngsi-ld-spec-open-api.json 3.17 KB
Newer Older
{
    "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": ""
        },
    }
}