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

For schemas definitions with to other schemas that include additional sibling... 

For schemas definitions with  to other schemas that include additional sibling descriptions, wrapping the  into allOf.
parent 84f61ff4

ngsi-ld-api.yaml

+65 −34
Original line number Diff line number Diff line
@@ -3187,8 +3187,9 @@ components: 
      content:

        application/json:

          schema:

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

            required:

            allOf:

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

              - required:

                - id

                - type

        application/json+ld:
@@ -3492,7 +3493,8 @@ components: 
        error:

          description: |

            One instance per Entity in error.

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

          allOf:

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

      required:

        - entityId

        - error
@@ -3630,7 +3632,8 @@ components: 
            Entity information as specified by the observedAt Temporal Property.

            A temporal query based on the observedAt Temporal Property, which is the default,

            is matched against the observationInterval for overlap.

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

          allOf:

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

        managementInterval:

          description: |

            If present, the Context Source can be queried for Temporal Entity Representations. (If latest Entity
@@ -3639,23 +3642,27 @@ components: 
            information as specified by the createdAt, modifiedAt and deletedAt Temporal Properties.

            A temporal query based on the createdAt, modifiedAt or deletedAt Temporal Property is matched

            against the managementInterval for overlap.

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

          allOf:

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

        location:

          description: |

            Location for which the Context Source may be able to provide information.

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

          allOf:

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

        observationSpace:

          description: |

            Geographic location that includes the observation spaces of all entities as specified by their 

            respective observationSpace GeoProperty for which the Context Source may be able to provide 

            information.

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

          allOf:

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

        operationSpace:

          description: |

            Geographic location that includes the operation spaces of all entities as specified by their 

            respective operationSpace GeoProperty for which the Context Source may be able to provide 

            information.

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

          allOf:

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

        expiresAt:

          description: |

            Provides an expiration date. When passed the Context Source Registration
@@ -3710,7 +3717,8 @@ components: 
          description: |

            Holds additional optional registration management information that can be used

            to limit unnecessary distributed operation requests.

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

          allOf:

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

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

        systemGeneratedAttrs:

          allOf:
@@ -3843,15 +3851,18 @@ components: 
        location:

          description: |

            Default geospatial Property of an entity. See clause 4.7.

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

          allOf:

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

        observationSpace:

          description: |

            See clause 4.7.

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

          allOf:

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

        operationSpace:

          description: |

            See clause 4.7.

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

          allOf:

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

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

        systemGeneratedAttrs:

          allOf:
@@ -3959,15 +3970,18 @@ components: 
        location:

          description: |

            Default geospatial Property of an entity. See clause 4.7.

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

          allOf:

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

        observationSpace:

          description: |

            See clause 4.7.

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

          allOf:

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

        operationSpace:

          description: |

            See clause 4.7.

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

          allOf:

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

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

        systemGeneratedAttrs:

          allOf:
@@ -4104,16 +4118,19 @@ components: 
        geometry:

          description: |

            Null if no matching GeoProperty.

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

          allOf:

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

        properties:

          description: |

            List of attributes as mandated by clause 5.2.31.

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

          allOf:

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

        '@context':

          description: |

            JSON-LD @context. This field is only present if requested in the payload by

            the HTTP Prefer Header (IETF RFC 7240).

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

          allOf:

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

      required:

        - id

        - type
@@ -4141,7 +4158,8 @@ components: 
          description: |

            JSON-LD @context. This field is only present if requested in the payload

            by the HTTP Prefer Header (IETF RFC 7240).

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

          allOf:

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

      required:

        - type

    FeatureProperties:
@@ -4301,11 +4319,13 @@ components: 
        value:

          description: |

            Geolocation encoded as GeoJSON. As mandated by clause 4.7.

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

          allOf:

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

        observedAt:

          description: |

            Timestamp. See clause 4.8.

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

          allOf:

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

        datasetId:

          description: |

            It allows identifying a set or group of property values.
@@ -4326,7 +4346,8 @@ components: 
          description: |

            Previous GeoProperty value. Only used in notifications, if the showChanges 

            option is explicitly requested.

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

          allOf:

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

          readOnly: true

      additionalProperties:

        oneOf:
@@ -4406,7 +4427,8 @@ components: 
        observedAt:

          description: |

            Timestamp. See clause 4.8.

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

          allOf:

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

        datasetId:

          description: |

            It allows identifying a set or group of property values.
@@ -4602,7 +4624,8 @@ components: 
        endpoint:

          description: |

            Notification endpoint details.

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

          allOf:

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

        status:

          description: |

            Status of the Notification. It shall be "ok" if the last attempt to notify the subscriber succeeded.
@@ -4731,7 +4754,8 @@ components: 
        observedAt:

          description: |

            Timestamp. See clause 4.8.

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

          allOf:

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

        unitCode:

          description: |

            Property Value's unit code.
@@ -4805,7 +4829,8 @@ components: 
        geoQ:

          description: |

            Geoquery that shall be matched by Entities in order be retrieved.

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

          allOf:

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

        csf:

          description: |

            Context source filter that shall be matched by Context Source Registrations describing
@@ -4834,7 +4859,8 @@ components: 
            temporalQ:

              description: |

                Temporal Query to be present only for "Query Temporal Evolution of Entities" operation (clause 5.7.4).

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

              allOf:

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

        - required:

          - temporalQ

    RegistrationInfo:
@@ -4914,7 +4940,8 @@ components: 
        observedAt:

          description: |

            Timestamp. See clause 4.8.

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

          allOf:

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

        datasetId:

          description: |

            It allows identifying a set or group of target relationship objects.
@@ -5005,7 +5032,8 @@ components: 
        geoQ:

          description: |

            Geoquery that shall be met by subscribed entities in order to trigger the notification.

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

          allOf:

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

        csf:

          description: |

            Context source filter that shall be met by Context Source Registrations describing Context Sources
@@ -5021,7 +5049,8 @@ components: 
        notification:

          description: |

            Notification details.

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

          allOf:

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

        expiresAt:

          description: |

            Expiration date for the subscription.
@@ -5031,7 +5060,8 @@ components: 
          description: |

            Temporal Query to be used only in Context Registration Subscriptions for matching

            Context Source Registrations of Context Sources providing temporal information.

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

          allOf:

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

        scopeQ:

          description: |

            Scope query.
@@ -5197,7 +5227,8 @@ components: 
        observedAt:

          description: |

            Timestamp. See clause 4.8.

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

          allOf:

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

        datasetId:

          description: |

            It allows identifying a set or group of property values.