docs-content-strategy

Template: API Reference Page

Copy this template when creating a new API reference page. Remove sections that don’t apply. Replace all placeholder text in [brackets].

[Resource name]

[One-sentence description of what this resource or class represents and what it’s used for.]

[Method name]

[One-sentence description of what this method does.]

[method signature]

Parameters

Parameter Type Required Default Description
[param] [type] Yes / No — [Description in present tense, ending in period.]

Returns

{
  [field]: [type];  // [description]
}

[Optional: short prose explanation if the return structure needs context.]

Errors

Code Meaning
[error_code] [Plain English explanation of when this occurs.]

Example

[Minimal, runnable example showing the most common use case. Use sample data from naming conventions.]

[Next method name]

[Repeat the method block for each method in this class or resource group.]