Add AML tags (#1555)

* Add AML tags * Update openapi/paths/tags@{tag}@aml-checks.yaml Co-authored-by: Chris <[email protected]> * Update openapi/paths/tags@{tag}@aml-checks.yaml Co-authored-by: Chris <[email protected]> * Update openapi/paths/tags@{tag}@aml-checks.yaml Co-authored-by: Chris <[email protected]> * Update openapi/paths/tags@{tag}@aml-checks@{amlCheckId}.yaml Co-authored-by: Chris <[email protected]> * Update openapi/paths/tags@{tag}@aml-checks@{amlCheckId}.yaml Co-authored-by: Chris <[email protected]> * Add AML check tags * Add AML check tags * Fix messages for async operations, remove excess title attribute from requestBody * Update openapi/paths/tags@{tag}@kyc-documents.yaml Co-authored-by: Alexander Shkarpetin <[email protected]> --------- Co-authored-by: Chris <[email protected]> Co-authored-by: Alexander Shkarpetin <[email protected]>
Rebilly · Aug 17, 2023 · 572930b · 572930b
1 parent 5be26f9
commit 572930b
Show file tree

Hide file tree

Showing 6 changed files with 144 additions and 8 deletions.
diff --git a/openapi/components/schemas/AmlCheck.yaml b/openapi/components/schemas/AmlCheck.yaml
@@ -121,6 +121,12 @@ properties:
     type: array
     items:
       $ref: ./AML.yaml
+  tags:
+    description: List of AML check tags.
+    readOnly: true
+    type: array
+    items:
+      $ref: ./Tag.yaml
   _links:
     type: array
     description: Related links.

diff --git a/openapi/openapi.yaml b/openapi/openapi.yaml
@@ -861,6 +861,10 @@ paths:
     $ref: './paths/tags@{tag}@kyc-documents.yaml'
   '/tags/{tag}/kyc-documents/{kycDocumentId}':
     $ref: './paths/tags@{tag}@kyc-documents@{kycDocumentId}.yaml'
+  '/tags/{tag}/aml-checks':
+    $ref: './paths/tags@{tag}@aml-checks.yaml'
+  '/tags/{tag}/aml-checks/{amlCheckId}':
+    $ref: './paths/tags@{tag}@aml-checks@{amlCheckId}.yaml'
   /tokens:
     $ref: ./paths/tokens.yaml
   '/tokens/{token}':

diff --git a/openapi/paths/tags@{tag}@aml-checks.yaml b/openapi/paths/tags@{tag}@aml-checks.yaml
@@ -0,0 +1,80 @@
+parameters:
+  - $ref: ../components/parameters/tag.yaml
+post:
+  x-products:
+    - Core
+  tags:
+    - Tags
+  summary: Tag a list of AML checks
+  operationId: PostTagAmlCheckCollection
+  x-sdk-operation-name: tagAmlChecks
+  description: |-
+    Tags a list of AML checks.
+
+    If an AML check in the list already has the specified tag applied, the AML check is ignored.
+    This is an asynchronous operation.
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          type: object
+          required:
+            - amlCheckIds
+          properties:
+            amlCheckIds:
+              description: List of AML check IDs to tag.
+              type: array
+              minItems: 1
+              maxItems: 1000
+              items:
+                type: string
+                example: aml_chk_0YV7JHY705C6DA487BFTAA33V8
+  responses:
+    '204':
+      description: AML checks tagging process has been scheduled.
+    '401':
+      $ref: ../components/responses/Unauthorized.yaml
+    '403':
+      $ref: ../components/responses/Forbidden.yaml
+    '422':
+      $ref: ../components/responses/ValidationError.yaml
+delete:
+  x-products:
+    - Core
+  tags:
+    - Tags
+  summary: Untag a list of AML checks
+  operationId: DeleteTagAmlCheckCollection
+  x-sdk-operation-name: untagAmlChecks
+  description: |-
+    Untags a list of AML checks.
+
+    If an AML check in the list does not have the specified tag applied, the AML check is ignored.
+    This is an asynchronous operation.
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          type: object
+          required:
+            - amlCheckIds
+          properties:
+            amlCheckIds:
+              description: List of AML check IDs to tag.
+              type: array
+              minItems: 1
+              maxItems: 1000
+              items:
+                type: string
+                example: aml_chk_0YV7JHY705C6DA487BFTAA33V8
+  responses:
+    '204':
+      description: AML checks untagging process has been scheduled.
+    '401':
+      $ref: ../components/responses/Unauthorized.yaml
+    '403':
+      $ref: ../components/responses/Forbidden.yaml
+    '422':
+      $ref: ../components/responses/ValidationError.yaml
diff --git a/openapi/paths/tags@{tag}@aml-checks@{amlCheckId}.yaml b/openapi/paths/tags@{tag}@aml-checks@{amlCheckId}.yaml
@@ -0,0 +1,50 @@
+parameters:
+  - $ref: ../components/parameters/tag.yaml
+  - name: amlCheckId
+    in: path
+    description: ID of the AML check to tag.
+    required: true
+    schema:
+      type: string
+post:
+  x-products:
+    - Core
+  tags:
+    - Tags
+  summary: Tag an AML check
+  operationId: PostTagAmlCheck
+  x-sdk-operation-name: tagAmlCheck
+  description: |-
+    Tags an AML check.
+
+    If a AML check in the list does not have the specified tag applied, the AML check is ignored.
+  responses:
+    '204':
+      description: AML check tagged.
+    '401':
+      $ref: ../components/responses/Unauthorized.yaml
+    '403':
+      $ref: ../components/responses/Forbidden.yaml
+    '404':
+      $ref: ../components/responses/NotFound.yaml
+delete:
+  x-products:
+    - Core
+  tags:
+    - Tags
+  summary: Untag an AML check
+  operationId: DeleteTagAmlCheck
+  x-sdk-operation-name: untagAmlCheck
+  description: |-
+    Untags an AML check.
+
+    If a AML check in the list does not have the specified tag applied, the AML check is ignored.
+  responses:
+    '204':
+      description: AML check untagged.
+    '401':
+      $ref: ../components/responses/Unauthorized.yaml
+    '403':
+      $ref: ../components/responses/Forbidden.yaml
+    '404':
+      $ref: ../components/responses/NotFound.yaml
diff --git a/openapi/paths/tags@{tag}@customers.yaml b/openapi/paths/tags@{tag}@customers.yaml
@@ -19,7 +19,6 @@ post:
       application/json:
         schema:
           type: object
-          title: PostTagCustomerCollectionRequest
           required:
             - customerIds
           properties:
@@ -32,7 +31,7 @@ post:
                 type: string
   responses:
     '204':
-      description: Customers tagged.
+      description: Customers tagging process has been scheduled.
     '401':
       $ref: ../components/responses/Unauthorized.yaml
     '403':
@@ -58,7 +57,6 @@ delete:
       application/json:
         schema:
           type: object
-          title: DeleteTagCustomerCollectionRequest
           required:
             - customerIds
           properties:
@@ -71,7 +69,7 @@ delete:
                 type: string
   responses:
     '204':
-      description: Customers untagged.
+      description: Customers untagging process has been scheduled.
     '401':
       $ref: ../components/responses/Unauthorized.yaml
     '403':

diff --git a/openapi/paths/tags@{tag}@kyc-documents.yaml b/openapi/paths/tags@{tag}@kyc-documents.yaml
@@ -19,7 +19,6 @@ post:
       application/json:
         schema:
           type: object
-          title: PostTagKycDocumentCollectionRequest
           required:
             - kycDocumentIds
           properties:
@@ -33,7 +32,7 @@ post:
                 example: kyc_doc_0YV7JHY705C6DA487BFTAA33V8
   responses:
     '204':
-      description: KYC documents tagged.
+      description: KYC documents tagging process has been scheduled.
     '401':
       $ref: ../components/responses/Unauthorized.yaml
     '403':
@@ -59,7 +58,6 @@ delete:
       application/json:
         schema:
           type: object
-          title: DeleteTagKycDocumentCollectionRequest
           required:
             - kycDocumentIds
           properties:
@@ -73,7 +71,7 @@ delete:
                 example: kyc_doc_0YV7JHY705C6DA487BFTAA33V8
   responses:
     '204':
-      description: KYC documents untagged.
+      description: KYC documents untagging process has been scheduled.
     '401':
       $ref: ../components/responses/Unauthorized.yaml
     '403':