Revert "feat: change openapi spec for transactions to consider resour…

…ce manager" (#2497) Revert "feat: change openapi spec for transactions to consider resource manager (#2486)" This reverts commit 22f7dd1.
kubeshop · May 5, 2023 · 490d47c · 490d47c
1 parent 1791556
commit 490d47c
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 85 deletions.
diff --git a/api/openapi.yaml b/api/openapi.yaml
@@ -61,7 +61,7 @@ paths:
   /transactions:
     get:
       tags:
-        - resource-api
+        - api
       summary: "Get transactions"
       description: "get transactions"
       operationId: getTransactions
@@ -74,63 +74,43 @@ paths:
       responses:
         200:
           description: successful operation
+          headers:
+            X-Total-Count:
+              schema:
+                type: integer
+              description: Total records count
           content:
             application/json:
               schema:
-                type: object
-                properties:
-                  count:
-                    type: integer
-                  items:
-                    type: array
-                    items:
-                      $ref: "./transactions.yaml#/components/schemas/TransactionResource"
-            text/yaml:
-              schema:
-                type: object
-                properties:
-                  count:
-                    type: integer
-                  items:
-                    type: array
-                    items:
-                      $ref: "./transactions.yaml#/components/schemas/TransactionResource"
-        400:
-          description: "invalid query for transactions, some data was sent in incorrect format."
+                type: array
+                items:
+                  $ref: "./transactions.yaml#/components/schemas/Transaction"
         500:
           description: "problem with getting transactions"
     post:
       tags:
-        - resource-api
+        - api
       summary: "Create new transaction"
       description: "Create new transaction"
       operationId: createTransaction
       requestBody:
         content:
           application/json:
             schema:
-              $ref: "./transactions.yaml#/components/schemas/TransactionResource"
-          text/yaml:
-            schema:
-              $ref: "./transactions.yaml#/components/schemas/TransactionResource"
+              $ref: "./transactions.yaml#/components/schemas/Transaction"
       responses:
-        201:
+        200:
           description: successful operation
           content:
             application/json:
               schema:
-                $ref: "./transactions.yaml#/components/schemas/TransactionResource"
-            text/yaml:
-              schema:
-                $ref: "./transactions.yaml#/components/schemas/TransactionResource"
+                $ref: "./transactions.yaml#/components/schemas/Transaction"
         400:
           description: "trying to create a transaction with an already existing ID"
-        500:
-          description: "problem creating a transaction"
   /transactions/{transactionId}:
     get:
       tags:
-        - resource-api
+        - api
       parameters:
         - $ref: "./parameters.yaml#/components/parameters/transactionId"
       summary: "get transaction"
@@ -142,17 +122,12 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "./transactions.yaml#/components/schemas/TransactionResource"
-            text/yaml:
-              schema:
-                $ref: "./transactions.yaml#/components/schemas/TransactionResource"
-        404:
-          description: "transaction not found"
+                $ref: "./transactions.yaml#/components/schemas/Transaction"
         500:
-          description: "problem getting an transaction"
+          description: "problem with getting a transaction"
     put:
       tags:
-        - resource-api
+        - api
       parameters:
         - $ref: "./parameters.yaml#/components/parameters/transactionId"
       summary: "update transaction"
@@ -162,41 +137,23 @@ paths:
         content:
           application/json:
             schema:
-              $ref: "./transactions.yaml#/components/schemas/TransactionResource"
-          text/yaml:
-            schema:
-              $ref: "./transactions.yaml#/components/schemas/TransactionResource"
+              $ref: "./transactions.yaml#/components/schemas/Transaction"
       responses:
-        200:
+        204:
           description: successful operation
-          content:
-            application/json:
-              schema:
-                $ref: "./transactions.yaml#/components/schemas/TransactionResource"
-            text/yaml:
-              schema:
-                $ref: "./transactions.yaml#/components/schemas/TransactionResource"
-        400:
-          description: "invalid transaction, some data was sent in incorrect format."
-        404:
-          description: "transaction not found"
         500:
-          description: "problem updating a transaction"
+          description: "problem with updating transaction"
     delete:
       tags:
-        - resource-api
+        - api
       parameters:
         - $ref: "./parameters.yaml#/components/parameters/transactionId"
       summary: "delete a transaction"
       description: "delete a transaction"
       operationId: deleteTransaction
       responses:
-        204:
-          description: successful operation
-        404:
-          description: "transaction not found"
-        500:
-          description: "problem deleting a transaction"
+        "204":
+          description: OK
   /transactions/{transactionId}/version/{version}:
     get:
       tags:

diff --git a/api/transactions.yaml b/api/transactions.yaml
@@ -1,19 +1,6 @@
 openapi: 3.0.0
 components:
   schemas:
-
-    TransactionResource:
-      type: object
-      description: "Represents a transaction structured into the Resources format."
-      properties:
-        type:
-          type: string
-          description: "Represents the type of this resource. It should always be set as 'Transaction'."
-          enum:
-            - Transaction
-        spec:
-          $ref: "#/components/schemas/Transaction"
-
     Transaction:
       type: object
       properties:
@@ -29,12 +16,6 @@ components:
           description: version number of the test
         steps:
           type: array
-          description: list of steps of the transaction containing just each test id
-          items:
-            type: string
-        fullSteps:
-          type: array
-          description: list of steps of the transaction containing the whole test object
           items:
             $ref: "./tests.yaml#/components/schemas/Test"
         createdAt: