Merge pull request #174 from regulaforensics/SP-16044/Add_get_transac…

…tions_by_tag_endpoint SP-16044: Add get transactions by tag endpoint
regulaforensics · Jun 13, 2024 · d907735 · d907735
2 parents 722ca7e + 0e450ec
commit d907735
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 0 deletions.
diff --git a/index.yml b/index.yml
@@ -36,6 +36,8 @@ paths:
     $ref: "./p-transaction.yml#/paths/~1transaction~1{transactionId}~1file"
   /api/v2/tag/{tagId}:
     $ref: "./p-transaction.yml#/paths/~1tag~1{tagId}"
+  /api/v2/tag/{tagId}/transactions:
+    $ref: "./p-transaction.yml#/paths/~1tag~1{tagId}~1transactions"
   /api/ping:
     $ref: "./p-ping.yml#/paths/~1ping"
 

diff --git a/p-transaction.yml b/p-transaction.yml
@@ -178,9 +178,51 @@ paths:
           description: "Bad request. Check your input data."
         "403":
           description: "Bad license. Either server or request does not contain valid license."
+  /tag/{tagId}/transactions:
+    get:
+      parameters:
+        - in: path
+          name: tagId
+          schema:
+            type: integer
+            format: uuid
+          required: true
+          description: Tag id
+      summary: Get transactions by tag
+      tags:
+        - transaction
+      responses:
+        "200":
+          description: "Transactions list by tag"
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ListTransactionsByTagResponse'
+        "400":
+          description: "Bad request. Check your input data."
+        "403":
+          description: "Bad license. Either server or request does not contain valid license."
 
 components:
   schemas:
+    ListTransactionsByTagResponse:
+      type: array
+      items:
+         $ref: '#/components/schemas/GetTransactionsByTagResponse'
+    GetTransactionsByTagResponse:
+      type: object
+      properties:
+        id:
+          type: integer
+          format: uuid
+          description: "Transaction id"
+        state:
+          type: integer
+          description: "Transaction status"
+        updatedAt:
+          type: string
+          format: 'date-time'
+          description: "Last time updated"
     TransactionProcessGetResponse:
       type: object
       properties: