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

Documentation of RestAPI integration from v0.4.0 - v0.6.0 #164

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Ritesh-Udgata
Copy link

Mentioned recent version updates that integrated restAPI into guac and provides insights about endpoints, authentication, error handling and contribution methodology.
close #127

Copy link

netlify bot commented Oct 26, 2024

Deploy Preview for resonant-wisp-1a517a ready!

Name Link
🔨 Latest commit 80d0fd9
🔍 Latest deploy log https://app.netlify.com/sites/resonant-wisp-1a517a/deploys/672320d2575a300008827cb4
😎 Deploy Preview https://deploy-preview-164--resonant-wisp-1a517a.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Collaborator

@funnelfiasco funnelfiasco left a comment

Choose a reason for hiding this comment

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

@Ritesh-Udgata welcome to GUAC. This is a great start! I've left a few comments, and I'll ask others to give it a fact check as well.

There are two things I know you'll need to do:

  1. Fix the formatting (see the comment about "prettier" in the readme.
  2. Add a "Signed-off by: " line in your commit.

If you need help with anything, please join us on [https://guac.sh/community](OpenSSF's Slack)

guac-restAPI-integration.md Outdated Show resolved Hide resolved
guac-restAPI-integration.md Outdated Show resolved Hide resolved
guac-restAPI-integration.md Outdated Show resolved Hide resolved
guac-restAPI-integration.md Outdated Show resolved Hide resolved
@lumjjb lumjjb requested a review from mdeicas October 28, 2024 15:50
guac-restAPI-integration.md Show resolved Hide resolved
guac-restAPI-integration.md Show resolved Hide resolved
guac-restAPI-integration.md Outdated Show resolved Hide resolved
guac-restAPI-integration.md Outdated Show resolved Hide resolved
guac-restAPI-integration.md Outdated Show resolved Hide resolved
guac-restAPI-integration.md Outdated Show resolved Hide resolved
@Ritesh-Udgata
Copy link
Author

All changes Done 👍

@mdeicas
Copy link
Contributor

mdeicas commented Oct 29, 2024

Thanks! Can you update the endpoints as explained here #164 (comment)?

@Ritesh-Udgata
Copy link
Author

Endpoints are now updated with reference to guacsec/guac#2217

Copy link
Collaborator

@funnelfiasco funnelfiasco left a comment

Choose a reason for hiding this comment

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

Looking better. Between this and Marco's comments, this should be the end of it.

Note that you'll still need to:

  1. Use prettier to fix the formatting
  2. Squash your commits into one
  3. Signoff on your commit

guac-restAPI-integration.md Outdated Show resolved Hide resolved
@Ritesh-Udgata
Copy link
Author

Squashed all commits. Added Signed off. Fixed typo. 👍

@funnelfiasco funnelfiasco self-assigned this Oct 30, 2024
Copy link
Collaborator

@funnelfiasco funnelfiasco left a comment

Choose a reason for hiding this comment

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

Looks good to me, thanks! I'm going to hold off on merging this since the changes in guacsec/guac#2217 aren't merged yet, but I'll apply the hacktoberfest-accepted label so you'll get credit for it, if that's important to you. Thanks again for your contribution!

@funnelfiasco funnelfiasco added blocked Waiting for an external change or action hacktoberfest-accepted labels Oct 30, 2024
@mdeicas
Copy link
Contributor

mdeicas commented Oct 30, 2024

@Ritesh-Udgata One more comment! The documentation is missing the /v0/package/{purl}/dependencies and /v0/artifact/{digest}/vulns endpoints, and Components isn't actually an endpoint so that can be removed. Do you mind updating the PR?

@Ritesh-Udgata
Copy link
Author

  1. Added /v0/package/{purl}/dependencies and /v0/artifact/{digest}/vulns endpoints.
  2. Removed components endpoint

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked Waiting for an external change or action hacktoberfest-accepted
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create docs for REST API
3 participants