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.

Sign up for GitHub

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

Jump to bottom

docs(api): add OpenAPI docs for releases #2200

Merged
merged 1 commit into from
Dec 6, 2023
Merged

docs(api): add OpenAPI docs for releases #2200

merged 1 commit into from
Dec 6, 2023

Conversation

GMishx
Copy link
Member

@GMishx GMishx commented Nov 17, 2023

Please provide a summary of your changes here.

  1. Add OpenAPI docs for /releases endpoints.
  2. Add the missing AsciiDoc for getting releases by external ID.
  3. Replace deprecated exception HttpMessageNotReadableException with HttpClientErrorException.

Continuation of #2071

Suggest Reviewer

@heliocastro
@KoukiHama
@ag4ums

How To Test?

Checklist

Must:

  • All related issues are referenced in commit messages and in PR

@GMishx GMishx added needs code review needs general test This is general testing, meaning that there is no org specific issue to check for labels Nov 17, 2023
@KoukiHama KoukiHama self-assigned this Nov 17, 2023
@GMishx GMishx force-pushed the docs/api/openapi-releases branch from a713670 to be126e7 Compare November 17, 2023 09:39
@hoangnt2
Copy link
Contributor

The changes look good to me

@GMishx GMishx mentioned this pull request Nov 17, 2023
Merged
1 task
@ag4ums ag4ums assigned GMishx and unassigned KoukiHama Nov 29, 2023
@GMishx GMishx force-pushed the docs/api/openapi-releases branch from be126e7 to 22a1b7c Compare November 30, 2023 08:40
@GMishx
Copy link
Member Author

GMishx commented Nov 30, 2023

Rebased @ag4ums

@GMishx GMishx removed their assignment Nov 30, 2023
@ag4ums ag4ums added has merge conflicts ready ready to merge and removed needs general test This is general testing, meaning that there is no org specific issue to check for labels Dec 5, 2023
ag4ums
ag4ums approved these changes Dec 5, 2023
View reviewed changes
Copy link
Contributor

@ag4ums ag4ums left a comment

Choose a reason for hiding this comment

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

working as expected

@GMishx
docs(api): add OpenAPI docs for releases
27dc3d8 
1. Add OpenAPI docs for /releases endpoints.
2. Add the missing AsciiDoc for getting releases by external ID.
3. Replace deprecated exception `HttpMessageNotReadableException` with
`HttpClientErrorException`.

Also, change the parameter in `searchByExternalIds` to accommodate the
change done in 2fdd5f4 (issue eclipse-sw360#2207).

Signed-off-by: Gaurav Mishra <gmishx@gmail.com>
@GMishx GMishx force-pushed the docs/api/openapi-releases branch from 22a1b7c to 27dc3d8 Compare December 5, 2023 12:54
@GMishx
Copy link
Member Author

GMishx commented Dec 5, 2023

rebased @ag4ums

@ag4ums ag4ums merged commit 55c36b5 into eclipse-sw360:main Dec 6, 2023
@GMishx GMishx deleted the docs/api/openapi-releases branch December 12, 2023 09:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hoangnt2 hoangnt2 hoangnt2 left review comments

@ag4ums ag4ums ag4ums approved these changes

@tienlee tienlee Awaiting requested review from tienlee

Assignees
No one assigned
Labels
ready ready to merge
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@GMishx @hoangnt2 @ag4ums @KoukiHama