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

Including the schema and query parameter definition for format representation... 

Including the schema and query parameter definition for format representation within /entity and /entity/temporal operations (this new parameter deprecates the options representation parameter).
parent 47cb5363

ngsi-ld-api.yaml

+71 −1
Original line number Diff line number Diff line
@@ -120,6 +120,7 @@ paths: 
        - $ref: '#/components/parameters/Query.limit'

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

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

        - $ref: '#/components/parameters/Query.format.entities'

        # Local Query param

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

        # Request headers
@@ -204,6 +205,7 @@ paths: 
        - $ref: '#/components/parameters/Query.datasetId'

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

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

        - $ref: '#/components/parameters/Query.format.entities'

        # Local Query param

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

        # Request headers
@@ -313,6 +315,7 @@ paths: 
            items:

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

          required: false

        - $ref: '#/components/parameters/Query.format.entities'

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

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

        - $ref: '#/components/parameters/Query.lang'
@@ -1874,6 +1877,7 @@ paths: 
        - $ref: '#/components/parameters/Query.limit'

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

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

        - $ref: '#/components/parameters/Query.format.temporal'

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

        # Local Query param

        - $ref: '#/components/parameters/Query.local'
@@ -1945,6 +1949,7 @@ paths: 
        - $ref: '#/components/parameters/Query.aggrPeriodDuration'

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

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

        - $ref: '#/components/parameters/Query.format.temporal'

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

        # Local Query param

        - $ref: '#/components/parameters/Query.local'
@@ -3146,6 +3151,21 @@ components: 
      schema:

        type: boolean

      required: false

    Query.format.entities:

      name: format

      in: query

      style: form

      explode: false

      schema:

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

    Query.format.temporal:

      name: format

      in: query

      style: form

      explode: false

      schema:

        $ref: '#/components/schemas/format.temporal'

      required: false

    Query.id:

      name: id

      in: query
@@ -3625,6 +3645,8 @@ components: 
      description: |

        6.3.7 Representation of Entities. 



        An alternative mechanism to include the format parameter. DEPRECATED.

        

        When its value includes the keyword "normalized", a normalized

        representation of Entities shall be provided as defined by clause 4.5.1, with Attributes returned

        in the normalized representation as defined in clauses 4.5.2.2, 4.5.3.2 and 4.5.18.2.
@@ -3660,6 +3682,9 @@ components: 
      description: |

        6.3.12 Simplified or aggregated temporal representation of entities.



        An alternative mechanism to include the format parameter. DEPRECATED.

        If both format and options are present, the value of the format parameter shall take precedence.



        When its value includes the keyword "temporalValues", a simplified temporal representation of

        entities shall be provided as defined by clause 4.5.8.
@@ -3687,6 +3712,51 @@ components: 
    # End of Options parameters

    ###

    ###

    # Beginning of Format parameters

    #

    format.representation:

      description: |

        6.3.7 Representation of Entities. 

        

        When its value includes the keyword "normalized", a normalized

        representation of Entities shall be provided as defined by clause 4.5.1, with Attributes returned

        in the normalized representation as defined in clauses 4.5.2.2, 4.5.3.2 and 4.5.18.2.



        When its value includes the keyword "concise", a concise lossless representation of Entities shall

        be provided as defined by clause 4.5.1. with Attributes returned in the concise representation as

        defined in clauses 4.5.2.3, 4.5.3.3 and 4.5.18.3. In this case the broker will return data in the

        most concise lossless representation possible, for example removing all Attribute "type" members.



        When its value includes the keyword "keyValues" (or "simplified" as a synonym), a simplified

        representation of Entities shall be provided as defined by clause 4.5.4.



        If the Accept Header is set to "application/geo+json" the response will be in simplified GeoJSON

        format as defined by clause 4.5.17.

      type: string

      enum:

        - normalized

        - concise

        - keyValues

        - simplified

    format.temporal:

      description: |

        6.3.12 Simplified or aggregated temporal representation of entities.



        When its value includes the keyword "temporalValues", a simplified temporal representation of

        entities shall be provided as defined by clause 4.5.8.



        When its value includes the keyword "aggregatedValues", an aggregated temporal representation of

        entities shall be provided as defined by clause 4.5.19.



        Only one of the two keywords can be present in the values of the parameter.

      type: string

      enum:

        - temporalValues

        - aggregatedValues

    #

    # End of Format parameters

    ###

    ###

    #

    # Beginning of 4.8 Temporal Properties

    #