Skip to content

Commit 87ce48b

Browse files
committed
Clarification of the protocol and sink properties in the subscription data model.
1 parent a4edbde commit 87ce48b

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

documentation/API-design-guidelines.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1759,8 +1759,8 @@ The following table provides `/subscriptions` attributes
17591759
17601760
| name | type | attribute description | cardinality |
17611761
|----------------|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|
1762-
| protocol | string | Identifier of a delivery protocol. **Only** `HTTP` **is allowed for now**. | Mandatory |
1763-
| sink | string | The address to which events shall be delivered, using the HTTP protocol. | mandatory |
1762+
| protocol | string | Identifier of a delivery protocol for the event notifications. The values follow the definitions of the [CloudEvent specification](https://github.com/cloudevents/spec/blob/main/subscriptions/spec.md#protocol). **Only** `HTTP` **is allowed for now**. | mandatory |
1763+
| sink | string | The URL, to which event notifications shall be sent. The URI-scheme shall be set according to the definition of the `protocol` value, e.g. the URI-scheme is `https` when `HTTP`is the value of the `protocol` property. The [security considerations](#correlation-management) should be followed. | mandatory |
17641764
| sinkCredential | object | Sink credential provides authorization information necessary to enable delivery of events to a target. In order to be updated in future this object is polymorphic. See detail below. To protect the notification endpoint providing sinkCredential is RECOMMENDED. <br> The sinkCredential must **not** be present in `POST` and `GET` responses. | optional |
17651765
| types | string | 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 |
17661766
| config | object | Implementation-specific configuration parameters needed by the subscription manager for acquiring events. In CAMARA we have predefined attributes like ``subscriptionExpireTime``, ``subscriptionMaxEvents`` or ``initialEvent``. See detail below. | mandatory |

0 commit comments

Comments
 (0)