changed name to securityTokens

src/openapi/container/abt-container-tokens.yaml

@@ -9,21 +9,21 @@ servers:
 security:
   - oAuthSample: [profile]
 tags:
-  - name: tokens
+  - name: securitytokens
 paths:
-  /tokens:
+  /securitytokens:
     post:
       tags:
-        - tokens
+        - securitytokens
-      summary: Create a new token entry in the vault
+      summary: Create a new security token entry in the vault
-      description: Create a new token entry in the vault, if the customerProfileId has been supplied create in the customerToken DB otherwise in the AnonymousToken DB
+      description: Create a new security token entry in the vault, if the customerProfileId has been supplied create in the customerToken DB otherwise in the AnonymousToken DB
       requestBody:
         content:
           application/json:
             schema:
-              $ref: "#/components/schemas/CreateTokenBody"
+              $ref: "#/components/schemas/CreateSecurityTokenBody"
             examples:
-              token:
+              token details:
                 value:
                   {
                     "xTat": "cf694905-7f76-4799-b0bc-490716921323",
@@ -84,7 +84,7 @@ paths:
                   value:
                     status: 409
                     title: Conflict
-                    detail: TAT Account Token already exists
+                    detail: Security Token already exists
         "500":
           description: Internal server error
           content:
@@ -97,7 +97,7 @@ paths:
                     status: 500
                     title: Internal Server Error
                     detail: An unknown error has occurred
-  /tokens/{xTat}/status:
+  /securitytokens/{xTat}/status:
     parameters: 
     - name: xTat
       in: path
@@ -105,7 +105,7 @@ paths:
         type: string
         example: 85dbeacc-b9aa-4d5b-bdec-9319010c597f
       required: true
-      description: The xTat for the token for which the status needs to be checked
+      description: The xTat of the OVpastoken for which the status needs to be checked
     - name: customerProfileId
       in: query
       schema:
@@ -115,7 +115,7 @@ paths:
       description: The id of the customer Profile for which the request is being done, if customer has identified themselves
     get:
       tags:
-        - tokens
+        - securitytokens
       summary: Request the security and authorization status of an OV pas token
       description: Request the security and authorization status of an OV pas token, if the customerProfileId has been supplied look in the customerToken DB otherwise check the AnonymousToken DB.
       responses:
@@ -124,7 +124,7 @@ paths:
           content:
             application/json:
               schema:
-               $ref: "#/components/schemas/TokenStatusResponse"
+               $ref: "#/components/schemas/SecurityTokenStatusResponse"
             examples:
                 Not secured and not authorized :
                   summary: Not secured, not authorized
@@ -200,7 +200,7 @@ paths:
                     status: 500
                     title: Internal Server Error
                     detail: An unknown error has occurred
-  /tokens/{xTat}:
+  /securitytokens/{xTat}:
     parameters: 
     - name: xTat
       in: path
@@ -208,7 +208,7 @@ paths:
         type: string
         example: uuid
       required: true
-      description: The xTat for the token for which the status needs to be checked
+      description: The xTat of the ovPastoken for which the status needs to be checked
     - name: customerProfileId
       in: query
       schema:
@@ -218,14 +218,14 @@ paths:
       description: The id of the customer Profile for which the request is being done, if customer has identified themselves
     patch:
       tags:
-        - tokens
+        - securitytokens
       summary: Validate the supplied OTP and secure and/or authorize the token
       description: Validate the supplied OTP and secure and/or authorize the token if the customerProfileId has been supplied look in the customerToken DB otherwise check the AnonymousToken DB.
       requestBody:
         content:
           application/json:
             schema:
-              $ref: "#/components/schemas/ValidateTokenBody"
+              $ref: "#/components/schemas/SecurityValidateTokenBody"
             examples:
               token:
                 value:
@@ -238,7 +238,7 @@ paths:
           content:
             application/json:
               schema:
-               $ref: "#/components/schemas/TokenStatusResponse"
+               $ref: "#/components/schemas/SecurityTokenStatusResponse"
               examples:
                 Not secured and not authorized :
                   summary: Not secured, not authorized
@@ -353,8 +353,8 @@ components:
         detail:
           type: string
           description: A detail IS A string that provides more details about the error.
-    CreateTokenBody:
+    CreateSecurityTokenBody:
-      description: Body for when the a new token entry is created
+      description: Body for when the a new security token entry is created
       type: object
       required:
         - xTat
@@ -370,7 +370,7 @@ components:
           description: >- 
             Key used to validate the OTP at GBO
           example: 123456789123456789123456789abcde
-    TokenStatusResponse:
+    SecurityTokenStatusResponse:
       description: Response for when the status of a token is requested
       type: object
       properties:
@@ -384,7 +384,7 @@ components:
           description: >-
             Does HTM have the authorization to access the secured the data of the OVpas
           example: false
-    ValidateTokenBody:
+    SecurityValidateTokenBody:
       description: Body for when the a token entry is validated
       type: object
       required:
@@ -394,6 +394,4 @@ components:
           type : string
           description: >- 
             OTP to be used to secure the token and retrieve the JWT at GBO          
-          minLength: 6
-          maxLength: 6
           example: 123456