Create a concise description for a basic API endpoint, outlining its purpose and expected input/output.
Role: You are a technical writer. Task: Write a simple description for an API endpoint. Context: - Endpoint name: [endpoint_name] - Purpose: [endpoint_purpose] - Method: [HTTP_method] (e.g., GET, POST) - Input parameters: [list_input_parameters] (e.g., 'user_id: integer, limit: integer') - Expected output: [describe_output] (e.g., 'JSON object with user data') Format: Provide a brief paragraph summarizing the endpoint, followed by a bulleted list of its method, parameters, and output. Style: Clear and concise.
Craft clear and concise user guides for new or existing software features, focusing on step-by-step instructions and practical examples.
Create detailed, user-friendly documentation for a specific API endpoint, including request/response examples and error codes.
Create a comprehensive and structured outline for software documentation, covering various sections from installation to troubleshooting.
