docs: use real fr_sk_ API key format across README + SDK docstrings - #58
Merged
Conversation
README examples used api_key="fr-xxx", which is not the format the
platform mints or accepts. Real keys are fr_sk_<token> (generated by
GenerateAPIKey and validated by the ingestion auth prefix check), so the
documented placeholder taught a value the backend would reject.
- Replace all 6 api_key="fr-xxx" occurrences with "fr_sk_..."
- Mirror the app Getting Started quickstart: add an app_name comment and
resource_attributes={"environment": "dev"} so the two canonical
quickstarts are identical
sayonfortify
changed the title
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.
What & why
README examples used
api_key="fr-xxx", which is not the API key format the platform issues or accepts. Real keys arefr_sk_<token>— minted byGenerateAPIKey()(fr-common/domain/apikey.go,APIKeyPrefix = "fr_sk_") and validated by the ingestion auth prefix check (fr-backend/internal/ingestion/auth.go). Thefr-xxxplaceholder taught a value the backend would reject, and the wrong shape (hyphen vsfr_sk_).Changes
api_key="fr-xxx"occurrences withapi_key="fr_sk_...".app_namecomment andresource_attributes={"environment": "dev"}(the SDK aliasesenvironment→deployment.environment, used by the backend as the env dimension).Notes
fr-frontend(Getting Started page) corrects the matching snippet there, including a real bug (config_id→config_profile_id).