camaraproject / Commonalities

Repository to describe, develop, document and test the common guidelines and assets for CAMARA APIs
Apache License 2.0
9 stars 24 forks source link

Update API-design-guidelines for subscription #198

Closed bigludo7 closed 1 month ago

bigludo7 commented 1 month ago

What type of PR is this?

Add one of the following kinds:

What this PR does / why we need it:

Reformulate the subscription part to align with our decision to move to CloudsEvent subscription model. This PR is aligned with the PR #189 which provide an examples.

Which issue(s) this PR fixes:

Fixes #185 #153 #149 #140

Special notes for reviewers:

Changelog input

 release-note
- Move to cloudsEvents subscription model
- Add `initialevent` management
- Add draft subscription status management

Additional documentation

This section can be blank.

docs
AxelNennker commented 1 month ago

I changed my mind about ACCESSTOKEN. There is not much Camara can do on enforcing security at the API consumer. Somebody can please resolve the conversations. @shilpa-padgaonkar

bigludo7 commented 1 month ago

I changed my mind about ACCESSTOKEN. There is not much Camara can do on enforcing security at the API consumer. Somebody can please resolve the conversations. @shilpa-padgaonkar

Thanks @AxelNennker @PedroDiez I can close this point?

shilpa-padgaonkar commented 1 month ago

@bigludo7 Thanks. There is another very small fix already proposed as suggestion in this comment by Axel https://github.com/camaraproject/Commonalities/pull/198#discussion_r1615869708 which will fix the missing authZ header in one of the examples. After that its /LGTM :)

bigludo7 commented 1 month ago

Thanks @shilpa-padgaonkar for the pointer on @AxelNennker comment. Commited!

shilpa-padgaonkar commented 1 month ago

@bigludo7 I noticed that there is a minor conflict you would need to resolve in the file which is blocking the merge. If you could kindly do this, we would go ahead and merge this PR as we have enough approvals now :)

bigludo7 commented 1 month ago

@bigludo7 I noticed that there is a minor conflict you would need to resolve in the file which is blocking the merge. If you could kindly do this, we would go ahead and merge this PR as we have enough approvals now :)

Thanks @shilpa-padgaonkar. Hope to have fixed it.