forked from mapasculturais/mapasculturais
-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add docs for create endpoint of agent (#62)
- Loading branch information
1 parent
9068f1e
commit b772d9a
Showing
3 changed files
with
48 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
post: | ||
tags: | ||
- Agentes | ||
summary: Cria um agente | ||
description: Cria um agente | ||
requestBody: | ||
content: | ||
application/json: | ||
schema: | ||
$ref: '../../requestBodies/agent/post-minimal.yaml' | ||
responses: | ||
'200': | ||
description: O agente criado | ||
content: | ||
application/json: | ||
schema: | ||
$ref: '../../schemas/agent.yaml' |
27 changes: 27 additions & 0 deletions
27
public/docs/components/requestBodies/agent/post-minimal.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
type: object | ||
properties: | ||
name: | ||
type: string | ||
example: "Nome do agente" | ||
description: Nome do agente | ||
shortDescription: | ||
type: string | ||
example: "Uma breve descrição do agente" | ||
description: Uma breve descrição do agente | ||
status: | ||
type: integer | ||
example: 1 | ||
description: Status do agente | ||
terms: | ||
type: object | ||
properties: | ||
area: | ||
type: array | ||
items: | ||
type: string | ||
example: [ "Música" ] | ||
description: Áreas relacionadas ao agente | ||
type: | ||
type: integer | ||
example: 1 | ||
description: Tipo do agente (1 - Individual, 2 - Coletivo) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters