Skip to content

Align notification template with CAMARA lint rules - #679

Merged
rartych merged 2 commits into
camaraproject:mainfrom
LarryHu0217:codex/fix-notification-template-677
Jul 21, 2026
Merged

Align notification template with CAMARA lint rules#679
rartych merged 2 commits into
camaraproject:mainfrom
LarryHu0217:codex/fix-notification-template-677

Conversation

@LarryHu0217

@LarryHu0217 LarryHu0217 commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

What type of PR is this?

  • correction

What this PR does / why we need it:

Aligns sample-notification.yaml with the notification sink semantics described in #677:

  • renames the notification server variable from apiRoot to sinkRoot
  • sets its default to https://endpoint.example.com, matching the Sink example
  • retains the consumer-oriented notification server description
  • documents notificationsBearerAuth so the security scheme passes the r4 Spectral description rule

Which issue(s) this PR fixes:

Fixes #677

Does this PR introduce a breaking change?

  • Yes
  • No

Special notes for reviewers:

This PR depends on #673, which introduces the Artifacts Lint workflow. I validated the combined #673 + this PR state locally with the same v1-rc tooling pins:

  • yamllint over artifacts/: pass
  • Spectral over API and notification templates: 0 errors, 18 existing warnings, and 0 hints
  • targeted Spectral validation for sample-notification.yaml: no issue-specific findings
  • gplint: 0 errors; its existing formatting warnings are addressed separately by Normalize artifact line endings and Gherkin formatting #678
  • git diff --check: pass

Changelog input

 release-note
- Model the notification template server as a consumer-provided sink and document bearer authentication

Additional documentation

This section can be blank.

docs

@hdamker

hdamker commented Jul 17, 2026

Copy link
Copy Markdown
Collaborator

@LarryHu0217 thanks for picking this up — and apologies first: the description of #677 was accidentally empty when you started (fixed now), so you could only work from the title. You resolved the findings in a perfectly reasonable way given that.

With the full description in place, the intended resolution for the apiRoot part goes in the other direction: the server in this template is the API consumer's notification endpoint — the root part of the subscription's sink — not a CAMARA API root. So instead of conforming to the apiRoot rules, the variable gets renamed (apiRootsinkRoot), with default https://endpoint.example.com (aligned with the Sink schema example in CAMARA_event_common.yaml) and the existing consumer-oriented description kept. The apiRoot rules then no longer apply to this file at all.

Your notificationsBearerAuth description change fits the issue exactly and can stay as it is.

Would you like to rework the PR along these lines? Happy to review quickly. One heads-up: once #673 merges, sample-notification.yaml also changes there (webhook path placeholder becomes kebab-case), so a rebase will be needed — and the new Artifacts Lint check will then run on this PR, too.

@hdamker hdamker left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM now.

Note for reviewers: the change helps also to avoid that the same rules as for the API's {apiRoot} are applied by Validation.

@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

@bigludo7 bigludo7 left a comment

Copy link
Copy Markdown
Collaborator

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

@rartych
rartych merged commit 7e2869d into camaraproject:main Jul 21, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

sample-notification.yaml: security scheme description and apiRoot rule mismatch

5 participants