The API should have an endpoint to list commands in markdown and HTML format.

[guibranco]

Description

The API should provide an endpoint that allows users to retrieve a list of available commands in two formats:

• Markdown: For easier integration with documentation and markdown-based platforms.
• HTML: To enable seamless embedding within web applications and other HTML-based platforms.

Rationale

1. Consistency: Having a dedicated endpoint for listing commands ensures that the documentation can be programmatically generated and updated as new commands are introduced.
2. Ease of Integration: Markdown and HTML are widely used formats, making it easier to embed or display commands in various platforms such as GitHub, websites, or help docs.
3. Developer Experience: Providing this endpoint enhances the developer experience by allowing access to up-to-date command documentation directly from the API.

Expected Behavior

1. A new endpoint, such as /commands, returns a list of commands in the requested format (markdown or html).
2. The response should include:
   • Command name
   • Command description
   • Parameters (if applicable)
   • Examples (if available)

API Example

GET /commands?format=markdown

Sample Responses

Markdown Format

## Available Commands
### /start
- **Description**: Initializes the process.
- **Parameters**: None

### /stop
- **Description**: Stops the current process.
- **Parameters**: `force` (optional): boolean, whether to force stop.

HTML Format

<h2>Available Commands</h2>
<h3>/start</h3>
<p><strong>Description:</strong> Initializes the process.</p>
<p><strong>Parameters:</strong> None</p>

<h3>/stop</h3>
<p><strong>Description:</strong> Stops the current process.</p>
<p><strong>Parameters:</strong> <code>force</code> (optional): boolean, whether to force stop.</p>

Additional Notes

• Consider adding versioning support to the endpoint to provide different command lists for various API versions.
• The command descriptions should be regularly updated to reflect any changes in behavior or usage.
• The API code should be written in plain PHP.

[gitauto-ai[bot]]

Hello @guibranco, you have reached your request limit of 5, your cycle will refresh on 2024-09-21 10:07:38+00:00. Consider subscribing if you want more requests. If you have any questions or concerns, please contact us at info@gitauto.ai.

[gitauto-ai[bot]]

@guibranco Pull request completed! Check it out here https://github.com/guibranco/gstraccini-bot/pull/589 🚀 Should you have any questions or wish to change settings or limits, please feel free to contact info@gitauto.ai or invite us to Slack Connect.

[gitauto-ai[bot]]

Hello @guibranco, you have reached your request limit of 5, your cycle will refresh on 2024-10-21 10:07:38+00:00. Consider subscribing if you want more requests. If you have any questions or concerns, please contact us at info@gitauto.ai.