From 9068f1e11db1c39f7b427712a616b8921d7ba702 Mon Sep 17 00:00:00 2001
From: Ana Kelly Moura Balbino
 <101601082+Akellymourab@users.noreply.github.com>
Date: Thu, 21 Mar 2024 14:21:09 -0300
Subject: [PATCH] Adds documentation of seals crate, update and delete. (#61)

---
 public/docs/components/paths/seal/create.yaml | 17 ++++++++
 public/docs/components/paths/seal/delete.yaml | 41 +++++++++++++++++++
 public/docs/components/paths/seal/patch.yaml  | 25 +++++++++++
 public/docs/components/paths/seal/put.yaml    | 30 ++++++++++++++
 .../paths/seal/route-single-id.yaml           |  8 ++++
 .../requestBodies/seal/post-minimal.yaml      | 18 ++++++++
 public/docs/openapi.yaml                      |  4 ++
 7 files changed, 143 insertions(+)
 create mode 100644 public/docs/components/paths/seal/create.yaml
 create mode 100644 public/docs/components/paths/seal/delete.yaml
 create mode 100644 public/docs/components/paths/seal/patch.yaml
 create mode 100644 public/docs/components/paths/seal/put.yaml
 create mode 100644 public/docs/components/paths/seal/route-single-id.yaml
 create mode 100644 public/docs/components/requestBodies/seal/post-minimal.yaml

diff --git a/public/docs/components/paths/seal/create.yaml b/public/docs/components/paths/seal/create.yaml
new file mode 100644
index 0000000000..28b98a4a54
--- /dev/null
+++ b/public/docs/components/paths/seal/create.yaml
@@ -0,0 +1,17 @@
+post:
+  tags:
+    - Selos
+  summary: Cria um selo
+  description: Cria um selo
+  requestBody:
+    content:
+      application/json:
+        schema:
+          $ref: '../../requestBodies/seal/post-minimal.yaml'
+  responses:
+    '200':
+      description: O selo criado
+      content:
+        application/json:
+          schema:
+            $ref: '../../schemas/seal.yaml'
diff --git a/public/docs/components/paths/seal/delete.yaml b/public/docs/components/paths/seal/delete.yaml
new file mode 100644
index 0000000000..4a988bdfd0
--- /dev/null
+++ b/public/docs/components/paths/seal/delete.yaml
@@ -0,0 +1,41 @@
+tags:
+  - Selos
+summary: Apaga um selo
+description: Apaga um selo
+parameters:
+  - in: path
+    name: id
+    schema:
+      type: integer
+    required: true
+    description: Identificador do selo
+responses:
+  '200':
+    description: Informações sobre o objeto apagado
+    content:
+      application/json:
+        schema:
+          type: object
+          properties:
+            '@entityType':
+              type: string
+              example: seal
+              description: Tipo de entidade
+            id:
+              type: integer
+              example: 3
+              description: Um id numérico que representa o selo
+            name:
+              type: string
+              example: selo teste
+              description: Um texto que representa o nome do selo
+            type:
+              type: integer
+              example: null
+              description: Tipo do selo
+            status:
+              type: integer
+              example: -10
+              description: Status do selo
+  '404':
+    $ref: '../../responses/error/404.yaml'
diff --git a/public/docs/components/paths/seal/patch.yaml b/public/docs/components/paths/seal/patch.yaml
new file mode 100644
index 0000000000..55055027bc
--- /dev/null
+++ b/public/docs/components/paths/seal/patch.yaml
@@ -0,0 +1,25 @@
+tags:
+  - Selos
+summary: Atualiza um selo
+description: Atualiza um selo
+parameters:
+  - in: path
+    name: id
+    schema:
+      type: integer
+    required: true
+    description: Identificador do selo
+requestBody:
+  content:
+    application/json:
+      schema:
+        $ref: '../../requestBodies/seal/post-minimal.yaml'
+responses:
+  '200':
+    description: O selo atualizado
+    content:
+      application/json:
+        schema:
+          $ref: '../../schemas/seal.yaml'
+  '404':
+    $ref: '../../responses/error/404.yaml'
diff --git a/public/docs/components/paths/seal/put.yaml b/public/docs/components/paths/seal/put.yaml
new file mode 100644
index 0000000000..e4f46041a4
--- /dev/null
+++ b/public/docs/components/paths/seal/put.yaml
@@ -0,0 +1,30 @@
+tags:
+  - Selos
+summary: Atualiza um selo
+description: Atualiza um selo
+parameters:
+  - in: put
+    name: id
+    schema:
+      type: integer
+    required: true
+    description: Identificador do selo
+requestBody:
+  content:
+    application/json:
+      schema:
+        type: object
+        properties:
+          name:
+            type: string
+            example: Selo teste
+            description: Nome do selo
+responses:
+  '200':
+    description: O selo atualizado
+    content:
+      application/json:
+        schema:
+          $ref: '../../schemas/seal.yaml'
+  '404':
+    $ref: '../../responses/error/404.yaml'
diff --git a/public/docs/components/paths/seal/route-single-id.yaml b/public/docs/components/paths/seal/route-single-id.yaml
new file mode 100644
index 0000000000..b934a6529c
--- /dev/null
+++ b/public/docs/components/paths/seal/route-single-id.yaml
@@ -0,0 +1,8 @@
+tags:
+  - Selos
+patch:
+  $ref: './patch.yaml'
+put:
+  $ref: './put.yaml'
+delete:
+  $ref: './delete.yaml'
diff --git a/public/docs/components/requestBodies/seal/post-minimal.yaml b/public/docs/components/requestBodies/seal/post-minimal.yaml
new file mode 100644
index 0000000000..1d36de9825
--- /dev/null
+++ b/public/docs/components/requestBodies/seal/post-minimal.yaml
@@ -0,0 +1,18 @@
+type: object
+properties:
+  name:
+    type: string
+    example: Selo teste
+    description: Nome do Selo
+  shortDescription:
+    type: string
+    example: apenas um Selo teste
+    description: Uma breve descrição do Selo
+  validPeriod:
+    type: integer
+    example: 1
+    description: Período de validade do selo
+  owner:
+    type: integer
+    example: 1
+    description: Usuario proprietário do selo
diff --git a/public/docs/openapi.yaml b/public/docs/openapi.yaml
index fbd9186d69..083dc97af2 100644
--- a/public/docs/openapi.yaml
+++ b/public/docs/openapi.yaml
@@ -87,6 +87,10 @@ paths:
     $ref: './components/paths/seal/get-type-groups.yaml'
   /api/seal/getTypes:
     $ref: './components/paths/seal/get-types.yaml'
+  /seal/index:
+    $ref: './components/paths/seal/create.yaml'
+  /seal/single/{id}:
+    $ref: './components/paths/seal/route-single-id.yaml'
   /api/space/describe:
     $ref: './components/paths/space/describe.yaml'
   /api/space/find: