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

Adding the optional query parameter type for the selection of Entity type in... 

Adding the optional query parameter type for the selection of Entity type in additional operations as indicated in ETSI GS CIM 009 V1.7.1 (i.e., 6.5.3.1 GET /entities/{entityId}, 6.5.3.2 DELETE /entities/{entityId}, 6.5.3.3 PUT /entities/{entityId}, 6.5.3.4 PATCH /entities/{entityId}, 6.6.3.1 POST /entities/{entityId}/attrs/, 6.6.3.2 PATCH /entities/{entityId}/attrs/, 6.7.3.1 PATCH /entities/{entityId}/attrs/{attrId}, 6.7.3.2 DELETE /entities/{entityId}/attrs/{attrId}, and 6.7.3.3 PUT /entities/{entityId}/attrs/{attrId}). Adding the optional query parameter options for the selection of noOverwrite value for 6.6.3.1 POST /entities/{entityId}/attrs/ operation as indicated in ETSI GS CIM 009 V1.7.1.
parent a0b134f5

ngsi-ld-api.yaml

+12 −1
Original line number Original line Diff line number Diff line
@@ -195,6 +195,7 @@ paths: 
        # Path params

        # Path params

        - $ref: '#/components/parameters/Path.entityId'

        - $ref: '#/components/parameters/Path.entityId'

        # Query params

        # Query params

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

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

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

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

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

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

        - $ref: '#/components/parameters/Query.lang'
@@ -273,6 +274,8 @@ paths: 
      parameters:

      parameters:

        # Path params

        # Path params

        - $ref: '#/components/parameters/Path.entityId'

        - $ref: '#/components/parameters/Path.entityId'

        # Query params

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

        # Local Query param

        # Local Query param

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

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

        # Request headers

        # Request headers
@@ -325,6 +328,7 @@ paths: 
            items:

            items:

              $ref: '#/components/schemas/options.representation'

              $ref: '#/components/schemas/options.representation'

          required: false

          required: false

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

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

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

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

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

        # Local Query param

        # Local Query param
@@ -376,6 +380,8 @@ paths: 
      parameters:

      parameters:

        # Path params

        # Path params

        - $ref: '#/components/parameters/Path.entityId'

        - $ref: '#/components/parameters/Path.entityId'

        # Query params

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

        # Local Query param

        # Local Query param

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

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

        # Request headers

        # Request headers
@@ -428,6 +434,7 @@ paths: 
        # Path params

        # Path params

        - $ref: '#/components/parameters/Path.entityId'

        - $ref: '#/components/parameters/Path.entityId'

        # Query params

        # Query params

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

        - $ref: '#/components/parameters/Query.options.noOverwrite'

        - $ref: '#/components/parameters/Query.options.noOverwrite'

        # Local Query param

        # Local Query param

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

        - $ref: '#/components/parameters/Query.local'
@@ -481,6 +488,7 @@ paths: 
        - $ref: '#/components/parameters/Path.entityId'

        - $ref: '#/components/parameters/Path.entityId'

        # Local Query param

        # Local Query param

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

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

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

        # Request headers

        # Request headers

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

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

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

        - $ref: '#/components/parameters/Headers.ngsildTenant'
@@ -533,6 +541,7 @@ paths: 
        - $ref: '#/components/parameters/Path.attrId'

        - $ref: '#/components/parameters/Path.attrId'

        # Local Query param

        # Local Query param

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

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

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

        # Request headers

        # Request headers

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

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

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

        - $ref: '#/components/parameters/Headers.ngsildTenant'
@@ -570,6 +579,7 @@ paths: 
        # Query params

        # Query params

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

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

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

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

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

        # Local Query param

        # Local Query param

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

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

        # Request headers

        # Request headers
@@ -605,6 +615,7 @@ paths: 
        - $ref: '#/components/parameters/Path.attrId'

        - $ref: '#/components/parameters/Path.attrId'

        # Local Query param

        # Local Query param

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

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

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

        # Request headers

        # Request headers

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

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

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

        - $ref: '#/components/parameters/Headers.ngsildTenant'
@@ -3305,7 +3316,7 @@ components: 
    #

    #

    options.noOverwrite:

    options.noOverwrite:

      description: |

      description: |

        6.16.3 For POST method associated to the operation "Batch Entity Update", the "noOvevwrite" 

        6.16.3 For POST method associated to the operations "Batch Entity Update" and "Append Entity Attributes", the "noOvevwrite" 

        options query parameter indicates that no attribute overwrite shall be performed.

        options query parameter indicates that no attribute overwrite shall be performed.

      type: string

      type: string

      enum:

      enum: