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

Including description for sysAttrs options parameter.

parent 0d47419e

ngsi-ld-api.yaml

+10 −2
Original line number Diff line number Diff line
@@ -3319,7 +3319,9 @@ components: 
        - noOverwrite

    options.representation:

      description: |

        6.3.7 Representation of Entities. When its value includes the keyword "normalized", a normalized

        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.
@@ -3340,7 +3342,13 @@ components: 
        - keyValues

        - simplified

    options.sysAttrs:

      description: 6.3.11 Including system generated attributes.

      description: | 

        6.3.11 Including system generated attributes.



        When its value includes the keyword "sysAttrs", a representation of NGSI-LD Elements shall be 

        provided so that the system generated attributes createdAt, modifiedAt are included in the response 

        payload body. In the case of temporal representations, also the system generated attribute deletedAt 

        is included, if the NGSI-LD Element has been deleted.

      type: string

      enum:

        - sysAttrs