Merge pull request #34 from regulaforensics/BE-487-x-request_header

[BE-487] X-RequestID header
regulaforensics · Oct 6, 2022 · 2eb650d · 2eb650d
2 parents bd3e492 + add7c28
commit 2eb650d
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 2 deletions.
diff --git a/common.yml b/common.yml
@@ -1,7 +1,6 @@
 openapi: 3.0.3
 
 components:
-
   parameters:
     page:
       name: page
@@ -19,6 +18,11 @@ components:
       schema:
         type: integer
         default: 1000
+    x-request:
+      in: header
+      name: X-RequestID
+      schema:
+        type: string
 
   responses:
     BadLicense:

diff --git a/detect.yml b/detect.yml
@@ -1,7 +1,10 @@
 openapi: 3.0.3
-paths:
 
+
+paths:
   /detect:
+    parameters:
+      - $ref: './common.yml#/components/parameters/x-request'
     post:
       tags:
         - matching

diff --git a/groups.yml b/groups.yml
@@ -3,6 +3,8 @@ openapi: 3.0.3
 
 paths:
   /groups:
+    parameters:
+      - $ref: './common.yml#/components/parameters/x-request'
     get:
       tags:
         - group
@@ -40,6 +42,7 @@ paths:
   /groups/{group_id}:
     parameters:
       - $ref: '#/components/parameters/group_id'
+      - $ref: './common.yml#/components/parameters/x-request'
     get:
       tags:
         - group
@@ -84,6 +87,7 @@ paths:
   /groups/{group_id}/persons:
     parameters:
       - $ref: "#/components/parameters/group_id"
+      - $ref: './common.yml#/components/parameters/x-request'
     get:
       tags:
         - group

diff --git a/matching.yml b/matching.yml
@@ -2,6 +2,8 @@ openapi: 3.0.3
 paths:
 
   /match:
+    parameters:
+      - $ref: './common.yml#/components/parameters/x-request'
     post:
       tags:
         - matching

diff --git a/persons.yml b/persons.yml
@@ -1,12 +1,17 @@
 openapi: 3.0.3
+
+
 paths:
   /persons:
+    parameters:
+      - $ref: './common.yml#/components/parameters/x-request'
     get:
       tags:
         - person
       summary: Get persons
       operationId: get_all_persons
       parameters:
+        - $ref: './common.yml#/components/parameters/x-request'
         - $ref: './common.yml#/components/parameters/page'
         - $ref: './common.yml#/components/parameters/size'
       responses:
@@ -37,6 +42,7 @@ paths:
   /persons/{person_id}:
     parameters:
       - $ref: '#/components/parameters/person_id'
+      - $ref: './common.yml#/components/parameters/x-request'
     get:
       tags:
         - person
@@ -83,6 +89,7 @@ paths:
   /persons/{person_id}/images:
     parameters:
       - $ref: '#/components/parameters/person_id'
+      - $ref: './common.yml#/components/parameters/x-request'
     get:
       tags:
         - person
@@ -128,6 +135,7 @@ paths:
   /persons/{person_id}/images/{image_id}:
     parameters:
       - $ref: '#/components/parameters/person_id'
+      - $ref: './common.yml#/components/parameters/x-request'
     get:
       tags:
         - person
@@ -170,6 +178,7 @@ paths:
   /persons/{person_id}/groups:
     parameters:
       - $ref: '#/components/parameters/person_id'
+      - $ref: './common.yml#/components/parameters/x-request'
     get:
       tags:
         - person

diff --git a/search.yml b/search.yml
@@ -3,6 +3,8 @@ openapi: 3.0.3
 
 paths:
   /search:
+    parameters:
+      - $ref: './common.yml#/components/parameters/x-request'
     post:
       tags:
         - search