Skip to content

docs: API authentication & API key guide #642

@joelpeace48-cell

Description

@joelpeace48-cell

Background & current state

Auth spans API keys (apiKeyAuth.js) and (incoming) SEP-10 (NEW-011), org-scoped keys + scopes (NEW-083), and rate limits — but there's no single doc explaining how to authenticate and manage keys.

Goal

Author docs/API_AUTH.md covering every auth path: API key creation/rotation/revocation, scopes, SEP-10 wallet login, and rate-limit behavior.

Outline

Task breakdown

  • Write docs/API_AUTH.md covering all paths.
  • Cross-check against routes/middleware.
  • Cross-link from README + OpenAPI.

Acceptance criteria

  • Every auth path is documented and matches the implementation.

Verification

  • Cross-reference vs apiKeyAuth.js/SEP-10; review; link check.

Difficulty: easy–medium · Effort: S–M · documentation + security

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions