Skip to content

Fix stale API Readiness Checklist pointer in mandatory error-response template - #693

Open
hdamker wants to merge 1 commit into
camaraproject:mainfrom
hdamker:fix/error-response-template-stale-readiness-pointer
Open

Fix stale API Readiness Checklist pointer in mandatory error-response template#693
hdamker wants to merge 1 commit into
camaraproject:mainfrom
hdamker:fix/error-response-template-stale-readiness-pointer

Conversation

@hdamker

@hdamker hdamker commented Aug 4, 2026

Copy link
Copy Markdown
Collaborator

What type of PR is this?

  • correction

What this PR does / why we need it:

Repoints the mandatory additional-error-responses info.description template's second sentence — which named the retired per-API API Readiness Checklist document — at sources that exist on every current release: the x-camara-commonalities field, the changelog, and the release metadata.

Updated in all 5 locations carrying the sentence verbatim:

  • documentation/CAMARA-API-Design-Guide.md §3.2.3
  • artifacts/common/info-description-templates.yaml
  • artifacts/api-templates/sample-service.yaml
  • artifacts/api-templates/sample-implicit-events.yaml
  • artifacts/api-templates/sample-service-subscriptions.yaml

Which issue(s) this PR fixes:

Fixes #692

Does this PR introduce a breaking change?

  • Yes
  • No

Special notes for reviewers:

Wording open for discussion — happy to adjust before merge.

Changelog input

Fixed stale API Readiness Checklist reference in the mandatory error-response info.description template

Additional documentation

This section can be blank.

@hdamker hdamker self-assigned this Aug 4, 2026
@hdamker hdamker added the correction correction in documentation label Aug 4, 2026

@PedroDiez PedroDiez left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@rartych rartych left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

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

Successfully merging this pull request may close these issues.

Mandatory error-response template points at a retired API Readiness Checklist document

4 participants