docs(proxy): fix JWT key mapping guide to match shipped endpoints#496
Open
devin-ai-integration[bot] wants to merge 1 commit into
Open
docs(proxy): fix JWT key mapping guide to match shipped endpoints#496devin-ai-integration[bot] wants to merge 1 commit into
devin-ai-integration[bot] wants to merge 1 commit into
Conversation
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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.
Summary
The JWT key mapping guide documented
/jwt_client/newand/jwt_client/updateroutes plus request/response shapes that never shipped. Those endpoints (a unified "create key + mapping" call, anissuer-scoped mapping, JWT-bound key lockdown tollm_api_routes) live only on an unmerged branch (litellm_ishaan_march31, commitde23b3ec); the guide was written the same day describing that branch's planned API rather than what merged. What actually shipped is the/jwt/key/mapping/*set backed byjwt_key_mapping_endpoints.py, and every mapping op keys off the mappingid, not the claim name/value.This rewrites the guide to match the code:
jwt_client_id_field->virtual_key_claim_field(old name still accepted as a deprecated alias, noted in the doc)POST /key/generateto mint the virtual key, thenPOST /jwt/key/mapping/newwith{jwt_claim_name, jwt_claim_value, key}wherekeyis the key token (notvirtual_key_id)id:info/listareGETwith?id=/pagination,updateanddeletearePOSTtaking{"id": ...}(the doc previously usedDELETE+ claim body and a nonexistent/jwt_client/update);inforeturns the mapping record, not the linked key's budget/spendauto_registermints an unrestricted key); dropped the unimplementedllm_api_routes//key/update403 claimsissuersection removed: the mapping is unique on(jwt_claim_name, jwt_claim_value)with no issuer dimension, so it's replaced with guidance to map on a globally-unique claimLinear ticket
Link to Devin session: https://app.devin.ai/sessions/c75c6079168c4facb87631fb316a28bc
Requested by: @krrish-berri-2