Skip to content

Align Common Design Model for Cloud Event specversion field in APIs Design #176

@PedroDiez

Description

@PedroDiez

Problem description
It has been detected a misaligment regarding the design format used to reflect specversion field in API that manage notifications.

Some of them settle specversion as en enum:
https://github.com/camaraproject/QualityOnDemand/blob/main/code/API_definitions/qod-api.yaml#L872
https://github.com/camaraproject/DeviceLocation/blob/main/code/API_definitions/geofencing.yaml#L614

While others leave as an open string (which should be filled to "1.0")
https://github.com/camaraproject/DeviceStatus/blob/main/code/API_definitions/device-status.yaml#L725
https://github.com/camaraproject/CarrierBillingCheckOut/blob/main/code/API_definitions/carrier_billing.yaml#L1040

Expected behavior
We at CAMARA should decide in a common design model across every APIs that manage notifications so as no doubts how to model this field in every API

Alternative solution
N/A

Additional context

Considering Design Guidelines https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md#122-event-notification.

It is indicated the following:

version of the specification to which this event conforms - must be "1.0"

Based on the decision, it would be needed to update:

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions