Skip to content

Sink format corrected and indicated in API Design Guidelines#414

Merged
rartych merged 4 commits intocamaraproject:mainfrom
rartych:sink_format
Feb 18, 2025
Merged

Sink format corrected and indicated in API Design Guidelines#414
rartych merged 4 commits intocamaraproject:mainfrom
rartych:sink_format

Conversation

@rartych
Copy link
Copy Markdown
Contributor

@rartych rartych commented Feb 10, 2025

What type of PR is this?

  • correction

What this PR does / why we need it:

Correction in event subscription template to format sink string as URI as defined in Cloudevents Subscriptions specification
The required string format added to sink definitions in API Design Guidelines.

Which issue(s) this PR fixes:

Fixes #391

Does this PR introduce a breaking change?

  • Yes
  • No

The url format used in the event subscription template was non-standard, but imposed similar restrictions.

Special notes for reviewers:

Requirements for uri-reference or uri format for parameters containing URL can be added to https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md#115-data-definitions

Changelog input

Sink format corrected and indicated in API Design Guidelines

Additional documentation

Copy link
Copy Markdown
Contributor

@PedroDiez PedroDiez 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
Copy Markdown
Collaborator

@bigludo7 bigludo7 left a comment

Choose a reason for hiding this comment

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

LGTM
On behalf of @patrice-conil for Orange

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Allowed characters in URLs transported in the body of an API call.

4 participants