Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update event-subscription-template.yaml: Attribute startsAt set optional, info and servers object, sinkCredential description #267

Merged
merged 3 commits into from
Aug 7, 2024
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 6 additions & 9 deletions artifacts/camara-cloudevents/event-subscription-template.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,17 @@ info:

Note on ``security`` - ``openId`` scope: The value in this yaml `api-name:event-type:grant-level` must be replaced accordingly to the format defined in the guideline document.

termsOfService: https://swagger.io/terms/
contact:
email: project-email@sample.com
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
version: 0.1.0-wip
version: 0.1.0
x-camara-commonalities: 0.4.0

externalDocs:
description: Product documentation at CAMARA
url: https://github.com/camaraproject/
servers:
- url: "{apiRoot}/{apiName}/v0"
- url: "{apiRoot}/{apiName}/v0.1"
variables:
apiRoot:
default: http://localhost:9091
Expand Down Expand Up @@ -298,9 +297,7 @@ components:
description: The address to which events shall be delivered using the selected protocol.
example: "https://endpoint.example.com/sink"
sinkCredential:
allOf:
- description: A sink credential provides authentication or authorization information necessary to enable delivery of events to a target.
- $ref: "#/components/schemas/SinkCredential"
$ref: "#/components/schemas/SinkCredential"
types:
description: |
Camara Event types eligible to be delivered by this subscription.
Expand Down Expand Up @@ -359,6 +356,7 @@ components:
Up to API project decision to keep it.

SinkCredential:
description: A sink credential provides authentication or authorization information necessary to enable delivery of events to a target.
type: object
properties:
credentialType:
Expand Down Expand Up @@ -471,7 +469,6 @@ components:
- config
- types
- id
- startsAt
properties:
protocol:
$ref: "#/components/schemas/Protocol"
Expand Down