API — Faq
Documentacao tecnica gerada automaticamente a partir da especificacao OpenAPI.
GET /api/faq
List Faqs
Parametros:
| Nome | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
| page | integer | Nao | — |
| page_size | integer | Nao | — |
| category | string | Nao | — |
Exemplo resposta (200):
{
"items": [
"..."
],
"total": 0,
"page": 0,
"page_size": 0,
"pages": 0
}
Erros possiveis: 422 Validation Error
POST /api/faq
Create Faq
Corpo do pedido:
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
| question | string | Sim | Question |
| answer | string | Sim | Answer |
| category | string | Nao | Category |
| display_order | integer | Nao | Display Order |
| is_active | boolean | Nao | Is Active |
Exemplo pedido:
{
"question": "string",
"answer": "string",
"category": "string",
"display_order": 0,
"is_active": true
}
Exemplo resposta (201):
{
"id": 0,
"question": "string",
"answer": "string",
"category": "string",
"display_order": 0,
"is_active": true,
"created_at": "string",
"updated_at": null
}
Erros possiveis: 422 Validation Error
PUT /api/faq/{faq_id}
Update Faq
Parametros:
| Nome | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
| faq_id | integer | Sim | — |
Corpo do pedido:
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
| question | object | Nao | Question |
| answer | object | Nao | Answer |
| category | object | Nao | Category |
| display_order | object | Nao | Display Order |
| is_active | object | Nao | Is Active |
Exemplo pedido:
{
"question": null,
"answer": null,
"category": null,
"display_order": null,
"is_active": null
}
Exemplo resposta (200):
{
"id": 0,
"question": "string",
"answer": "string",
"category": "string",
"display_order": 0,
"is_active": true,
"created_at": "string",
"updated_at": null
}
Erros possiveis: 422 Validation Error
DELETE /api/faq/{faq_id}
Delete Faq
Parametros:
| Nome | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
| faq_id | integer | Sim | — |
Resposta (204): Successful Response
Erros possiveis: 422 Validation Error
GET /api/storefront/faq
Public List Faqs
Parametros:
| Nome | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
| category | string | Nao | — |
Exemplo resposta (200):
{
"items": [
"..."
],
"total": 0,
"page": 0,
"page_size": 0,
"pages": 0
}
Erros possiveis: 422 Validation Error
Documentacao gerada automaticamente.