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

Adding a new schema named VocabularyProperty for the new data type considered... 

Adding a new schema named VocabularyProperty for the new data type considered in the clause 5.2.35 VocabularyProperty of ETSI GS CIM 009 V1.7.1.
parent 5bb0413e

ngsi-ld-api.yaml

+67 −0
Original line number Diff line number Diff line
@@ -3888,6 +3888,10 @@ components: 
          - type: array

            items:

              $ref: '#/components/schemas/LanguageProperty'

          - $ref: '#/components/schemas/VocabularyProperty'

          - type: array

            items:

              $ref: '#/components/schemas/VocabularyProperty'

    EntityInfo:

      description: |

        5.2.8 This type represents what Entities, Entity Types or group of Entity ids
@@ -3996,6 +4000,9 @@ components: 
          - type: array

            items:

              $ref: '#/components/schemas/LanguageProperty'

          - type: array

            items:

              $ref: '#/components/schemas/VocabularyProperty'

    EntityType:

      description: |

        5.2.25 This type represents the data needed to define the elements of the detailed
@@ -5158,6 +5165,66 @@ components: 
      required:

        - updated

        - notUpdated

    VocabularyProperty:

      description: |

        5.2.35 NGSI-LD VocabularyProperty.

      type: object

      properties:

        type:

          description: |

            Node type.

          type: string

          enum:

            - VocabularyProperty

          default: VocabularyProperty

        vocab:

          description: |

            String Values which shall be type coerced to URIs based on the supplied @context.

          oneOf:

            - type: string

            - type: array

              items:

                type: string

        previousVocab:

          description: |

            Previous Vocabulary Property vocab. Only used in notifications, if the showChanges 

            option is explicitly requested.

          oneOf:

            - type: string

            - type: array

              items:

                type: string

          readOnly: true

        observedAt:

          description: |

            Timestamp. See clause 4.8.

          $ref: '#/components/schemas/ObservedAt'

        datasetId:

          description: |

            It allows identifying a set or group of property values.

          type: string

          format: uri

        # Clause 5.2.2 Common members. System-generated temporal attributes.

        systemGeneratedAttrs:

          allOf:

            - $ref: '#/components/schemas/SystemGeneratedAttributes'

        instanceId:

          description: |

            A URI uniquely identifying a Property instance,

            as mandated by (see clause 4.5.7). System generated.

          type: string

          format: uri

          readOnly: true

      additionalProperties:

        oneOf:

          - $ref: '#/components/schemas/Property'

          - type: array

            items:

              $ref: '#/components/schemas/Property'

          - $ref: '#/components/schemas/Relationship'

          - type: array

            items:

              $ref: '#/components/schemas/Relationship'



  responses:

    BadRequest: