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

Updating NotificationParams schema, including the pick, omit, join, and... 

Updating NotificationParams schema, including the pick, omit, join, and joinLevel properties, and updating the description of the attributes property (deprecated). In addition, specifying the readOnly=true option for the output properties.
parent 07da81a6

ngsi-ld-api.yaml

+41 −0
Original line number Diff line number Diff line
@@ -4708,6 +4708,7 @@ components: 
          description: |

            Entity Attribute Names (Properties or Relationships) to be included in the notification payload body.

            If undefined it will mean all Attributes.

            DEPRECATED: A synonym for a combination of the pick and q parameter.

          type: array

          items:

            type: string
@@ -4727,6 +4728,25 @@ components: 
            - normalized

            - concise

            - keyValues

        pick:

          description: |

            When defined, every Entity within payload body is reduced down to only contain 

            the specified Entity members.

            Entity member ("id", "type", "scope" or a projected Attribute name) as a valid 

            attribute projection language string as per clause 4.21).

          type: array

          items:

            type: string

          minItems: 1

        omit:

          description: |

            When defined, the specified Entity members are removed from each Entity within 

            the payload. Entity member ("id", "type", "scope" or a projected Attribute name) 

            as a valid attribute projection language string as per clause 4.21).

          type: array

          items:

            type: string

          minItems: 1

        showChanges:

          description: |

            If true the previous value (previousValue) of Properties or languageMap (previousLanguageMap) of
@@ -4735,6 +4755,21 @@ components: 
             but not in the case of creations. showChanges cannot be true in case format is "keyValues".

          type: boolean

          default: false

        join:

          description: |

            String representing the type of Linked Entity retrieval to apply.

          type: string

          enum:

            - "flat"

            - "inline"

            - "@none"

          default: "@none"

        joinLevel:

          description: |

            Depth of Linked Entity retrieval to apply. Only applicable if join parameter is "flat" or "inline".

          type: number

          minimum: 1

          default: 1

        endpoint:

          description: |

            Notification endpoint details.
@@ -4747,24 +4782,28 @@ components: 
          enum:

            - ok

            - failed

          readOnly: true

        timesSent:

          description: |

            Number of times that the notification has been sent. Provided by the system when

            querying the details of a subscription.

          type: number

          minimum: 1

          readOnly: true

        timesFailed:

          description: |

            Number of times an unsuccessful response (or timeout) has been received when deliverying the notification.

            Provided by the system when querying the details of a subscription.

          type: number

          minimum: 1

          readOnly: true

        lastNotification:

          description: |

            Timestamp corresponding to the instant when the last notification has been sent.

            Provided by the system when querying the details of a subscription.

          type: string

          format: date-time

          readOnly: true

        lastFailure:

          description: |

            Timestamp corresponding to the instant when the last notification resulting in failure
@@ -4772,12 +4811,14 @@ components: 
            Provided by the system when querying the details of a subscription.

          type: string

          format: date-time

          readOnly: true

        lastSuccess:

          description: |

            Timestamp corresponding to the instant when the last successful (200 OK response) notification

            has been sent. Provided by the system when querying the details of a subscription.

          type: string

          format: date-time

          readOnly: true

      required:

        - endpoint

    Path: