From cd67c1b044e12b1f712432520eff9a84475ff2fa Mon Sep 17 00:00:00 2001
From: Sara Camilo <124682717+saracamilodev@users.noreply.github.com>
Date: Fri, 22 Mar 2024 14:02:46 -0300
Subject: [PATCH] created docs on create, patch and delete event (#65)

---
 .../docs/components/paths/event/create.yaml   | 17 +++++++
 .../docs/components/paths/event/delete.yaml   | 38 ++++++++++++++++
 public/docs/components/paths/event/patch.yaml | 29 ++++++++++++
 .../paths/event/route-single-id.yaml          |  6 +++
 .../requestBodies/event/post-minimal.yaml     | 45 +++++++++++++++++++
 public/docs/openapi.yaml                      |  4 ++
 6 files changed, 139 insertions(+)
 create mode 100644 public/docs/components/paths/event/create.yaml
 create mode 100644 public/docs/components/paths/event/delete.yaml
 create mode 100644 public/docs/components/paths/event/patch.yaml
 create mode 100644 public/docs/components/paths/event/route-single-id.yaml
 create mode 100644 public/docs/components/requestBodies/event/post-minimal.yaml

diff --git a/public/docs/components/paths/event/create.yaml b/public/docs/components/paths/event/create.yaml
new file mode 100644
index 0000000000..cc18e5b069
--- /dev/null
+++ b/public/docs/components/paths/event/create.yaml
@@ -0,0 +1,17 @@
+post:
+  tags:
+    - Eventos
+  summary: Cria um evento
+  description: Cria um novo evento com as informações fornecidas
+  requestBody:
+    content:
+      application/json:
+        schema:
+          $ref: '../../requestBodies/event/post-minimal.yaml'
+  responses:
+    '201':
+      description: Evento criado com sucesso
+      content:
+        application/json:
+          schema:
+            $ref: '../../schemas/event.yaml'
diff --git a/public/docs/components/paths/event/delete.yaml b/public/docs/components/paths/event/delete.yaml
new file mode 100644
index 0000000000..894910ce5b
--- /dev/null
+++ b/public/docs/components/paths/event/delete.yaml
@@ -0,0 +1,38 @@
+delete:
+  tags:
+    - Eventos
+  summary: Apaga um evento
+  description: Apaga um evento baseado no ID fornecido.
+  parameters:
+    - in: path
+      name: id
+      schema:
+        type: integer
+        required: true
+        description: Identificador único do evento.
+  responses:
+    '200':
+      description: Informações sobre o evento apagado.
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              '@entityType':
+                type: string
+                example: event
+                description: Tipo de entidade.
+              id:
+                type: integer
+                example: 10
+                description: Um id numérico que representa o evento.
+              name:
+                type: string
+                example: "Festival de Verão"
+                description: Nome do evento.
+              status:
+                type: integer
+                example: -10
+                description: Status do evento após ser apagado.
+    '404':
+      $ref: '../../responses/error/404.yaml'
diff --git a/public/docs/components/paths/event/patch.yaml b/public/docs/components/paths/event/patch.yaml
new file mode 100644
index 0000000000..2e27d0fd8d
--- /dev/null
+++ b/public/docs/components/paths/event/patch.yaml
@@ -0,0 +1,29 @@
+patch:
+tags:
+  - Eventos
+summary: Atualiza um evento
+description: Atualiza os detalhes de um evento existente.
+parameters:
+  - in: path
+    name: id
+    schema:
+      type: integer
+      required: true
+      description: Identificador único do evento.
+requestBody:
+  content:
+    application/json:
+      schema:
+        $ref: '../../requestBodies/event/post-minimal.yaml'
+responses:
+  '200':
+    description: Evento atualizado com sucesso.
+    content:
+      application/json:
+        schema:
+          $ref: '../../schemas/event.yaml'
+  '400':
+    description: Requisição inválida, por exemplo, campos não preenchidos corretamente.
+  '404':
+    description: Evento não encontrado.
+    $ref: '../../responses/error/404.yaml'
\ No newline at end of file
diff --git a/public/docs/components/paths/event/route-single-id.yaml b/public/docs/components/paths/event/route-single-id.yaml
new file mode 100644
index 0000000000..441f729025
--- /dev/null
+++ b/public/docs/components/paths/event/route-single-id.yaml
@@ -0,0 +1,6 @@
+tags:
+  - Eventos
+patch:
+  $ref: './patch.yaml'
+delete:
+  $ref: './delete.yaml'
\ No newline at end of file
diff --git a/public/docs/components/requestBodies/event/post-minimal.yaml b/public/docs/components/requestBodies/event/post-minimal.yaml
new file mode 100644
index 0000000000..f58ff23f71
--- /dev/null
+++ b/public/docs/components/requestBodies/event/post-minimal.yaml
@@ -0,0 +1,45 @@
+post:
+  tags:
+    - Eventos
+  summary: Cria um evento
+  description: Cria um novo evento com as informações fornecidas
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          type: object
+          required:
+            - name
+            - shortDescription
+            - classificacaoEtaria
+          properties:
+            name:
+              type: string
+              description: "Nome do evento"
+            shortDescription:
+              type: string
+              description: "Descrição curta do evento"
+            classificacaoEtaria:
+              type: object
+              properties:
+                options:
+                  type: array
+                  items:
+                    type: string
+                  description: "Classificação etária do evento"
+            term-linguagem:
+              type: array
+              items:
+                type: string
+              description: "Linguagens do evento"
+  responses:
+    '201':
+      description: Evento criado com sucesso
+      content:
+        application/json:
+          schema:
+            $ref: '../../schemas/event.yaml'
+    '400':
+      description: Dados inválidos fornecidos
+
diff --git a/public/docs/openapi.yaml b/public/docs/openapi.yaml
index 7fe70eb82a..4d5b6e502f 100644
--- a/public/docs/openapi.yaml
+++ b/public/docs/openapi.yaml
@@ -55,6 +55,10 @@ paths:
     $ref: './components/paths/event/get-type-groups.yaml'
   /api/event/getTypes:
     $ref: './components/paths/event/get-types.yaml'
+  /api/event/create:
+    $ref: './components/paths/event/create.yaml'
+  /event/single/{id}:
+    $ref: './components/paths/event/route-single-id.yaml'
   /api/opportunity/describe:
     $ref: './components/paths/opportunity/describe.yaml'
   /api/opportunity/find: