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

Included REST Spec Changes #2217

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

Conversation

nathannaveen
Copy link
Contributor

Description of the PR

  • Second Part of Search REST via Purl #2089
  • All the OpenAPI Spec changes have been included
  • The /query/dependencies is no longer going to be used, instead, the /v0/package/{purl}/dependencies and /v0/artifact/{digest}/dependencies will be replacing it.
  • The code in retrieveDependencies.go has been updated to work for the new endpoints.
  • The error handling code has also been updated.

PR Checklist

  • All commits have a Developer Certificate of Origin (DCO) -- they are generated using -s flag to git commit.
  • All new changes are covered by tests
  • If GraphQL schema is changed, make generate has been run
  • If GraphQL schema is changed, GraphQL client updates/additions have been made
  • If OpenAPI spec is changed, make generate has been run
  • If ent schema is changed, make generate has been run
  • If collectsub protobuf has been changed, make proto has been run
  • All CI checks are passing (tests and formatting)
  • All dependent PRs have already been merged

@nathannaveen nathannaveen mentioned this pull request Oct 25, 2024
9 tasks
@nathannaveen
Copy link
Contributor Author

👀 @pxp928 @mdeicas @lumjjb

@lumjjb lumjjb added the needs-review Needs writer LGTM label Oct 28, 2024
@lumjjb lumjjb self-requested a review October 28, 2024 15:08
Copy link
Collaborator

@mdeicas mdeicas left a comment

Choose a reason for hiding this comment

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

This is a great change, thanks @nathannaveen! Thank you as well for splitting the original PR up and adding documentation to the API spec. I added comments but overall it looks good.

pkg/guacrest/openapi.yaml Show resolved Hide resolved
pkg/guacrest/openapi.yaml Outdated Show resolved Hide resolved
pkg/guacrest/openapi.yaml Outdated Show resolved Hide resolved
pkg/guacrest/openapi.yaml Outdated Show resolved Hide resolved
pkg/guacrest/openapi.yaml Outdated Show resolved Hide resolved
pkg/guacrest/server/retrieveDependencies.go Outdated Show resolved Hide resolved
pkg/guacrest/server/retrieveDependencies_test.go Outdated Show resolved Hide resolved
pkg/guacrest/server/retrieveDependencies_test.go Outdated Show resolved Hide resolved
pkg/guacrest/server/retrieveDependencies_test.go Outdated Show resolved Hide resolved
* Second Part of guacsec#2089
* All the OpenAPI Spec changes have been included
* The `/query/dependencies` is no longer going to be used, instead, the `/v0/package/{purl}/dependencies` and `/v0/artifact/{digest}/dependencies` will be replacing it.
* The code in retrieveDependencies.go has been updated to work for the new endpoints.

Signed-off-by: nathannaveen <[email protected]>
Signed-off-by: nathannaveen <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs-review Needs writer LGTM size/XXL
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants