Skip to content

sim-swap-subscriptions description not updated for 0.4.0 #286

Description

@hdamker

Problem description

info.description in code/API_definitions/sim-swap-subscriptions.yaml was not updated for 0.4.0 and doesn't mention:

  • pagination on GET /subscriptions (page/perPage, headers, SubscriptionList response)
  • PRIVATE_KEY_JWT sink credential support
  • the restructured notification event hierarchy (NotificationEvent)
  • Protocol now limited to HTTP

It also still carries this sentence, garbled since 0.3.0:

It is mandatory in the subscription to provide the event types subscribed are several are managed in this API.

Expected action

  • Document pagination, PRIVATE_KEY_JWT, and the current notification event structure.
  • Rewrite the garbled sentence — intent appears to be that types must be provided because this API manages more than one event type; please confirm.

Additional context

API Documentation is mandatory at rc. Raised during Release Management review of the r4.1 rc snapshot (#283).

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions