Skip to content

Add docs for client API layer conventions and how to add a new server call #445

Description

@Chucks1093

Summary

The client has an API layer that wraps server calls but its conventions — file location, naming, error handling pattern, and how to add a new endpoint — are undocumented. Contributors adding features that need new server data do not know where to start.

Scope

  • Document the API layer folder structure and file naming convention
  • Explain how to add a new endpoint call: where the function lives, how errors are handled, and how it connects to a React Query hook
  • Include a minimal worked example of a new GET call from API function to hook to component

Acceptance Criteria

  • Folder structure and naming convention are documented
  • Error handling pattern is explained
  • Worked example covers API function, hook, and component usage

ETA: 12 hours


Coordinate on Telegram

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave program

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions