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

Removing or changing x-camara-commonalities extension field #327

Open
rartych opened this issue Oct 25, 2024 · 0 comments
Open

Removing or changing x-camara-commonalities extension field #327

rartych opened this issue Oct 25, 2024 · 0 comments
Labels
correction correction in documentation

Comments

@rartych
Copy link
Collaborator

rartych commented Oct 25, 2024

Problem description
x-camara-commonalities field was introduced to info object in version 0.4, but it occurs that it is hard to maintain esp. when Commonalities produce patch release.

Expected behavior
Remove x-camara-commonalities field from info object definition in API Design Guidelines.
Release notes and Changelog include reference to the Commonalities release available when API is published.
Additionally, the same information can be mentioned in API Readiness Checklist point 2

Alternative solution
Indicate only Commonalities release major number (r1) or version without patch (0.5).

Additional context

The issue was raised during TSC meeting.

@rartych rartych added the correction correction in documentation label Oct 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
correction correction in documentation
Projects
None yet
Development

No branches or pull requests

1 participant