Consistency between cloudevent and CAMARA API guidelines

[tanjadegroot]

Problem description
Concerns the artefact: Commonalities/artifacts/notification-as-cloud-event.yaml

Discuss to align ti the above event artefact with the CAMARA API guidelines for at least the points described below.

the artefact: https://github.com/camaraproject/Commonalities/blob/main/artifacts/camara-cloudevents/event-subscription-template.yaml already applies most (but not all) of the below, so can be chacked as well.

Expected action

Consider the following changes to the artefact:

info object:

• line 19: remove termsOfService field
• lines 40-41: remove contact field
• should we add under the version field: x-camara-commonalities: 0.5 ?

externalDocs object:

• line 48: url field: add either Commonalities or a repository placeholder "

in line 107 in below structure, should the type not be https ?
components:
securitySchemes:
notificationsBearerAuth:
type: http
scheme: bearer
bearerFormat: "{$request.body#/sinkCredential.credentialType}"

[rartych]

info object:
* line 19: remove termsOfService field
* lines 40-41: remove contact field
* should we add under the version field: x-camara-commonalities: 0.5 ?
externalDocs object:

* line 48: url field: add either Commonalities or a repository placeholder "

notification-as-cloud-event.yaml is just the example how to process notifications - in API Design Guidelines it is called "generic neutral CloudEvent notification OpenAPI specification"

We have discussion if it should be fully conformant with API Design Guidelines:
#382

On the other hand requiring CAMARA error format and error semantics on the sink side should improve interoperability with different notification consumers.

As the discussion result is not impacting API definitions it can be concluded after meta-release.

in line 107 in below structure, should the type not be https ? components: securitySchemes: notificationsBearerAuth: type: http scheme: bearer bearerFormat: "{$request.body#/sinkCredential.credentialType}"

The type is http:
https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-scheme-object

event-subscription-template.yaml was updated lately with #409 #407 but should be doublechecked.