Skip to content

[Docs] Fix stale REDIS_URL docs, it is already used for rate limiting #424

Description

@collinsezedike

Summary

apps/docs/operations/environment-variables.md lists REDIS_URL under a "Future variables" section as currently not used. It is already used: apps/api-local/src/index.ts reads process.env.REDIS_URL and wires it into the @fastify/rate-limit plugin as its store.

Motivation

Anyone setting up a new environment and reading this doc would conclude REDIS_URL is optional/unused and skip configuring it, when in practice the API's rate limiting depends on it.

Proposed Solution

Move the REDIS_URL row out of "Future variables" into the main environment variable table, with a description matching its actual role (rate-limit store for apps/api-local).

Scope

Field Value
Area Docs, API
Protocol affected None
Network N/A
Breaking change? No

Alternatives Considered

None, this is a straightforward factual correction.

Acceptance Criteria

  • REDIS_URL appears in the main environment variable table, not the future/unused section
  • Description accurately reflects its use as the rate-limit store

Additional Context

Verified against apps/api-local/src/index.ts (reads process.env.REDIS_URL, wires into @fastify/rate-limit).

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programapiAdds or modifies a REST endpoint in apps/apidocsDocumentation, guides, README, inline docs, or ADRsgood first issueGood for newcomers

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions