Commit a3894a65 authored by daniel-gonzalez-sanchez's avatar daniel-gonzalez-sanchez
Browse files

Adding NGSILD-EntityMap Header within GET /entities and GET... 

Adding NGSILD-EntityMap Header within GET /entities and GET /entities/{entityId} operations as request header parameter and response header.
parent db4324df

openapi-3.0.3/ngsi-ld-api.yaml

+13 −2
Original line number Diff line number Diff line
@@ -125,6 +125,7 @@ paths: 
        # Local Query param

        - $ref: '#/components/parameters/Query.local'

        # Request headers

        - $ref: '#/components/parameters/Headers.ngsildEntityMap'

        - $ref: '#/components/parameters/Headers.Link'

        - $ref: '#/components/parameters/Headers.ngsildTenant'

        - $ref: '#/components/parameters/Headers.via'
@@ -140,8 +141,8 @@ paths: 
            If an EntityMap has been requested, the HTTP response shall include an "NGSILDEntityMap" HTTP 

            header that contains the resource URI of the EntityMap resource used in the operation.

          headers:

            #NGSILD-EntityMap:

            #  $ref: '#/components/headers/NGSILD-EntityMap'

            NGSILD-EntityMap:

              $ref: '#/components/headers/NGSILD-EntityMap'

            NGSILD-Results-Count:

              $ref: '#/components/headers/NGSILD-Results-Count'

            NGSILD-Tenant:
@@ -211,6 +212,7 @@ paths: 
        # Local Query param

        - $ref: '#/components/parameters/Query.local'

        # Request headers

        - $ref: '#/components/parameters/Headers.ngsildEntityMap'

        - $ref: '#/components/parameters/Headers.Link'

        - $ref: '#/components/parameters/Headers.ngsildTenant'

        - $ref: '#/components/parameters/Headers.via'
@@ -2909,6 +2911,15 @@ components: 
          - '299 - Miscellaneous Persistent Warning'

      required: false

  parameters:

    Headers.ngsildEntityMap:

      name: NGSILD-EntityMap

      in: header

      description: |

        If present, the EntityMap supplied is used for determining the set of Entities requested during the query operation. 

        The location of the EntityMap used in the query/retrieval operation is returned in the response.

      schema:

        type: string

        format: uri

    Headers.Link:

      name: Link

      in: header

openapi-3.1.0/ngsi-ld-api.yaml

+13 −2
Original line number Diff line number Diff line
@@ -125,6 +125,7 @@ paths: 
        # Local Query param

        - $ref: '#/components/parameters/Query.local'

        # Request headers

        - $ref: '#/components/parameters/Headers.ngsildEntityMap'

        - $ref: '#/components/parameters/Headers.Link'

        - $ref: '#/components/parameters/Headers.ngsildTenant'

        - $ref: '#/components/parameters/Headers.via'
@@ -140,8 +141,8 @@ paths: 
            If an EntityMap has been requested, the HTTP response shall include an "NGSILDEntityMap" HTTP 

            header that contains the resource URI of the EntityMap resource used in the operation.

          headers:

            #NGSILD-EntityMap:

            #  $ref: '#/components/headers/NGSILD-EntityMap'

            NGSILD-EntityMap:

              $ref: '#/components/headers/NGSILD-EntityMap'

            NGSILD-Results-Count:

              $ref: '#/components/headers/NGSILD-Results-Count'

            NGSILD-Tenant:
@@ -211,6 +212,7 @@ paths: 
        # Local Query param

        - $ref: '#/components/parameters/Query.local'

        # Request headers

        - $ref: '#/components/parameters/Headers.ngsildEntityMap'

        - $ref: '#/components/parameters/Headers.Link'

        - $ref: '#/components/parameters/Headers.ngsildTenant'

        - $ref: '#/components/parameters/Headers.via'
@@ -2909,6 +2911,15 @@ components: 
          - '299 - Miscellaneous Persistent Warning'

      required: false

  parameters:

    Headers.ngsildEntityMap:

      name: NGSILD-EntityMap

      in: header

      description: |

        If present, the EntityMap supplied is used for determining the set of Entities requested during the query operation. 

        The location of the EntityMap used in the query/retrieval operation is returned in the response.

      schema:

        type: string

        format: uri  

    Headers.Link:

      name: Link

      in: header