Skip to content

docs: add purpose and usage descriptions to REST operations - #630

Merged
Devon-White merged 5 commits into
mainfrom
Devon/api-descriptions
Aug 27, 2026
Merged

docs: add purpose and usage descriptions to REST operations#630
Devon-White merged 5 commits into
mainfrom
Devon/api-descriptions

Conversation

@Devon-White

Copy link
Copy Markdown
Collaborator

Summary

  • add customer-facing purpose and when-to-use guidance to all 332 REST and Compatibility operations
  • explain how resources appear in and interact with SignalWire projects while preserving verified cross-API behavior
  • remove redundant schema and pagination details from operation overviews
  • regenerate the SignalWire REST and Compatibility OpenAPI specifications

Validation

  • yarn build:specs
  • yarn format:specs:check
  • git diff --check
  • description coverage: 332 tier C, 0 unresolved
  • Fern local link and API checks pass; the external missing-redirects check was skipped because FDR returned HTTP 403

Closes #606

@github-actions

github-actions Bot commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

@hey-august hey-august left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Approving! Verified all claims against other docs and source code. A small set of inaccurate claims have been fixed.

@Devon-White
Devon-White merged commit 74d318d into main Aug 27, 2026
2 checks passed
@Devon-White
Devon-White deleted the Devon/api-descriptions branch August 27, 2026 15:37
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.

Give REST operation exports a purpose and when-to-use description

2 participants