feat: new tests openapi spec

api/openapi.yaml

@@ -305,7 +305,7 @@ paths:
   /tests:
     get:
       tags:
-        - api
+        - resource-api
       summary: "Get tests"
       description: "get tests"
       operationId: getTests
@@ -318,17 +318,15 @@ paths:
       responses:
         200:
           description: successful operation
-          headers:
-            X-Total-Count:
-              schema:
-                type: integer
-              description: Total records count
           content:
             application/json:
               schema:
-                type: array
-                items:
-                  $ref: "./tests.yaml#/components/schemas/Test"
+                $ref: "./tests.yaml#/components/schemas/TestResourceList"
+            text/yaml:
+              schema:
+                $ref: "./tests.yaml#/components/schemas/TestResourceList"
+        400:
+          description: "invalid query for test, some data was sent in incorrect format."
         500:
           description: "problem with getting tests"
     post:

api/tests.yaml

@@ -1,6 +1,29 @@
 openapi: 3.0.0
 components:
   schemas:
+
+    TestResourceList:
+      type: object
+      properties:
+        count:
+          type: integer
+        items:
+          type: array
+          items:
+            $ref: "#/components/schemas/TestResource"
+
+    TestResource:
+      type: object
+      description: "Represents a test structured into the Resources format."
+      properties:
+        type:
+          type: string
+          description: "Represents the type of this resource. It should always be set as 'Test'."
+          enum:
+            - Test
+        spec:
+          $ref: "#/components/schemas/Test"
+
     Test:
       type: object
       properties: