docs(authentication): simplify auth guide with API key vs Client ID methods and remove AI-generated content#70
Open
docs(authentication): simplify auth guide with API key vs Client ID methods and remove AI-generated content#70
Conversation
…ference Replace the previous AI-generated Authentication page with a focused, API-accurate authentication reference that stands on its own and avoids duplicating setup/tutorial content from other sections. - remove outdated/incorrect content and AI warning banner - define the two supported auth modes clearly: - `x-api-key` for server-side integrations - `x-client-id` for client/browser integrations (with `Origin`) - add method-selection guidance in a compact comparison table - include minimal, practical auth examples for both API key and Client ID flows - document required headers and expected usage context - add common auth error section for 401/403/429 troubleshooting - add concise security guidance specific to credential handling and webhook signing boundaries - link out to related canonical docs (API Portal, Webhooks, OpenAPI) without repeating their content
This was referenced Mar 2, 2026
Open
Open
Open
Member
Author
Greptile SummarySuccessfully simplified authentication documentation by removing AI-generated disclaimers and verbose content. The rewrite focuses clearly on two core authentication methods ( Key improvements:
Confidence Score: 5/5
Important Files Changed
Last reviewed commit: af3e6cc |
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.

TL;DR
Simplified the authentication documentation to focus on the two core authentication methods: API key and Client ID authentication.
What changed?
x-api-key) and Client ID (x-client-id) authentication methodsHow to test?
Why make this change?
The original documentation was verbose and contained AI-generated disclaimers that reduced confidence in the content. This revision provides developers with clear, actionable authentication instructions without unnecessary complexity, making it easier to quickly understand and implement the two supported authentication methods.