Skip to content

Not Documented Error Responses info.description section#457

Merged
rartych merged 12 commits intocamaraproject:mainfrom
PedroDiez:not_documented_error_responses_reference_in_api_spec
Jun 10, 2025
Merged

Not Documented Error Responses info.description section#457
rartych merged 12 commits intocamaraproject:mainfrom
PedroDiez:not_documented_error_responses_reference_in_api_spec

Conversation

@PedroDiez
Copy link
Contributor

What type of PR is this?

  • documentation

What this PR does / why we need it:

As commented in #438, not all CAMARA errors are documented in the API specifications.
This may be confusing for CAMARA community in a wide sense, in order to have a reference for errors that the implementation can support.

A new section in info.description of CAMARA API specification is proposed, following the defined template in this PR

Which issue(s) this PR fixes:

Fixes #438

Does this PR introduce a breaking change?

  • Yes
  • No

Special notes for reviewers:

Changelog input

 Adding a section in API info.description to provide reference for not documented Error responses

Additional documentation

N/A

@PedroDiez PedroDiez added documentation Improvements or additions to documentation Fall25 labels May 5, 2025
@PedroDiez PedroDiez requested review from Kevsy and eric-murray May 5, 2025 21:23
patrice-conil
patrice-conil previously approved these changes May 12, 2025
Copy link
Contributor

@patrice-conil patrice-conil left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Kevsy
Copy link
Collaborator

Kevsy commented May 12, 2025

Very minor typos suggested above, otherwise LGTM

Co-authored-by: Kevin Smith <Kevsy@users.noreply.github.com>
PedroDiez and others added 2 commits May 12, 2025 15:58
Co-authored-by: Kevin Smith <Kevsy@users.noreply.github.com>
Co-authored-by: Kevin Smith <Kevsy@users.noreply.github.com>
@PedroDiez PedroDiez requested review from Kevsy and patrice-conil May 12, 2025 13:58
patrice-conil
patrice-conil previously approved these changes May 15, 2025
Copy link
Contributor

@patrice-conil patrice-conil left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Co-authored-by: Kevin Smith <Kevsy@users.noreply.github.com>
Copy link
Contributor

@patrice-conil patrice-conil left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@rartych rartych left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@rartych rartych merged commit 9c08ef2 into camaraproject:main Jun 10, 2025
1 check passed
Kevsy added a commit to camaraproject/SimpleEdgeDiscovery that referenced this pull request Jun 11, 2025
Now updated to latest Commonalities template per /camaraproject/Commonalities/pull/457
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation Fall25

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Adding a section in API info.description to provide rationale for not documented Error responses and a reference for their format

5 participants