PT EN

Opiniões sobre a documentação

URL base: $PUBLIC_API

O objecto

idstring · obrigatório

Feedback identifier

pathstring · obrigatório

Documentation page path

helpfulboolean · obrigatório

The recorded vote

created_atstring (date-time) · obrigatório

When the vote was recorded

O objecto
{
  "id": "pub_2eq3dMuVtYiTfmIR9oS1XKax9Ys",
  "path": "path",
  "helpful": true,
  "created_at": "2026-11-19T09:30:00Z"
}

Avaliar uma página da documentação

Registos

POST /docs-feedback

Records an anonymous helpful or unhelpful vote on a documentation page, with an optional comment. path must start with /, be at most 256 characters and contain no "..", "?" or "#"; helpful is required; comment is at most 500 characters; locale is pt (default) or en. The body is at most 4096 bytes (413 PAYLOAD_TOO_LARGE). When the installation uses its built-in bot challenge, an anonymous UI request must carry challenge_token (scope intake.docs_feedback): a missing token returns 403 CHALLENGE_REQUIRED and a rejected one 403 CHALLENGE_FAILED; a signed-in caller, or an installation using an external challenge provider, is not asked for a token. At most 20 votes per IP address are accepted per hour; beyond that the response is 429 RATE_LIMITED with Retry-After.

Corpo application/json

pathstring · obrigatório

Documentation page path; starts with / and contains no "..", "?" or "#"

helpfulboolean · obrigatório

True when the page was helpful

commentstring · opcional

Optional comment

localestring · opcional · predefinição pt

Language of the page

um de pt, en

challenge_tokenstring · opcional

Bot-challenge token when the built-in challenge is enabled (anonymous callers). Only UI requests (browser headers, the dashboard, or X-Client mobile or desktop) are challenged; API requests never are.

Devolve

201 Feedback recorded

Mostrar atributos
idstring · obrigatório

Feedback identifier

pathstring · obrigatório

Documentation page path

helpfulboolean · obrigatório

The recorded vote

created_atstring (date-time) · obrigatório

When the vote was recorded

Erros 400 · 403 · 413 · 429

curl -X POST "$PUBLIC_API/docs-feedback" \
  -H "Content-Type: application/json" \
  -d '{
  "path": "/docs/api/authentication",
  "helpful": true,
  "comment": "comment",
  "locale": "pt",
  "challenge_token": "challenge token"
}'
Resposta 201
{
  "id": "pub_2eq3dMuVtYiTfmIR9oS1XKax9Ys",
  "path": "path",
  "helpful": true,
  "created_at": "2026-11-19T09:30:00Z"
}