Commit debd3734 authored by canterafonsj's avatar canterafonsj
Browse files

Options and pointing to the correct definitions

parent d239659c

spec/updated/entities-spec.json

+14 −1
Original line number Original line Diff line number Diff line
@@ -112,6 +112,16 @@ 
          "type": "integer",

          "type": "integer",

          "minimum": 1

          "minimum": 1

        }

        }

      },

      "options":{

        "name": "options",

        "description": "Options dictionary",

        "in": "query",

        "required": false,

        "schema": {

          "type": "string",

          "enum": ["keyValues", "sysAttrs"]

        }

      }

      }

    }

    }

  },

  },
@@ -153,6 +163,9 @@ 
          },

          },

          {

          {

            "$ref": "#/components/parameters/limit"

            "$ref": "#/components/parameters/limit"

          },

          {

            "$ref": "#/components/parameters/options"

          }

          }

        ],

        ],

        "responses": {

        "responses": {
@@ -161,7 +174,7 @@ 
            "content": {

            "content": {

              "application/json;application/ld+json": {

              "application/json;application/ld+json": {

                "schema": {

                "schema": {

                  "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/EntityList.json#"

                  "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/EntityList.json#/definitions/EntityList"

                },

                },

                "examples": {

                "examples": {

                  "simple": {

                  "simple": {

spec/updated/entity-by-id-spec.json

+4 −1
Original line number Original line Diff line number Diff line
@@ -51,6 +51,9 @@ 
          },

          },

          {

          {

            "$ref": "#/components/parameters/type"

            "$ref": "#/components/parameters/type"

          },

          {

            "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/options"

          }

          }

        ],

        ],

        "responses": {

        "responses": {
@@ -59,7 +62,7 @@ 
            "content": {

            "content": {

              "application/json;application/ld+json": {

              "application/json;application/ld+json": {

                "schema": {

                "schema": {

                  "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#"

                  "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/Entity"

                },

                },

                "examples": {

                "examples": {

                  "simple": {

                  "simple": {

spec/updated/full_api.json

0 → 100644
+1048 −0

File added.

Preview size limit exceeded, changes collapsed.

spec/updated/ngsi-ld-spec-open-api_test.json

0 → 100644
+60 −0
Original line number Original line Diff line number Diff line 
{

    "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 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"

            }

        }

    ],

    "paths": {

        "/entities/": {

            "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/paths/%2fentities%2f"

        },

        "/entities/{entityId}": {

            "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-by-id-spec.json#/paths/%2fentities%2f%7BentityId%7D"

        },

         "/entities/{entityId}/attrs/": {

            "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-attrs-spec.json#/paths/%2Fentities%2F%7BentityId%7D%2Fattrs%2F"

        },

        "/entities/{entityId}/attrs/{attrId}": {

            "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-attrs-spec.json#/paths/%2Fentities%2F%7BentityId%7D%2Fattrs%2F%7BattrId%7D"

        },

    }

}