docs: preview platform api handoff

This commit is contained in:
Gui Vieira
2026-06-23 13:39:57 -03:00
parent 2eb4e3a236
commit 3f5ca89edc
7 changed files with 213 additions and 0 deletions

View File

@@ -0,0 +1,17 @@
---
code: bad_request
title: Bad request
status: 400
---
# Bad request
The request could not be processed because it was malformed or missing required request data.
## When It Happens
This usually means the request body, query string, headers, or required parameters are invalid before endpoint-specific validation can run.
## How To Fix
Review the endpoint contract, required parameters, request body shape, and content type before retrying.

View File

@@ -0,0 +1,17 @@
---
code: internal_error
title: Internal error
status: 500
---
# Internal error
An unexpected server-side failure prevented the request from completing.
## When It Happens
This means the platform encountered an unexpected condition while processing a valid request.
## How To Fix
Retry the request after a short delay. If the problem continues, contact support with the request details and timestamp.

View File

@@ -0,0 +1,17 @@
---
code: not_found
title: Not found
status: 404
---
# Not found
The requested resource does not exist or is not available at the requested path.
## When It Happens
This can happen when the URL is incorrect, the resource identifier does not exist, or the resource is not visible through the public API.
## How To Fix
Check the endpoint path and resource identifier, then retry with a resource that exists and is available to the request.

View File

@@ -0,0 +1,17 @@
---
code: validation_error
title: Validation error
status: 422
---
# Validation error
The request was understood, but one or more submitted values failed validation.
## When It Happens
This usually means a submitted field is missing, malformed, out of range, duplicated, or conflicts with another value.
## How To Fix
Inspect the `detail` message for the field-specific issue, update the submitted values, and retry the request.