Pular para o conteúdo principal

API — Faq

Documentacao tecnica gerada automaticamente a partir da especificacao OpenAPI.


GET /api/faq

List Faqs

Parametros:

NomeTipoObrigatorioDescricao
pageintegerNao
page_sizeintegerNao
categorystringNao

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:

CampoTipoObrigatorioDescricao
questionstringSimQuestion
answerstringSimAnswer
categorystringNaoCategory
display_orderintegerNaoDisplay Order
is_activebooleanNaoIs 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:

NomeTipoObrigatorioDescricao
faq_idintegerSim

Corpo do pedido:

CampoTipoObrigatorioDescricao
questionobjectNaoQuestion
answerobjectNaoAnswer
categoryobjectNaoCategory
display_orderobjectNaoDisplay Order
is_activeobjectNaoIs 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:

NomeTipoObrigatorioDescricao
faq_idintegerSim

Resposta (204): Successful Response

Erros possiveis: 422 Validation Error


GET /api/storefront/faq

Public List Faqs

Parametros:

NomeTipoObrigatorioDescricao
categorystringNao

Exemplo resposta (200):

{
"items": [
"..."
],
"total": 0,
"page": 0,
"page_size": 0,
"pages": 0
}

Erros possiveis: 422 Validation Error


Documentacao gerada automaticamente.