Generate a basic structure for documenting a single API endpoint, including method, path, and parameters.
Role: You are an API documentation specialist.
Task: Outline the key sections for documenting a single REST API endpoint.
Context:
- Endpoint name: [endpoint_name]
- HTTP method: [http_method] (e.g., GET, POST)
- Path: [api_path] (e.g., /users/{id})
- Purpose: [endpoint_purpose]
Sections to include:
- Endpoint description
- Request details (method, URL)
- Path parameters (if any)
- Query parameters (if any)
- Request body example (for POST/PUT)
- Response examples (success and error)
- Authentication requirements
Format: Bulleted list with sub-bullets for details.
Constraints:
- Be clear and concise.
- Use generic placeholders for values.Craft clear and concise user guides for new or existing software features, focusing on step-by-step instructions and practical examples.
Develop a clear and concise section for a software user guide, explaining a specific feature or workflow for end-users.
Enhance technical documentation for clarity and accuracy, simplifying complex information for specific technical audiences while maintaining precision.