Update versioning section in api design guidelines by tanjadegroot · Pull Request #215 · camaraproject/Commonalities

tanjadegroot · 2024-05-24T17:08:04Z

What type of PR is this?

Add one of the following kinds:

documentation

What this PR does / why we need it:

It updates the versioning section to be in line with the API versioning for the release management process

Which issue(s) this PR fixes:

Fixes #206

Special notes for reviewers:

Changelog input

 release-note: update the API versioning in line with the release management process

Additional documentation

This section can be blank.

docs

update of version section step 1

section 5. Version - update 3 update of TOC

…o tanjadegroot-patch-1

Update API-design-guidelines.md

final adjustments

hdamker

Looks good to me. One proposal and one question below.

documentation/API-design-guidelines.md

Co-authored-by: Herbert Damker <52109189+hdamker@users.noreply.github.com>

Update following comments on backward compatibility section

rartych · 2024-06-12T13:59:12Z

I have discovered that in Commonalities we have https://github.com/camaraproject/Commonalities/blob/main/documentation/Camara_Versioning_Guidelines.md
I think it should be deprecated with redirection to the proposed here API Design Guidelines and Release Management documentation.
To speed up things maybe we can do it within this PR. @tanjadegroot @hdamker ?

tanjadegroot · 2024-06-12T14:10:06Z

Hi Rafal, yes that is correct. this file can be deprecated.
API versioning is now going into the API Guidelines section 5
API release process is now here: https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/API_Release_Guidelines.md (with more details in the CAMARA release Management Wiki)

rartych · 2024-06-12T14:46:13Z

Tanja, if you could modify the file in Nokia fork: https://github.com/nokia/camaraproject-Commonalities/blob/Update-versioning-section-in-API-design-guidelines/documentation/Camara_Versioning_Guidelines.md then we go with all the changes within this PR.

Changed the use of "public-release" to just "public" Removed references to release aspects for the versioning section

tanjadegroot · 2024-06-12T15:26:41Z

@hdamker to check this update

tanjadegroot · 2024-06-12T15:59:55Z

Tanja, if you could modify the file in Nokia fork: https://github.com/nokia/camaraproject-Commonalities/blob/Update-versioning-section-in-API-design-guidelines/documentation/Camara_Versioning_Guidelines.md then we go with all the changes within this PR.

I just need to remove the file corrrect ?

release mgmt information is moved to the Release Mgmt repo

hdamker · 2024-06-12T17:13:39Z

I just need to remove the file corrrect ?

@tanjadegroot that's not enough, also the line in the table within https://github.com/camaraproject/Commonalities/blob/main/README.md need to be updated/replaced.

What about deleting the two lines about API-Readiness-Checklist.md and Camara_Versioning_Guidelines.md

and put underneath the table something like:

NOTE: Guidelines for Release Management of API versions, e.g. the API-Readiness-Checklist, are now located within [ReleaseManagement](https://github.com/camaraproject/ReleaseManagement). The versioning of API is defined within API-design-guidelines.md](documentation/API-design-guidelines.md#5-versioning).

@rartych WDYT about the README?

complement to removing release info from versioning section

removed the references to 2 removed documents and added note to point to ReleaseManagement repo

tanjadegroot · 2024-06-12T17:33:24Z

README.md update done

documentation/API-design-guidelines.md

Shilpa's comment on URL version

included updates on removing"-" in release names some more tweeks

rartych

LGTM

patrice-conil

/LGTM

shilpa-padgaonkar

/LGTM

documentation/API-design-guidelines.md

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

PedroDiez

LGTM

shilpa-padgaonkar

/LGTM

rartych · 2024-06-19T07:24:22Z

@patrice-conil Could you approve it?

patrice-conil

LGTM

tanjadegroot added 6 commits May 17, 2024 01:43

Update API-design-guidelines.md

05ffc4e

update of version section step 1

Update API-design-guidelines.md

02b78ef

section 5. Version - update 3 update of TOC

Merge branch 'Update-versioning-section-in-API-design-guidelines' int…

2cdfba6

…o tanjadegroot-patch-1

Merge pull request #1 from nokia/tanjadegroot-patch-1

86969e4

Update API-design-guidelines.md

Update API-design-guidelines.md

ed7035c

final adjustments

Update API-design-guidelines.md

142c5f6

tanjadegroot requested review from PedroDiez, RubenBG7, patrice-conil, rartych and shilpa-padgaonkar as code owners May 24, 2024 17:08

rartych mentioned this pull request May 27, 2024

Commonalities release 0.4.0 scope #175

Closed

shilpa-padgaonkar mentioned this pull request May 29, 2024

Resolution on where the documentation of ICM AuthN/AuthZ common guidelines for API specs must be located camaraproject/IdentityAndConsentManagement#160

Closed

rartych requested a review from hdamker June 3, 2024 12:12

hdamker reviewed Jun 11, 2024

View reviewed changes

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

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

tanjadegroot and others added 2 commits June 11, 2024 17:22

Update documentation/API-design-guidelines.md

8e2c4e6

Co-authored-by: Herbert Damker <52109189+hdamker@users.noreply.github.com>

Update API-design-guidelines.md

633bc14

Update following comments on backward compatibility section

hdamker previously approved these changes Jun 12, 2024

View reviewed changes

hdamker requested a review from a team June 12, 2024 06:59

Update API-design-guidelines.md - removing release aspects

f1ef812

Changed the use of "public-release" to just "public" Removed references to release aspects for the versioning section

tanjadegroot dismissed hdamker’s stale review via f1ef812 June 12, 2024 15:25

Delete documentation/Camara_Versioning_Guidelines.md

50bc2f7

release mgmt information is moved to the Release Mgmt repo

tanjadegroot added 2 commits June 12, 2024 19:26

Update API-design-guidelines.md

b817b7d

complement to removing release info from versioning section

Update README.md

528f320

removed the references to 2 removed documents and added note to point to ReleaseManagement repo

hdamker previously approved these changes Jun 12, 2024

View reviewed changes

shilpa-padgaonkar reviewed Jun 13, 2024

View reviewed changes

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

Update API-design-guidelines.md

85ceb7a

Shilpa's comment on URL version

tanjadegroot dismissed hdamker’s stale review via 85ceb7a June 13, 2024 22:18

Update API-design-guidelines.md

8f1ffc6

included updates on removing"-" in release names some more tweeks

rartych previously approved these changes Jun 14, 2024

View reviewed changes

patrice-conil previously approved these changes Jun 14, 2024

View reviewed changes

hdamker previously approved these changes Jun 14, 2024

View reviewed changes

shilpa-padgaonkar previously approved these changes Jun 14, 2024

View reviewed changes

PedroDiez reviewed Jun 17, 2024

View reviewed changes

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

tanjadegroot dismissed stale reviews from shilpa-padgaonkar, hdamker, patrice-conil, and rartych via 0556740 June 17, 2024 11:01

Update documentation/API-design-guidelines.md

0556740

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

rartych requested review from PedroDiez, patrice-conil, rartych and shilpa-padgaonkar June 17, 2024 11:54

rartych approved these changes Jun 17, 2024

View reviewed changes

PedroDiez approved these changes Jun 17, 2024

View reviewed changes

shilpa-padgaonkar approved these changes Jun 18, 2024

View reviewed changes

hdamker approved these changes Jun 18, 2024

View reviewed changes

patrice-conil approved these changes Jun 19, 2024

View reviewed changes

rartych merged commit 76e386c into camaraproject:main Jun 19, 2024

rartych mentioned this pull request Jul 31, 2024

Deprecate documentation template - delete Camara_Versioning_Guidelines.md #261

Merged

tanjadegroot deleted the Update-versioning-section-in-API-design-guidelines branch April 21, 2025 22:57

Conversation

tanjadegroot commented May 24, 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!

hdamker left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

rartych commented Jun 12, 2024

Uh oh!

tanjadegroot commented Jun 12, 2024

Uh oh!

rartych commented Jun 12, 2024

Uh oh!

tanjadegroot commented Jun 12, 2024

Uh oh!

tanjadegroot commented Jun 12, 2024

Uh oh!

hdamker commented Jun 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tanjadegroot commented Jun 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

rartych left a comment

Choose a reason for hiding this comment

Uh oh!

patrice-conil left a comment

Choose a reason for hiding this comment

Uh oh!

shilpa-padgaonkar left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

PedroDiez left a comment

Choose a reason for hiding this comment

Uh oh!

shilpa-padgaonkar left a comment

Choose a reason for hiding this comment

Uh oh!

rartych commented Jun 19, 2024

Uh oh!

patrice-conil left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

hdamker commented Jun 12, 2024 •

edited

Loading

tanjadegroot commented Jun 12, 2024 •

edited

Loading