Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions docs/another-example.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
API Integration Guide

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) 🤖

Suggested change
API Integration Guide
"You wrote the API Integration Guide."

Copy link

Copilot AI Dec 15, 2025

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 '# API Integration Guide' to properly render as a heading.

Suggested change
API Integration Guide
# API Integration Guide

Copilot uses AI. Check for mistakes.

Authentication

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) 🤖

Suggested change
Authentication
"You authenticate."

Copy link

Copilot AI Dec 15, 2025

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.

Copilot uses AI. Check for mistakes.

To access the private endpoints, an API key is required.

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) 🤖

Suggested change
To access the private endpoints, an API key is required.
"You require an API key to access the private endpoints."

The key can be generated in the user settings dashboard.

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) 🤖

Suggested change
The key can be generated in the user settings dashboard.
You can generate the key in the user settings dashboard.

Once obtained, the key must be included in the header of every request.

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) 🤖

Suggested change
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."


Authorization: Bearer <YOUR_API_KEY>

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) 🤖

Suggested change
Authorization: Bearer <YOUR_API_KEY>
"You have provided the authorization: Bearer <YOUR_API_KEY>"

Copy link

Copilot AI Dec 15, 2025

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>

Copilot uses AI. Check for mistakes.


Creating a User

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) 🤖

Suggested change
Creating a User
"You create a User"

Copy link

Copilot AI Dec 15, 2025

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.

Suggested change
Creating a User
## Creating a User

Copilot uses AI. Check for mistakes.

A user is created by sending a POST request to /api/users.

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) 🤖

Suggested change
A user is created by sending a POST request to /api/users.
"You create a user by sending a POST request to /api/users."

The following JSON body is expected by the server:

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) 🤖

Suggested change
The following JSON body is expected by the server:
"You are expected to provide the following JSON body to the server:"


{

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) 🤖

Suggested change
{
{

"username": "jdoe",

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) 🤖

Suggested change
"username": "jdoe",
`"username": "jdoe","`

"email": "jdoe@example.com"

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) 🤖

Suggested change
"email": "jdoe@example.com"
`"email": "jdoe@example.com"`

}

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) 🤖

Suggested change
}
}

Comment on lines +17 to +20
Copy link

Copilot AI Dec 15, 2025

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

Copilot uses AI. Check for mistakes.


If the request is successful, a 201 Created status is returned.

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) 🤖

Suggested change
If the request is successful, a 201 Created status is returned.
"If the request is successful, you return a 201 Created status."

However, if the data is invalid, a 400 Bad Request error is thrown.

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) 🤖

Suggested change
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."


Rate Limiting

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) 🤖

Suggested change
Rate Limiting
"Rate Limiting"

Copy link

Copilot AI Dec 15, 2025

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.

Suggested change
Rate Limiting
## Rate Limiting

Copilot uses AI. Check for mistakes.

Requests are limited to 100 per minute.

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) 🤖

Suggested change
Requests are limited to 100 per minute.
"You are limited to 100 requests per minute."

If this limit is exceeded, the client is blocked for 60 seconds.

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) 🤖

Suggested change
If this limit is exceeded, the client is blocked for 60 seconds.
"You exceed this limit, we block the client for 60 seconds."