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

Minor changes needed in API-design-guidelines.md for CloudEvents #86

Merged
merged 5 commits into from
Nov 29, 2023

Conversation

rartych
Copy link
Collaborator

@rartych rartych commented Nov 6, 2023

What type of PR is this?

  • correction

What this PR does / why we need it:

Certain minor points have been identified within the design guidelines that need to be changed for the CloudEvents content.
Some editorial changes for better readability added.

Which issue(s) this PR fixes:

Fixes #83

Special notes for reviewers:

Changelog input

Corrections for Event subscriptions and CloudEvents notifications implemented

Copy link
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.

Look good for me
Thanks !

patrice-conil
patrice-conil previously approved these changes Nov 7, 2023
Copy link
Collaborator

@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
Collaborator

@shilpa-padgaonkar shilpa-padgaonkar left a comment

Choose a reason for hiding this comment

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

/LGTM

editorial - remove 's' from subscriptionId
Copy link
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.

@rartych as discussed today 3 sentences proposal for the subscription operation table. I was not able to edit the PR but just comment.

Seems that our discussion was aligned with @PedroDiez thought.

documentation/API-design-guidelines.md Outdated Show resolved Hide resolved
documentation/API-design-guidelines.md Outdated Show resolved Hide resolved
documentation/API-design-guidelines.md Outdated Show resolved Hide resolved
Notes about status codes for operations on subscriptions (SYNC/ASYNC) added.
@rartych
Copy link
Collaborator Author

rartych commented Nov 15, 2023

@bigludo7 Proposed sentences added with 8bcb964

@rartych
Copy link
Collaborator Author

rartych commented Nov 15, 2023

@RubenBG7 @jordonezlucena Please review this PR as code owners.

CloudEvents version (1.0.2) explicitly indicated
Editorial correction in subsection title in 3.1
Copy link
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

Copy link
Collaborator

@jordonezlucena jordonezlucena 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
Collaborator

@shilpa-padgaonkar shilpa-padgaonkar 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 f5ac68e into main Nov 29, 2023
@rartych rartych deleted the rartych-patch-3 branch December 7, 2023 11:41
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.

Consolidation of minor changes needed in design guidelines for CloudEvents content
6 participants