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

[gitauto-ai[bot]]

Resolves guibranco/gstraccini-bot-api#7

What is the feature

The feature is to add a new API endpoint that allows users to retrieve a list of available commands in both Markdown and HTML formats. This will facilitate easier integration with documentation and web platforms.

Why we need the feature

1. Consistency: A dedicated endpoint ensures that command 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: Enhances the developer experience by providing access to up-to-date command documentation directly from the API.

How to implement and why

1. Define the Endpoint: Create a new endpoint, such as /commands, in the API to handle requests for command lists.

   • This endpoint will accept a query parameter format to specify the desired output format (markdown or html).

2. Data Structure: Define a data structure to store command information, including command name, description, parameters, and examples.

   • This structure will be used to generate the output in the requested format.

3. Format Conversion: Implement logic to convert the command data into Markdown and HTML formats.

   • Use template strings or a templating engine to format the data appropriately for each output type.

4. Response Handling: Ensure the endpoint returns the formatted data with appropriate HTTP headers to indicate the content type (e.g., text/markdown or text/html).

5. Versioning Support: Consider adding versioning support to the endpoint to provide different command lists for various API versions.

   • This can be achieved by including a version parameter in the request or by structuring the endpoint to handle different versions.

6. Documentation: Update the API documentation to include details about the new endpoint, its parameters, and sample responses.

About backward compatibility

The addition of this new endpoint does not affect existing functionality, so backward compatibility is maintained. Existing endpoints and features will continue to operate as before, ensuring that current users are not impacted by this change.

Test these changes locally

git checkout -b gitauto/issue-#545-75007f01-de49-4d41-a574-6adc203337c4
git pull origin gitauto/issue-#545-75007f01-de49-4d41-a574-6adc203337c4

[coderabbitai[bot]]

[!IMPORTANT]

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

[deepsource-io[bot]]

Here's the code health analysis summary for commits b8fce37..a548efe. View details on DeepSource ↗.

Analysis Summary

Analyzer	Status	Summary	Link
Docker	✅ Success		View Check ↗
PHP	✅ Success		View Check ↗
Secrets	✅ Success		View Check ↗
SQL	✅ Success		View Check ↗

---

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

[guibranco]

@gstraccini codacy bypass

[gstraccini[bot]]

Bypassing the Codacy analysis for this pull request! :warning:

[gstraccini[bot]]

This pull request is ready ✅ for merge/squash.

[guibranco]

@gstraccini codacy bypass

[gstraccini[bot]]

Bypassing the Codacy analysis for this pull request! :warning:

[sonarcloud[bot]]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[github-actions[bot]]

Infisical secrets check: ✅ No secrets leaked!

💻 Scan logs

```txt 10:44PM INF scanning for exposed secrets... 10:44PM INF 530 commits scanned. 10:44PM INF scan completed in 135ms 10:44PM INF no leaks found ```

[guibranco]

@gstraccini codacy bypass

[gstraccini[bot]]

Bypassing the Codacy analysis for this pull request! :warning: