fix(openapi): Uniformize

dataesr · Jan 9, 2024 · 96fd9ef · 96fd9ef
1 parent d7b3f40
commit 96fd9ef
Show file tree

Hide file tree

Showing 32 changed files with 58 additions and 186 deletions.
diff --git a/src/openapi/paths/apikeys/apikeys.yml b/src/openapi/paths/apikeys/apikeys.yml
@@ -10,7 +10,7 @@ collectionMethods:
         - $ref: '../../api.yml#/components/parameters/sort'
     responses:
       '200':
-        description: Success
+        description: OK
         content:
           application/json:
             schema:
@@ -21,7 +21,7 @@ collectionMethods:
                   items:
                     $ref: '../../api.yml#/components/schemas/ApiKey'
                 totalCount:
-                  type: number
+                  type: integer
       '400':
         $ref: '../../api.yml#/components/responses/BadRequest'
       '401':

diff --git a/src/openapi/paths/auth/recovery.yml b/src/openapi/paths/auth/recovery.yml
@@ -36,7 +36,7 @@ post:
               pattern: ^(?=.*[A-Za-z])(?=.*\d)(?=.*[!"#$%&'()*+,\-./:;<=>?@[\]^_`{|}~])[A-Za-z\d!"#$%&'()*+,\-./:;<=>?@[\]^_`{|}~]{8,}$
   responses:
     '200':
-      description: Success
+      description: OK
       content:
         application/json:
           schema:

diff --git a/src/openapi/paths/auth/signout.yml b/src/openapi/paths/auth/signout.yml
@@ -4,7 +4,7 @@ post:
   summary: Sign a user out
   responses:
     '204':
-      description: Success
+      description: OK
       content:
         application/json:
           schema:

diff --git a/src/openapi/paths/categories/categories.yml b/src/openapi/paths/categories/categories.yml
@@ -10,7 +10,7 @@ collectionMethods:
         - $ref: '../../api.yml#/components/parameters/sort'
     responses:
       '200':
-        description: Success
+        description: OK
         content:
           application/json:
             schema:
@@ -21,7 +21,7 @@ collectionMethods:
                   items:
                     $ref: '../../api.yml#/components/schemas/Category'
                 totalCount:
-                  type: number
+                  type: integer
       '400':
         $ref: '../../api.yml#/components/responses/BadRequest'
       '401':

diff --git a/src/openapi/paths/categories/identifiers.yml b/src/openapi/paths/categories/identifiers.yml
@@ -80,7 +80,7 @@ documentMethods:
       - $ref: '../../api.yml#/components/parameters/identifierId'
     responses:
       '200':
-        description: Success
+        description: OK
         content:
           application/json:
             schema:

diff --git a/src/openapi/paths/documents/documents.yml b/src/openapi/paths/documents/documents.yml
@@ -73,7 +73,7 @@ documentMethods:
       - $ref: '../../api.yml#/components/parameters/documentId'
     responses:
       '200':
-        description: Success
+        description: OK
         content:
           application/json:
             schema:

diff --git a/src/openapi/paths/followups/followups.yml b/src/openapi/paths/followups/followups.yml
@@ -70,7 +70,7 @@ documentMethods:
       - $ref: '../../api.yml#/components/parameters/followUpId'
     responses:
       '200':
-        description: Success
+        description: OK
         content:
           application/json:
             schema:

diff --git a/src/openapi/paths/geographicalcategories/geographicalcategories.yml b/src/openapi/paths/geographicalcategories/geographicalcategories.yml
@@ -10,7 +10,7 @@ collectionMethods:
         - $ref: '../../api.yml#/components/parameters/sort'
     responses:
       '200':
-        description: Success
+        description: OK
         content:
           application/json:
             schema:
@@ -21,7 +21,7 @@ collectionMethods:
                   items:
                     $ref: '../../api.yml#/components/schemas/GeographicalCategory'
                 totalCount:
-                  type: number
+                  type: integer
       '400':
         $ref: '../../api.yml#/components/responses/BadRequest'
       '401':

diff --git a/src/openapi/paths/geographicalcategories/structures-from-categories.yml b/src/openapi/paths/geographicalcategories/structures-from-categories.yml
@@ -5,10 +5,10 @@ collectionMethods:
       - Geographical categories - Structures
     summary: List structures from a geographical category
     parameters:
-      - $ref: '../../api.yml#/components/parameters/filters'
-      - $ref: '../../api.yml#/components/parameters/skip'
-      - $ref: '../../api.yml#/components/parameters/limit'
-      - $ref: '../../api.yml#/components/parameters/sort'
+        - $ref: '../../api.yml#/components/parameters/filters'
+        - $ref: '../../api.yml#/components/parameters/skip'
+        - $ref: '../../api.yml#/components/parameters/limit'
+        - $ref: '../../api.yml#/components/parameters/sort'
     responses:
       '200':
         description: OK

diff --git a/src/openapi/paths/groups/groups.yml b/src/openapi/paths/groups/groups.yml
@@ -10,7 +10,7 @@ collectionMethods:
         - $ref: '../../api.yml#/components/parameters/sort'
     responses:
       '200':
-        description: Success
+        description: OK
         content:
           application/json:
             schema:
@@ -21,7 +21,7 @@ collectionMethods:
                   items:
                     $ref: '../../api.yml#/components/schemas/Group'
                 totalCount:
-                  type: number
+                  type: integer
       '400':
         $ref: '../../api.yml#/components/responses/BadRequest'
       '401':

diff --git a/src/openapi/paths/groups/members.yml b/src/openapi/paths/groups/members.yml
@@ -10,7 +10,7 @@ collectionMethods:
         - $ref: '../../api.yml#/components/parameters/sort'
     responses:
       '200':
-        description: Success
+        description: OK
         content:
           application/json:
             schema:
@@ -21,7 +21,7 @@ collectionMethods:
                   items:
                     $ref: '../../api.yml#/components/schemas/GroupMember'
                 totalCount:
-                  type: number
+                  type: integer
       '400':
         $ref: '../../api.yml#/components/responses/BadRequest'
       '401':

diff --git a/src/openapi/paths/jobs/jobs.yml b/src/openapi/paths/jobs/jobs.yml
@@ -10,7 +10,7 @@ collectionMethods:
         - $ref: '../../api.yml#/components/parameters/sort'
     responses:
       '200':
-        description: Success
+        description: OK
         content:
           application/json:
             schema:
@@ -21,7 +21,7 @@ collectionMethods:
                 aggregations:
                   type: object
                 totalCount:
-                  type: number
+                  type: integer
       '400':
         $ref: '../../api.yml#/components/responses/BadRequest'
       '401':
@@ -30,131 +30,3 @@ collectionMethods:
         $ref: '../../api.yml#/components/responses/Forbidden'
       '500':
         $ref: '../../api.yml#/components/responses/ServerError'
-
-#   post:
-#     tags:
-#       - Job
-#     summary: Create a new person
-#     requestBody:
-#       content:
-#         application/json:
-#           schema:
-#             title: CreatePerson
-#             type: object
-#             required:
-#               - lastName
-#             allOf:
-#               - $ref: '../../api.yml#/components/schemas/PersonBulkInsertPayload'
-#     responses:
-#       '201':
-#         description: Created
-#         content:
-#           application/json:
-#             schema:
-#               $ref: '../../api.yml#/components/schemas/Person'
-#       '400':
-#         $ref: '../../api.yml#/components/responses/BadRequest'
-#       '401':
-#         $ref: '../../api.yml#/components/responses/Unauthorized'
-#       '403':
-#         $ref: '../../api.yml#/components/responses/Forbidden'
-#       '500':
-#         $ref: '../../api.yml#/components/responses/ServerError'
-
-# documentMethods:
-#   get:
-#     tags:
-#       - Persons
-#     summary: Get a person by ID
-#     parameters:
-#       - $ref: '../../api.yml#/components/parameters/personId'
-#     responses:
-#       '200':
-#         description: OK
-#         content:
-#           application/json:
-#             schema:
-#               $ref: '../../api.yml#/components/schemas/Person'
-#       '401':
-#         $ref: '../../api.yml#/components/responses/Unauthorized'
-#       '403':
-#         $ref: '../../api.yml#/components/responses/Forbidden'
-#       '404':
-#         $ref: '../../api.yml#/components/responses/NotFound'
-#       '500':
-#         $ref: '../../api.yml#/components/responses/ServerError'
-
-
-#   patch:
-#     tags:
-#       - Persons
-#     summary: Update a person by ID
-#     parameters:
-#       - $ref: '../../api.yml#/components/parameters/personId'
-#     requestBody:
-#       content:
-#         application/json:
-#           schema:
-#               $ref: '../../api.yml#/components/schemas/PersonPayload'
-#     responses:
-#       '200':
-#         description: OK
-#         content:
-#           application/json:
-#             schema:
-#               $ref: '../../api.yml#/components/schemas/Person'
-#       '400':
-#         $ref: '../../api.yml#/components/responses/BadRequest'
-#       '401':
-#         $ref: '../../api.yml#/components/responses/Unauthorized'
-#       '403':
-#         $ref: '../../api.yml#/components/responses/Forbidden'
-#       '404':
-#         $ref: '../../api.yml#/components/responses/NotFound'
-#       '500':
-#         $ref: '../../api.yml#/components/responses/ServerError'
-
-#   delete:
-#     tags:
-#       - Persons
-#     summary: Delete a person by ID
-#     parameters:
-#       - $ref: '../../api.yml#/components/parameters/personId'
-#     responses:
-#       '204':
-#         description: No content
-#       '401':
-#         $ref: '../../api.yml#/components/responses/Unauthorized'
-#       '403':
-#         $ref: '../../api.yml#/components/responses/Forbidden'
-#       '404':
-#         $ref: '../../api.yml#/components/responses/NotFound'
-#       '500':
-#         $ref: '../../api.yml#/components/responses/ServerError'
-
-#   put:
-#     tags:
-#       - Persons
-#     summary: Create a new person with ID
-#     parameters:
-#       - $ref: '../../api.yml#/components/parameters/personId'
-#     requestBody:
-#       content:
-#           application/json:
-#             schema:
-#               $ref: '../../api.yml#/components/schemas/PersonPayload'
-#     responses:
-#       '201':
-#         description: Created
-#         content:
-#           application/json:
-#             schema:
-#               $ref: '../../api.yml#/components/schemas/Person'
-#       '400':
-#         $ref: '../../api.yml#/components/responses/BadRequest'
-#       '401':
-#         $ref: '../../api.yml#/components/responses/Unauthorized'
-#       '403':
-#         $ref: '../../api.yml#/components/responses/Forbidden'
-#       '500':
-#         $ref: '../../api.yml#/components/responses/ServerError'
diff --git a/src/openapi/paths/journals/journals.yml b/src/openapi/paths/journals/journals.yml
@@ -10,7 +10,7 @@ collectionMethods:
         - $ref: '../../api.yml#/components/parameters/sort'
     responses:
       '200':
-        description: Success
+        description: OK
         content:
           application/json:
             schema:
@@ -21,7 +21,7 @@ collectionMethods:
                   items:
                     type: object
                 totalCount:
-                  type: number
+                  type: integer
       '400':
         $ref: '../../api.yml#/components/responses/BadRequest'
       '401':

diff --git a/src/openapi/paths/legalcategories/legalcategories.yml b/src/openapi/paths/legalcategories/legalcategories.yml
@@ -10,7 +10,7 @@ collectionMethods:
         - $ref: '../../api.yml#/components/parameters/sort'
     responses:
       '200':
-        description: Success
+        description: OK
         content:
           application/json:
             schema:
@@ -21,7 +21,7 @@ collectionMethods:
                   items:
                     $ref: '../../api.yml#/components/schemas/LegalCategory'
                 totalCount:
-                  type: number
+                  type: integer
       '400':
         $ref: '../../api.yml#/components/responses/BadRequest'
       '401':

diff --git a/src/openapi/paths/officialtexts/officialtexts.yml b/src/openapi/paths/officialtexts/officialtexts.yml
@@ -21,7 +21,7 @@ collectionMethods:
                   items:
                     $ref: '../../api.yml#/components/schemas/OfficialText'
                 totalCount:
-                  type: number
+                  type: integer
       '400':
         $ref: '../../api.yml#/components/responses/BadRequest'
       '401':

diff --git a/src/openapi/paths/persons/identifiers.yml b/src/openapi/paths/persons/identifiers.yml
@@ -80,7 +80,7 @@ documentMethods:
       - $ref: '../../api.yml#/components/parameters/identifierId'
     responses:
       '200':
-        description: Success
+        description: OK
         content:
           application/json:
             schema:

diff --git a/src/openapi/paths/persons/persons.yml b/src/openapi/paths/persons/persons.yml
@@ -10,7 +10,7 @@ collectionMethods:
         - $ref: '../../api.yml#/components/parameters/sort'
     responses:
       '200':
-        description: Success
+        description: OK
         content:
           application/json:
             schema:
@@ -21,7 +21,7 @@ collectionMethods:
                   items:
                     $ref: '../../api.yml#/components/schemas/Person'
                 totalCount:
-                  type: number
+                  type: integer
       '400':
         $ref: '../../api.yml#/components/responses/BadRequest'
       '401':

diff --git a/src/openapi/paths/press/press.yml b/src/openapi/paths/press/press.yml
@@ -72,7 +72,7 @@ documentMethods:
       - $ref: '../../api.yml#/components/parameters/pressId'
     responses:
       '200':
-        description: Success
+        description: OK
         content:
           application/json:
             schema:

diff --git a/src/openapi/paths/prizes/identifiers.yml b/src/openapi/paths/prizes/identifiers.yml
@@ -80,7 +80,7 @@ documentMethods:
       - $ref: '../../api.yml#/components/parameters/identifierId'
     responses:
       '200':
-        description: Success
+        description: OK
         content:
           application/json:
             schema:

diff --git a/src/openapi/paths/prizes/prizes.yml b/src/openapi/paths/prizes/prizes.yml
@@ -68,7 +68,7 @@ documentMethods:
       - $ref: '../../api.yml#/components/parameters/prizeId'
     responses:
       '200':
-        description: Success
+        description: OK
         content:
           application/json:
             schema: