Skip to content

Commit

Permalink
Add docs for create endpoint of agent (#62)
Browse files Browse the repository at this point in the history
  • Loading branch information
TalysonSoares authored Mar 21, 2024
1 parent 9068f1e commit b772d9a
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 2 deletions.
17 changes: 17 additions & 0 deletions public/docs/components/paths/agent/create.yaml
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 public/docs/components/requestBodies/agent/post-minimal.yaml
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)
6 changes: 4 additions & 2 deletions public/docs/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,12 @@ paths:
$ref: './components/paths/agent/find.yaml'
/api/agent/findOne:
$ref: './components/paths/agent/find-one.yaml'
/api/agent/getTypes:
$ref: './components/paths/agent/get-types.yaml'
/api/agent/getTypeGroups:
$ref: './components/paths/agent/get-type-groups.yaml'
/api/agent/getTypes:
$ref: './components/paths/agent/get-types.yaml'
/agent/index:
$ref: './components/paths/agent/create.yaml'
/api/event/describe:
$ref: './components/paths/event/describe.yaml'
/api/event/find:
Expand Down

0 comments on commit b772d9a

Please sign in to comment.