templates-extended

Extended Templates

This document contains additional specialized templates for specific contexts beyond the core Memory Bank files.

API Documentation Template

# API Documentation: [API Name]

## Overview
[Brief description of the API's purpose and scope]

## Base URL

[Base URL for the API]

## Authentication
[Authentication methods and requirements]

## Common Parameters
- `[parameter1]`: [Description] - [Required/Optional]
- `[parameter2]`: [Description] - [Required/Optional]

## Response Format
```json
{
  "success": true,
  "data": {},
  "error": null
}

Error Handling

[Description of error response format and common error codes]

Rate Limiting

[Description of rate limiting policies]

Endpoints

[Endpoint 1]

• URL: [endpoint path]
• Method: [HTTP Method]
• Description: [Endpoint description]

Request Parameters

• [parameter1]: [Description] - [Required/Optional]
• [parameter2]: [Description] - [Required/Optional]

Request Example

[HTTP request example]

Response Example

[JSON response example]

Error Responses

• Status Code: [Error code]
  • Condition: [When this error occurs]
  • Response Body: [Error response example]

## Component Documentation Template
```markdown
# Component: [Component Name]

## Purpose
[Description of what the component does and why it exists]

## Props/Parameters
- `[prop1]`: [Type] - [Description] - [Required/Optional]
- `[prop2]`: [Type] - [Description] - [Required/Optional]

## Behavior
[Description of component behavior, including states and interactions]

## Usage Examples
```[language]
[Usage example code]

Internal Structure

[Description of internal component organization]

Dependencies

Styling

[Description of styling approach and customization options]

Accessibility Considerations

[Description of accessibility features and considerations]

Testing

[Description of testing approach for this component]