feat: initialize thirdparty snippets

docs/index.html

@@ -42,6 +42,7 @@
         urls: [
           {url: "fspiop-rest-v1.0-openapi3-snippets.yaml", name: "v1.0"},
           {url: "fspiop-rest-v1.1-openapi3-snippets.yaml", name: "v1.1"},
+          {url: "thirdparty-openapi3-snippets.yaml", name: "thirdparty"},
         ],
         dom_id: '#swagger-ui',
         deepLinking: true,

docs/thirdparty-openapi3-snippets.yaml

@@ -0,0 +1,37 @@
+openapi: 3.0.2
+info:
+  version: '0.1'
+  title: Thirdparty Snippets
+  description: |
+    Based on sequence diagrams
+    (https://github.com/mojaloop/pisp/tree/master/docs/out).
+    This is a work in progress.
+  license:
+    name: TBD
+servers:
+  - url: '{protocol}://hostname:<port>/switch/'
+    variables:
+      protocol:
+        enum:
+          - http
+          - https
+        default: https
+components:
+  schemas:
+    AccountAddress:
+      type: string
+      description: |
+        A long-lived unique account identifier provided by the DFSP this MUST NOT
+        be Bank Account Number or anything that may expose a User's private bank
+        account information.
+      pattern: '^([0-9A-Za-z_~\-\.]+[0-9A-Za-z_~\-])$'
+      minLength: 1
+      maxLength: 1023
+paths:
+  /health:
+    get:
+      summary: This path is for demonstration purposes.
+      description: A valid OpenApi3 specification requires `paths` to be defined.
+      responses:
+        '200':
+          description: OK

package.json

@@ -5,6 +5,7 @@
   "scripts": {
     "buildv1.0": "swagger-cli bundle -t yaml -o docs/fspiop-rest-v1.0-openapi3-snippets.yaml v1.0/openapi3/index.yaml && swagger-cli validate docs/fspiop-rest-v1.0-openapi3-snippets.yaml",
     "buildv1.1": "swagger-cli bundle -t yaml -o docs/fspiop-rest-v1.1-openapi3-snippets.yaml v1.1/openapi3/index.yaml && swagger-cli validate docs/fspiop-rest-v1.1-openapi3-snippets.yaml",
+    "buildThirdparty": "swagger-cli bundle -t yaml -o docs/thirdparty-openapi3-snippets.yaml thirdparty/openapi3/index.yaml && swagger-cli validate docs/thirdparty-openapi3-snippets.yaml",
     "audit:resolve": "SHELL=sh resolve-audit --production",
     "audit:check": "SHELL=sh check-audit --production"
   },

thirdparty/openapi3/index.yaml

@@ -0,0 +1,22 @@
+openapi: 3.0.2
+info:
+  $ref: ./info/index.yaml
+servers:
+  - url: '{protocol}://hostname:<port>/switch/'
+    variables:
+      protocol:
+        enum:
+          - http
+          - https
+        default: https
+components:
+  schemas:
+    $ref: ./schemas/index.yaml
+paths:
+  /health:
+    get:
+      summary: This path is for demonstration purposes.
+      description: A valid OpenApi3 specification requires `paths` to be defined.
+      responses:
+        '200':
+          description: OK

thirdparty/openapi3/info/index.yaml

@@ -0,0 +1,8 @@
+version: '0.1'
+title: 'Thirdparty Snippets'
+description: |
+  Based on sequence diagrams
+  (https://github.com/mojaloop/pisp/tree/master/docs/out).
+  This is a work in progress.
+license:
+  name: TBD

thirdparty/openapi3/schemas/AccountAddress.yaml

@@ -0,0 +1,8 @@
+type: string
+description: |
+  A long-lived unique account identifier provided by the DFSP this MUST NOT
+  be Bank Account Number or anything that may expose a User's private bank
+  account information.
+pattern: ^([0-9A-Za-z_~\-\.]+[0-9A-Za-z_~\-])$
+minLength: 1
+maxLength: 1023

thirdparty/openapi3/schemas/index.yaml

@@ -0,0 +1,2 @@
+AccountAddress:
+  $ref: ./AccountAddress.yaml