search

guacsec / guac-docs

Docs to ingest in GUAC
https://guac.sh/
Creative Commons Attribution 4.0 International
8 stars 30 forks source link

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

Open Ritesh-Udgata opened 2 weeks ago

Ritesh-Udgata commented 2 weeks ago

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

netlify[bot] commented 2 weeks ago

Deploy Preview for resonant-wisp-1a517a ready!

Name Link
Latest commit 80d0fd911081a3bed2b2a1ca94371d12e6d38f6e
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.

Ritesh-Udgata commented 2 weeks ago

All changes Done 👍

mdeicas commented 2 weeks ago

Thanks! Can you update the endpoints as explained here https://github.com/guacsec/guac-docs/pull/164#discussion_r1820889419?

Ritesh-Udgata commented 2 weeks ago

Endpoints are now updated with reference to https://github.com/guacsec/guac/pull/2217

Ritesh-Udgata commented 2 weeks ago

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

mdeicas commented 2 weeks ago

@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 commented 2 weeks ago
  1. Added /v0/package/{purl}/dependencies and /v0/artifact/{digest}/vulns endpoints.
  2. Removed components endpoint