Skip to content

Commit 8934b6f

Browse files
authored
Merge pull request #116 from regulaforensics/feature/delete-liveness-transaction
Add delete http method for liveness
2 parents 7a393b6 + cc0c873 commit 8934b6f

2 files changed

Lines changed: 24 additions & 2 deletions

File tree

common.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,13 @@ components:
3030
schema:
3131
type: string
3232
format: uuid
33+
tag:
34+
in: query
35+
name: tag
36+
required: true
37+
description: "A unique tag associated with a liveness transaction session. Used to identify and delete the corresponding transaction."
38+
schema:
39+
type: string
3340

3441
responses:
3542
BadLicense:

liveness.yml

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@ openapi: 3.0.3
22

33
paths:
44
/v2/liveness:
5-
parameters:
6-
- $ref: './common.yml#/components/parameters/transactionId'
75
get:
6+
parameters:
7+
- $ref: './common.yml#/components/parameters/transactionId'
88
tags:
99
- liveness 2.0
1010
summary: 'liveness check'
@@ -31,6 +31,18 @@ paths:
3131
application/json:
3232
schema:
3333
$ref: "#/components/schemas/TransactionInfo"
34+
delete:
35+
parameters:
36+
- $ref: "./common.yml#/components/parameters/transactionId"
37+
- $ref: "./common.yml#/components/parameters/tag"
38+
tags:
39+
- liveness 2.0
40+
summary: delete liveness transaction
41+
description: "This endpoint deletes a liveness transaction based on either the specified `tag` or `transactionId`. At least one of the parameters must be provided for the operation to be valid."
42+
operationId: delete_liveness_transaction
43+
responses:
44+
204:
45+
$ref: "#/components/responses/SuccessEmpty"
3446

3547
components:
3648
schemas:
@@ -79,3 +91,6 @@ components:
7991
x-enum-varnames:
8092
- ACTIVE
8193
- PASSIVE
94+
responses:
95+
SuccessEmpty:
96+
description: "Successful operation, return nothing."

0 commit comments

Comments
 (0)