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

feat(rest):Components with all details Rest Api doc updated #1936

Conversation

muhammadali9699
Copy link
Contributor

Description

  • Endpoint already existed but api documentation was missing so rest api documentation added.

Issue: #1907

How To Test?

Just click on "Rest API Docs" button on the bottom of project main page.
Navigate to Components section and find "3.4.2 Listing components with all details".

@muhammadali9699 muhammadali9699 force-pushed the feat/ComponentsWithalldetailsUpdatedDoc branch from 28d0546 to 0780449 Compare May 1, 2023 18:08
@ag4ums ag4ums requested a review from rudra-superrr May 2, 2023 07:52
@ag4ums ag4ums added needs code review needs general test This is general testing, meaning that there is no org specific issue to check for labels May 2, 2023
@rudra-superrr
Copy link
Contributor

Hi @muhammadali9699 ,
Not able to find document for Components with all Details endpoint in rest api docs.

image

@@ -31,6 +31,28 @@ include::{snippets}/should_document_get_components/http-response.adoc[]
===== Links
include::{snippets}/should_document_get_components/links.adoc[]

[[resources-components-list]]
Copy link
Contributor

Choose a reason for hiding this comment

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

Please change this to [[resources-components-list-all-details]], as right now its redirecting to listing components doc data in rest api docs.

===== Links
include::{snippets}/should_document_get_components_with_all_details/links.adoc[]


Copy link
Contributor

Choose a reason for hiding this comment

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

Remove these extra lines

@rudra-superrr
Copy link
Contributor

Testing was successful.

@rudra-superrr rudra-superrr removed the needs general test This is general testing, meaning that there is no org specific issue to check for label May 3, 2023
@rudra-superrr
Copy link
Contributor

Also merge your commits into a single commit.

@rudra-superrr rudra-superrr self-assigned this May 3, 2023
@muhammadali9699 muhammadali9699 force-pushed the feat/ComponentsWithalldetailsUpdatedDoc branch from 9173e07 to c80f759 Compare May 4, 2023 04:36
@rudra-superrr
Copy link
Contributor

code looks good.

@rudra-superrr rudra-superrr added ready ready to merge and removed needs code review labels May 4, 2023
@ag4ums ag4ums merged commit 66c609c into eclipse-sw360:main May 11, 2023
nikkuma7 pushed a commit to siemens/sw360 that referenced this pull request May 16, 2023
…nentsWithalldetailsUpdatedDoc

feat(rest):Components with all details Rest Api doc updated

Tested by: [email protected]
Reviewed by: [email protected]

Signed-off-by: Nikesh kumar <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready ready to merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants