Repository navigation
Add API user guide for script writers - #115
Merged
Merged
Conversation
- docs/api.md: getting an API key, first request, endpoints, request and response fields, background jobs, speed/caching, error codes, Python example. - README: link the guide from the intro, the API-keys and gene-query sections; rename the third-party key section so it isn't confused with ACGC API keys.
This file contains hidden or 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
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.
What
Documentation only; no code changes.
docs/api.md: a user guide for MSK staff calling ACGC from scripts./api-keyspage, and the key rules: expiry, revoking, 60 requests a minute, and keys can't manage keys./v1/genes/*endpoint with its request body and every response field.force_refreshaffect speed, and every error code with what to do about it, including the per-gene errors in batch responses.429.## API Keysheading, which is about outside services ACGC itself uses (Anthropic, NCBI…), is renamed to## Third-Party API Keys (used by ACGC)and points script writers to the right place. Nothing in the repo linked to the old#api-keysanchor.Accuracy
Field names, limits and status codes were checked against the code on
main:src/api/gene_query.pymodels;src/api_keys_routes.py;require_authinsrc/auth.py(401 for a bad, revoked or expired key, or an owner no longer on the allowlist; 403 for an account pending approval; 503 when keys can't be verified;EOF
)