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

Add some one-liner API documentation for the UI. #758

Merged
merged 2 commits into from
Sep 4, 2024

Conversation

bobmcwhirter
Copy link
Contributor

No description provided.

@bobmcwhirter
Copy link
Contributor Author

Also add some more refined tags.

@@ -18,6 +18,7 @@ use trustify_common::purl::Purl;
),
)]
#[get("/v1/purl/version/{key}")]
/// Retrieve details of a versioned, non-qualified pURL
Copy link
Contributor

Choose a reason for hiding this comment

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

I assume these comments show up on the openapi UI?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yep!

@bobmcwhirter bobmcwhirter added this pull request to the merge queue Sep 4, 2024
Merged via the queue into trustification:main with commit 7fb1c67 Sep 4, 2024
1 check passed
@bobmcwhirter bobmcwhirter deleted the api-docs branch September 4, 2024 20:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants