Repository navigation
docs: match Snowflake OAuth secret key casing returned by SYSTEM$SHOW_OAUTH_CLIENT_SECRETS - #226
Merged
Conversation
SYSTEM$SHOW_OAUTH_CLIENT_SECRETS returns uppercase JSON keys (OAUTH_CLIENT_SECRET_2, OAUTH_CLIENT_SECRET, OAUTH_CLIENT_ID), per Snowflake's Knowledge Base sample output. The function reference lists them in lowercase, and the guide copied that casing. Snowflake JSON element names are case-sensitive, so the guide's lowercase paths returned NULL for both credentials. Read the uppercase keys, add a sanitized raw-output example and a key-to-Speakeasy-field mapping, and record the new source in the dossier and metadata. Co-authored-by: Sagar Batchu <simplesagar@users.noreply.github.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.
Summary
The Snowflake guide's Copy the OAuth credentials step read lowercase JSON keys (
secret_values:oauth_client_id).SYSTEM$SHOW_OAUTH_CLIENT_SECRETSactually returns uppercase keys:{"OAUTH_CLIENT_SECRET_2":"…","OAUTH_CLIENT_SECRET":"…","OAUTH_CLIENT_ID":"…"}Snowflake JSON element names are case-sensitive, so the old query did more than look inconsistent: it returned
NULLfor both credentials. The lowercase casing came from the function reference's output table, which lists the names in lowercase and has no sample output.Changes
external.md: the query reads"OAUTH_CLIENT_ID"and"OAUTH_CLIENT_SECRET", and the copy steps name the uppercase result columns. The step also adds:NULLcells,OAUTH_CLIENT_SECRET_2is marked not used).research.md: the credential facts, field mapping table, walkthrough, and Speakeasy values now use the returned casing. Provenance records the casing source and notes the lowercase discrepancy in the function reference.meta.yaml: adds the Snowflake Knowledge Base article as aprovider-supportsource and re-stamps the function-reference and semi-structured-querying observations.go/generatedis not touched; the regen workflow syncs it after merge.Sources
secrets:"OAUTH_CLIENT_ID".Verification
go run ./cmd/lint-guide ../guides/snowflakereports no findings, and thego/internal/gengenerator succeeds (the same check as guide-validate CI).(None, None);OAUTH_CLIENT_IDandOAUTH_CLIENT_SECRET.Fixes AIM-683