Skip to content

docs(authentication): simplify auth guide with API key vs Client ID methods and remove AI-generated content#70

Open
aimensahnoun wants to merge 1 commit into03-02-docs_api-features_rebuild_fee-breakdowns_with_api-accurate_fee_models_rewrite_api-features_fee-breakdowns.mdx_into_a_reconciliation-oriented_reference_that_reflects_actual_api_fee_fields_and_response_shapes._-_remove_ai-generatefrom
03-02-docs_api-reference_rewrite_authentication_page_as_canonical_auth_reference_replace_the_previous_ai-generated_authentication_page_with_a_focused_api-accurate_authentication_reference_that_stands_on_its_own_and_avoids_duplicating_
Open

docs(authentication): simplify auth guide with API key vs Client ID methods and remove AI-generated content#70
aimensahnoun wants to merge 1 commit into03-02-docs_api-features_rebuild_fee-breakdowns_with_api-accurate_fee_models_rewrite_api-features_fee-breakdowns.mdx_into_a_reconciliation-oriented_reference_that_reflects_actual_api_fee_fields_and_response_shapes._-_remove_ai-generatefrom
03-02-docs_api-reference_rewrite_authentication_page_as_canonical_auth_reference_replace_the_previous_ai-generated_authentication_page_with_a_focused_api-accurate_authentication_reference_that_stands_on_its_own_and_avoids_duplicating_

Conversation

@aimensahnoun
Copy link
Member

@aimensahnoun aimensahnoun commented Mar 2, 2026

TL;DR

Simplified the authentication documentation to focus on the two core authentication methods: API key and Client ID authentication.

What changed?

  • Removed AI-generated content warning and extensive boilerplate sections
  • Streamlined content to focus on API key (x-api-key) and Client ID (x-client-id) authentication methods
  • Replaced lengthy step-by-step guides and accordion sections with concise examples and reference tables
  • Updated description from generic "API authentication, key management, and security best practices" to specific "How to authenticate Request Network API calls with API keys or Client ID"
  • Condensed error handling section to focus on the three main HTTP status codes (401, 403, 429)
  • Simplified security guidance to essential best practices
  • Updated related pages section to reference API Portal, Webhooks, and OpenAPI documentation

How to test?

  • Verify that the cURL examples work correctly with valid API keys and Client IDs
  • Test that the authentication headers are properly documented for both server-side and browser-based integrations
  • Confirm that links to related documentation pages are functional

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.

…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
Copy link
Member Author

aimensahnoun commented Mar 2, 2026

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

This stack of pull requests is managed by Graphite. Learn more about stacking.

@aimensahnoun aimensahnoun self-assigned this Mar 2, 2026
@aimensahnoun aimensahnoun changed the title docs(api-reference): rewrite authentication page as canonical auth reference 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 f docs(authentication): simplify auth guide with API key vs Client ID methods and remove AI-generated content Mar 2, 2026
@aimensahnoun aimensahnoun marked this pull request as ready for review March 2, 2026 14:36
@greptile-apps
Copy link

greptile-apps bot commented Mar 2, 2026

Greptile Summary

Successfully simplified authentication documentation by removing AI-generated disclaimers and verbose content. The rewrite focuses clearly on two core authentication methods (x-api-key and x-client-id) with concise examples and proper error documentation.

Key improvements:

  • Removed 151 lines of verbose/redundant content while preserving all critical information
  • Clear comparison table helps developers choose the right auth method
  • cURL examples match patterns used throughout the codebase
  • Security guidance is actionable and focused on essentials
  • All internal links verified (related pages exist and are properly structured)
  • Follows Mintlify technical writing guidelines from AGENTS.md

Confidence Score: 5/5

  • This PR is safe to merge with minimal risk
  • Documentation-only change that improves clarity without introducing technical errors. All authentication patterns verified against existing codebase usage, internal links confirmed valid, and structure follows established guidelines
  • No files require special attention

Important Files Changed

Filename Overview
api-reference/authentication.mdx Simplified authentication doc with accurate API key and Client ID methods, proper examples, and clean structure

Last reviewed commit: af3e6cc

Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 file reviewed, no comments

Edit Code Review Agent Settings | Greptile

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant