-
Notifications
You must be signed in to change notification settings - Fork 0
Create another-example.md #6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,29 @@ | ||||||||||
| API Integration Guide | ||||||||||
|
||||||||||
| API Integration Guide | |
| # API Integration Guide |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sugestão de Voz Ativa (AI) 🤖
| Authentication | |
| "You authenticate." |
Copilot
AI
Dec 15, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing markdown heading syntax. This should be formatted as '## Authentication' to properly render as a section heading.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sugestão de Voz Ativa (AI) 🤖
| To access the private endpoints, an API key is required. | |
| "You require an API key to access the private endpoints." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sugestão de Voz Ativa (AI) 🤖
| The key can be generated in the user settings dashboard. | |
| You can generate the key in the user settings dashboard. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sugestão de Voz Ativa (AI) 🤖
| Once obtained, the key must be included in the header of every request. | |
| "You must include the key in the header of every request once you have obtained it." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sugestão de Voz Ativa (AI) 🤖
| Authorization: Bearer <YOUR_API_KEY> | |
| "You have provided the authorization: Bearer <YOUR_API_KEY>" |
Copilot
AI
Dec 15, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing markdown code formatting. This header example should be wrapped in backticks or a code block to distinguish it as a literal example, e.g., Authorization: Bearer <YOUR_API_KEY>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sugestão de Voz Ativa (AI) 🤖
| Creating a User | |
| "You create a User" |
Copilot
AI
Dec 15, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing markdown heading syntax. This should be formatted as '## Creating a User' to properly render as a section heading.
| Creating a User | |
| ## Creating a User |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sugestão de Voz Ativa (AI) 🤖
| A user is created by sending a POST request to /api/users. | |
| "You create a user by sending a POST request to /api/users." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sugestão de Voz Ativa (AI) 🤖
| The following JSON body is expected by the server: | |
| "You are expected to provide the following JSON body to the server:" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sugestão de Voz Ativa (AI) 🤖
| { | |
| { | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sugestão de Voz Ativa (AI) 🤖
| "username": "jdoe", | |
| `"username": "jdoe","` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sugestão de Voz Ativa (AI) 🤖
| "email": "jdoe@example.com" | |
| `"email": "jdoe@example.com"` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sugestão de Voz Ativa (AI) 🤖
| } | |
| } | |
Copilot
AI
Dec 15, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing markdown code block formatting. This JSON example should be wrapped in triple backticks with the json language identifier for proper syntax highlighting, e.g., ```json
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sugestão de Voz Ativa (AI) 🤖
| If the request is successful, a 201 Created status is returned. | |
| "If the request is successful, you return a 201 Created status." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sugestão de Voz Ativa (AI) 🤖
| However, if the data is invalid, a 400 Bad Request error is thrown. | |
| "However, if the data is invalid, you throw a 400 Bad Request error." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sugestão de Voz Ativa (AI) 🤖
| Rate Limiting | |
| "Rate Limiting" |
Copilot
AI
Dec 15, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing markdown heading syntax. This should be formatted as '## Rate Limiting' to properly render as a section heading.
| Rate Limiting | |
| ## Rate Limiting |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sugestão de Voz Ativa (AI) 🤖
| Requests are limited to 100 per minute. | |
| "You are limited to 100 requests per minute." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sugestão de Voz Ativa (AI) 🤖
| If this limit is exceeded, the client is blocked for 60 seconds. | |
| "You exceed this limit, we block the client for 60 seconds." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sugestão de Voz Ativa (AI) 🤖