Skip to content

Change the event notification sink format from url to uri as well in the Subscription definition. #269

@dfischer-tech

Description

@dfischer-tech

Problem description
In one of the previous pull requests, a similar sink format adjustment was already made for the "SubscriptionRequest" definition.
I recommend applying the same adjustment to the "Subscription" definition as well. API-design-guidelines

    Subscription:
      description: Represents a event-type subscription.
      type: object
      required:
        - sink
        - protocol
        - config
        - types
        - id
      properties:
        protocol:
          $ref: "#/components/schemas/Protocol"
        sink:
          type: string
          format: url
          description: The address to which events shall be delivered using the selected protocol.
          example: "https://endpoint.example.com/sink"
        types:

Expected behavior

    Subscription:
      description: Represents a event-type subscription.
      type: object
      required:
        - sink
        - protocol
        - config
        - types
        - id
      properties:
        protocol:
          $ref: "#/components/schemas/Protocol"
        sink:
          type: string
          format: uri
          description: The address to which events shall be delivered using the selected protocol.
          example: "https://endpoint.example.com/sink"
        types:

Affected specifications:

  • connected-network-type-subscriptions.yaml
  • device-reachability-status-subscriptions.yaml
  • device-roaming-status-subscriptions.yaml

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions