add docs for batch endpoint #169
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
janasheehan
reviewed
Jun 26, 2024
|
Thanks @janasheehan! Your name was randomly picked to review when I opened the PR, so please don't feel obligated to review it too closely! I'll request some others with more specific knowledge of the endpoint. Thanks again! |
…dpoint-and-update-single-package-endpoint-docs
ejortega
reviewed
Jun 27, 2024
| "riskScores": { | ||
| "author": 1.0, | ||
| "engineering": 1.0, | ||
| "license": 1.0, | ||
| "malicious_code": 0.01, | ||
| "total": 0.05, | ||
| "vulnerability": 1.0 | ||
| } | ||
| }, | ||
| "version": "0.1.0" |
There was a problem hiding this comment.
Maybe a nitpick, but maybe the example response can match same order specified?
name: The name of the package.version: The version of the package.ecosystem: The ecosystem to which the package was published.code: The HTTP status code.malware: A boolean indicating if the package has been triaged as malware.riskScores: An object containing risk scores for each of the 5 Phylum risk domains associated with the pa
…dpoint-and-update-single-package-endpoint-docs
|
Please hold off on merging/publishing this for now. |
Sounds good! Will convert to draft just to make sure it doesn't get merged accidentally. |
|
I am going to close this PR as we will not be including this text in the published docs. |
furi0us333
deleted the
joe/168-create-docs-for-threat-feed-batch-endpoint-and-update-single-package-endpoint-docs
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds docs for new
/batchthreat feed end point. Also adds docs about top level key additions to single package end point.Note that I will update the example in the docs with one that actually returns slightly more interesting results after this gets deployed and I can run it against prod instead of staging.