Skip to content

Arrays of types (SubscriptionEventType) are still restricted to one within CAMARA-API-Event-Subscription-and-Notification-Guide.md? #460

@hdamker

Description

@hdamker

Problem description

I understood from #432 that APIs can now decide to allow to pass more than one SubscriptionEventType within a subscription request. But the following line

| types | SubscriptionEventType | Type of event subscribed. This attribute **must** be present in the `POST` request. It is required by API project to provide an enum for this attribute. `type` must follow the format: `org.camaraproject.<api-name>.<api-version>.<event-name>` with the `api-version` with letter `v` and the major version like ``org.camaraproject.device-roaming-subscriptions.v1.roaming-status`` - Note: An array of types could be passed **but as of now only one value MUST passed**. Use of multiple value will be open later at API level. | mandatory |

still states that it MUST be only one, and the use of multiple values will be open only "later" at API level:

Note: An array of types could be passed but as of now only one value MUST passed. Use of multiple value will be open later at API level.

Expected behavior

The current formulation is at least ambiguous and might be better aligned with the template which states "Note: the maximum number of event types per subscription will be decided at API project level".

Alternative solution

Additional context

Metadata

Metadata

Assignees

Labels

correctioncorrection in documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions