From 875f11ed3b5c0c0a12fa6c1cdb2475b026e3570f Mon Sep 17 00:00:00 2001 From: Alexander Date: Mon, 8 Apr 2024 17:37:19 +0300 Subject: [PATCH] SP-14246: Fix errors for api v2 --- index.yml | 4 +++- p-transaction.yml | 46 +++++++++++++++++++++++++++++++++++++++------- 2 files changed, 42 insertions(+), 8 deletions(-) diff --git a/index.yml b/index.yml index 75ae637..a885814 100644 --- a/index.yml +++ b/index.yml @@ -1,6 +1,6 @@ openapi: 3.0.3 info: - version: 7.1.0 + version: 7.1.2 title: Regula Document Reader Web API x-logo: url: "https://static-content.regulaforensics.com/Icons/Logos/Regula-logo.svg" @@ -32,6 +32,8 @@ paths: $ref: "./p-transaction.yml#/paths/~1transaction~1{transactionId}" /api/v2/transaction/{transaction_id}/results: $ref: "./p-transaction.yml#/paths/~1transaction~1{transactionId}~1results" + /api/v2/transaction/{transaction_id}/file: + $ref: "./p-transaction.yml#/paths/~1transaction~1{transactionId}~1file" /api/v2/tag/{tag_id}: $ref: "./p-transaction.yml#/paths/~1tag~1{tagId}" /api/ping: diff --git a/p-transaction.yml b/p-transaction.yml index c943320..a830392 100644 --- a/p-transaction.yml +++ b/p-transaction.yml @@ -14,7 +14,7 @@ paths: format: uuid required: true description: Transaction id - summary: Preprocess + summary: Reprocess tags: - transaction requestBody: @@ -25,12 +25,16 @@ paths: required: true responses: "200": - description: "Transaction process result" + description: "Transaction Process result" content: application/json: schema: type: object properties: + OutData: + $ref: '#/components/schemas/OutData' + InData: + $ref: '#/components/schemas/InData' tag: type: string transactionId: @@ -51,12 +55,12 @@ paths: format: uuid required: true description: Transaction id - summary: Get preprocess transaction data + summary: Get Reprocess transaction data tags: - transaction responses: "200": - description: "Preprocess transaction data" + description: "Reprocess transaction data" content: application/json: schema: @@ -84,7 +88,7 @@ paths: - true - false description: With base64 images or url - summary: Get preprocess transaction result + summary: Get Reprocess transaction result tags: - transaction responses: @@ -120,7 +124,35 @@ paths: description: "Bad request. Check your input data." "403": description: "Bad license. Either server or request does not contain valid license." - + /transaction/{transactionId}/file: + get: + parameters: + - in: path + name: transactionId + schema: + type: integer + format: uuid + required: true + description: Transaction id + - in: query + name: name + schema: + type: string + required: true + description: "File name" + summary: "Get File" + tags: + - transaction + responses: + "200": + description: "Binary file" + content: + application/octet-stream: + schema: + type: string + format: binary + "404": + description: "File not found" /tag/{tagId}: delete: parameters: @@ -131,7 +163,7 @@ paths: format: uuid required: true description: Tag id - summary: Delete preprocess transactions by tag + summary: Delete Reprocess transactions by tag tags: - transaction responses: