docs(auth): API key -> JWT snippet and SDK cross-link - #2
Merged
Conversation
Generator regen does not touch the README. Add a short usage snippet showing how to call `auth.sync()` with an AuthenticatedClient configured to send X-API-Key, document the QTSURFER_APIKEY env-var convention, and point production callers at the sibling SDK for token-refresh handling. Part of openapi-auth-rollout Phase 2 (#168).
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
1 participant
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
Phase 2 follow-up: the regen PR (#1) updated the generated client but the README still had no usage guidance for the new
authoperation. This adds:### API key -> JWTsnippet in Quick start showingauth.sync()with anAuthenticatedClientconfigured to sendX-API-Key(viaprefix=""+auth_header_name="X-API-Key").QTSURFER_APIKEYenv-var convention (matches the e2e script and the upcoming SDK helper).Docs-only — no code, no regen, no version bump.
Part of openapi-auth-rollout Phase 2 (#168).
Test plan
auth.sync,AuthenticatedClient)