Repository navigation
Docs: examples for using Credentials with $curl - #533
Merged
Merged
Conversation
Add jsonata.json examples for basic auth, API key and dj-insert-credentials, and document them in the developer and JSONata references. #531 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Picks up the new $curl credential examples from jsonata.json. #531 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
Closes #531
The docs explained that
$curlresolves a Credentials function via theAuthorizationheader, butjsonata.jsononly had an example with a hard-coded basic auth header.Changes:
jsonata.json: three new$curlexamples{'Authorization': 'dashjoin'})apiKey=true, header named byusername)dj-insert-credentials(previously undocumented)developer-reference.md: worked examples in the Credentials section, incl. the role requirementjsonata-reference.md: inline example anddj-insert-credentialsin the$curlrowappendix-jsonata.mdandllms.txtviaLLMs.javaThe docs describe the behaviour after dashjoin/dashjoin-aas
fix/curl-apikey-header, which stops$curlfrom sending the credential ID inAuthorizationwhen an API key goes into a different header (e.g.X-API-Key).🤖 Generated with Claude Code