Update API-design-guidelines for subscription by bigludo7 · Pull Request #198 · camaraproject/Commonalities

bigludo7 · 2024-05-10T16:03:10Z

What type of PR is this?

Add one of the following kinds:

enhancement/feature

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

documentation/API-design-guidelines.md

AxelNennker

sinkCredential is not explained enough.
Is it a shared secret provided by the API consumer?
Do we enforce that the shared secret is different and random enough for each subscription?

Is the sinkCredential a signed and encrypted JWT? With an aud of sink?
What is the value of source? Is it the value of issuerthe the AZ metadata? Or is the source maybe API specific (and the event still have different types for the same API?

documentation/API-design-guidelines.md

AxelNennker · 2024-05-24T18:29:16Z

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

Co-authored-by: Pedro Díez García <pedro.diezgarcia@telefonica.com>

Improved sinkCredential description.

Rename webhook to sink for implicit subscription

bigludo7

Rename webhook to sink for implicit subscription + accepted @PedroDiez proposals + proposal for token expiration

documentation/API-design-guidelines.md

bigludo7 · 2024-05-26T19:57:42Z

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?

AxelNennker

phoneNumber format should be "corrrect" (if needed at all, better use sub)
add Authorization Header

documentation/API-design-guidelines.md

Co-authored-by: Axel Nennker <axel.nennker@telekom.de>

documentation/API-design-guidelines.md

Co-authored-by: Shilpa Padgaonkar <77152136+shilpa-padgaonkar@users.noreply.github.com>

PedroDiez

Need to think about Access Token Expiration. Get your view @bigludo7

Several editorial comments. The whole view looks fine to me

documentation/API-design-guidelines.md

Co-authored-by: Pedro Díez García <pedro.diezgarcia@telefonica.com>

Updated line 1404

bigludo7

@shilpa-padgaonkar @AxelNennker I've accepted your proposal + changed the sentence line 1404.

shilpa-padgaonkar · 2024-06-03T09:04:58Z

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

Co-authored-by: Axel Nennker <axel.nennker@telekom.de>

bigludo7 · 2024-06-03T11:53:31Z

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

shilpa-padgaonkar

/LGTM

shilpa-padgaonkar · 2024-06-04T07:54:03Z

@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 · 2024-06-04T08:01:10Z

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

documentation/API-design-guidelines.md

Co-authored-by: Rafal Artych <121048129+rartych@users.noreply.github.com>

documentation/API-design-guidelines.md

Co-authored-by: Axel Nennker <axel.nennker@telekom.de>

shilpa-padgaonkar

/LGTM

Update API-design-guidelines for subscription

e6d4d94

bigludo7 requested review from PedroDiez, RubenBG7, patrice-conil, rartych and shilpa-padgaonkar as code owners May 10, 2024 16:03

rartych mentioned this pull request May 16, 2024

remove empty security scheme #204

Open

Merge branch 'main' into patch-1

4bd0513

PedroDiez reviewed May 17, 2024

View reviewed changes

PedroDiez mentioned this pull request May 17, 2024

Create subscription-notification-template.yaml #189

Merged

rartych reviewed May 17, 2024

View reviewed changes

documentation/API-design-guidelines.md Outdated Show resolved Hide resolved

AxelNennker suggested changes May 18, 2024

View reviewed changes

documentation/API-design-guidelines.md Show resolved Hide resolved

documentation/API-design-guidelines.md Show resolved Hide resolved

documentation/API-design-guidelines.md Outdated Show resolved Hide resolved

documentation/API-design-guidelines.md Outdated Show resolved Hide resolved

bigludo7 and others added 6 commits May 26, 2024 21:35

Update documentation/API-design-guidelines.md

6331c7e

Co-authored-by: Pedro Díez García <pedro.diezgarcia@telefonica.com>

Update documentation/API-design-guidelines.md

9796896

Co-authored-by: Pedro Díez García <pedro.diezgarcia@telefonica.com>

Update documentation/API-design-guidelines.md

7b712de

Co-authored-by: Pedro Díez García <pedro.diezgarcia@telefonica.com>

Update documentation/API-design-guidelines.md

a849984

Co-authored-by: Pedro Díez García <pedro.diezgarcia@telefonica.com>

Update API-design-guidelines.md

7e6a98e

Improved sinkCredential description.

Update API-design-guidelines.md

3558093

Rename webhook to sink for implicit subscription

bigludo7 commented May 26, 2024

View reviewed changes

documentation/API-design-guidelines.md Show resolved Hide resolved

documentation/API-design-guidelines.md Show resolved Hide resolved

documentation/API-design-guidelines.md Outdated Show resolved Hide resolved

rartych mentioned this pull request May 27, 2024

Commonalities release 0.4.0 scope #175

Closed

AxelNennker suggested changes May 27, 2024

View reviewed changes

documentation/API-design-guidelines.md Show resolved Hide resolved

documentation/API-design-guidelines.md Outdated Show resolved Hide resolved

documentation/API-design-guidelines.md Outdated Show resolved Hide resolved

bigludo7 and others added 2 commits May 27, 2024 14:56

Update documentation/API-design-guidelines.md

b0af7af

Co-authored-by: Axel Nennker <axel.nennker@telekom.de>

Update documentation/API-design-guidelines.md

4ee34eb

Co-authored-by: Axel Nennker <axel.nennker@telekom.de>

shilpa-padgaonkar reviewed May 27, 2024

View reviewed changes

documentation/API-design-guidelines.md Outdated Show resolved Hide resolved

Update documentation/API-design-guidelines.md

80dc505

Co-authored-by: Shilpa Padgaonkar <77152136+shilpa-padgaonkar@users.noreply.github.com>

PedroDiez reviewed May 28, 2024

View reviewed changes

bigludo7 and others added 2 commits May 29, 2024 08:34

Update documentation/API-design-guidelines.md

8a73678

Co-authored-by: Pedro Díez García <pedro.diezgarcia@telefonica.com>

Update documentation/API-design-guidelines.md

b092091

Co-authored-by: Pedro Díez García <pedro.diezgarcia@telefonica.com>

bigludo7 dismissed PedroDiez’s stale review via 71023b3 June 3, 2024 07:56

Update API-design-guidelines.md

a05d62f

Updated line 1404

bigludo7 commented Jun 3, 2024

View reviewed changes

Update documentation/API-design-guidelines.md

59ced62

Co-authored-by: Axel Nennker <axel.nennker@telekom.de>

rartych self-requested a review June 3, 2024 13:36

rartych previously approved these changes Jun 3, 2024

View reviewed changes

shilpa-padgaonkar previously approved these changes Jun 4, 2024

View reviewed changes

PedroDiez previously approved these changes Jun 4, 2024

View reviewed changes

Merge branch 'main' into patch-1

cd3863f

bigludo7 dismissed stale reviews from PedroDiez, shilpa-padgaonkar, and rartych via cd3863f June 4, 2024 08:00

rartych requested a review from shilpa-padgaonkar June 4, 2024 08:03

rartych reviewed Jun 4, 2024

View reviewed changes

documentation/API-design-guidelines.md Show resolved Hide resolved

Update documentation/API-design-guidelines.md

a8981d2

Co-authored-by: Rafal Artych <121048129+rartych@users.noreply.github.com>

rartych self-requested a review June 4, 2024 08:46

rartych previously approved these changes Jun 4, 2024

View reviewed changes

AxelNennker suggested changes Jun 4, 2024

View reviewed changes

documentation/API-design-guidelines.md Outdated Show resolved Hide resolved

Update documentation/API-design-guidelines.md

f55bfd3

Co-authored-by: Axel Nennker <axel.nennker@telekom.de>

bigludo7 dismissed rartych’s stale review via f55bfd3 June 4, 2024 11:45

rartych approved these changes Jun 4, 2024

View reviewed changes

shilpa-padgaonkar approved these changes Jun 4, 2024

View reviewed changes

rartych merged commit 4933df1 into camaraproject:main Jun 4, 2024

rartych mentioned this pull request Jun 5, 2024

Update of linting ruleset #188

Closed

hdamker mentioned this pull request Aug 2, 2024

Alignment of notification web hook to CloudEvent subscription model camaraproject/QualityOnDemand#332

Closed

bigludo7 deleted the patch-1 branch October 4, 2024 12:51

Conversation

bigludo7 commented May 10, 2024

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Special notes for reviewers:

Changelog input

Additional documentation

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AxelNennker left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AxelNennker commented May 24, 2024

Uh oh!

bigludo7 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bigludo7 commented May 26, 2024

Uh oh!

AxelNennker left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

PedroDiez left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bigludo7 left a comment

Choose a reason for hiding this comment

Uh oh!

shilpa-padgaonkar commented Jun 3, 2024

Uh oh!

bigludo7 commented Jun 3, 2024

Uh oh!

shilpa-padgaonkar left a comment

Choose a reason for hiding this comment

Uh oh!

shilpa-padgaonkar commented Jun 4, 2024

Uh oh!

bigludo7 commented Jun 4, 2024

Uh oh!

Uh oh!

Uh oh!

shilpa-padgaonkar left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development