API reference parameter descriptions audit

[truthixify]

Tier: M (2-4 days) Type: audit

Context

docs/api-reference/endpoints.mdx and types.mdx list signatures but every parameter is bare. name: string doesn't tell anyone it must be 3-32 lowercase alphanumeric. The descriptions are the docs.

Scope

For every parameter and return field across the API reference:

• 1-sentence description
• Constraints (min/max/regex/enum) where applicable
• Example value if non-obvious
• Cross-reference related types (link chain: Chain to the enum page)

Source of truth: SDK JSDoc, Spectre + Gateway DTOs in TypeScript, source files.

Acceptance criteria

• Every parameter + return field has a description
• Constraints documented where applicable
• Cross-references wired up
• No editorializing (describe what fields are, not designer intent)

Files to start with

• docs/api-reference/endpoints.mdx
• docs/api-reference/types.mdx

[emarkees]

@emarkees has applied to work on this issue as part of the Stellar Wave Program's 6th wave.

I would like to work on this issue because I can get it done.

ℹ️ Repo Maintainers: To accept this application, review their application or assign @emarkees to this issue.