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.

Sign up for GitHub

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

Change guidelines on x-camara-commonalities extension field #375

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+5 −5
Open

Change guidelines on x-camara-commonalities extension field #375

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
89695f4
Update API-design-guidelines.md
rartych Jan 13, 2025
b44c891
Update CAMARA_common.yaml
rartych Jan 13, 2025
b2cdf78
Update event-subscription-template.yaml
rartych Jan 13, 2025
cc4f677
Update API-design-guidelines.md
rartych Jan 13, 2025
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
2 changes: 1 addition & 1 deletion artifacts/CAMARA_common.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ info:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
version: 0.6.0-alpha.1
x-camara-commonalities: 0.5.0
x-camara-commonalities: 0.5

paths: {}
components:
Expand Down
2 changes: 1 addition & 1 deletion artifacts/camara-cloudevents/event-subscription-template.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ info:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
version: 0.2.0-alpha.1
x-camara-commonalities: 0.5.0
x-camara-commonalities: 0.5

externalDocs:
description: Product documentation at CAMARA
Expand Down
6 changes: 3 additions & 3 deletions documentation/API-design-guidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1325,13 +1325,13 @@ info:
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
# CAMARA Commonalities version - x.y.z
x-camara-commonalities: 0.4.0
# CAMARA Commonalities minor version - x.y
x-camara-commonalities: 0.5
```

The `termsOfService` and `contact` fields are optional in OpenAPI specification and may be added by API Providers documenting their APIs.

The extension field `x-camara-commonalities` indicates a version of CAMARA Commonalities guidelines that given API specification adheres to.
The extension field `x-camara-commonalities` indicates a minor version of CAMARA Commonalities guidelines that given API specification adheres to.


#### Servers object
Expand Down