@mojaloop/api-snippets 17.2.4 → 17.3.0-snapshot.0

package/CHANGELOG.md

@@ -1,4 +1,11 @@
 # Changelog: [mojaloop/api-snippets](https://github.com/mojaloop/api-snippets)
+### [17.2.5](https://github.com/mojaloop/api-snippets/compare/v17.2.4...v17.2.5) (2023-09-20)
+
+
+### Maintenance
+
+* master to main migration ([#168](https://github.com/mojaloop/api-snippets/issues/168)) ([0e20935](https://github.com/mojaloop/api-snippets/commit/0e20935a3c4acb0aff4627bbfef5139f823dc471))
+
 ### [17.2.4](https://github.com/mojaloop/api-snippets/compare/v17.2.3...v17.2.4) (2023-08-23)
 
 

package/README.md

@@ -42,7 +42,7 @@ Validate the result file.
 ## Swagger-UI
 
 The snippets specification is previewable using swagger-ui. Swagger-UI files
-are found in `docs/dist/`. Github pages uses the master branch `docs/` folder
+are found in `docs/dist/`. Github pages uses the main branch `docs/` folder
 to build the page found at https://docs.mojaloop.io/api-snippets/
 
 ## Dev Tools
@@ -184,3 +184,15 @@ the `npm run build:dto` script is already executing linting with auto-fixing
 there is pre-commit hook setup witch do a linting for staged files.
 ### DTO testing
 - testing of DTO declarations
+
+### Comparing openapi specification - useful commands
+
+For difference:
+```
+docker run --rm -t -v $(pwd)/docs:/docs:ro tufin/oasdiff diff /docs/fspiop-rest-v1.1-openapi3-snippets.yaml /docs/fspiop-rest-v2.0-openapi3-snippets.yaml -f text
+```
+
+For changelog:
+```
+docker run --rm -t -v $(pwd)/docs:/docs:ro tufin/oasdiff changelog /docs/fspiop-rest-v1.1-openapi3-snippets.yaml /docs/fspiop-rest-v2.0-openapi3-snippets.yaml
+```

package/audit-ci.jsonc

@@ -4,5 +4,6 @@
     // Only use one of ["low": true, "moderate": true, "high": true, "critical": true]
     "moderate": true,
     "allowlist": [
+      "GHSA-wf5p-g6vw-rhxx"
     ]
 }

package/docs/dist/openapi.yaml

@@ -1356,7 +1356,7 @@ components:
       schema:
         type: string
       required: false
-      description: 'The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set).'
+      description: 'The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).'
     FSPIOP-Signature:
       name: FSPIOP-Signature
       in: header
@@ -1377,7 +1377,7 @@ components:
       schema:
         type: string
       required: false
-      description: 'The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set).'
+      description: 'The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).'
     ID:
       name: ID
       in: path

package/docs/fspiop-rest-v1.0-openapi3-snippets.yaml

@@ -3313,7 +3313,6 @@ components:
       properties:
         party:
           $ref: '#/components/schemas/Party'
-          description: Information regarding the requested Party.
       required:
         - party
     GeoCode:
@@ -4177,7 +4176,7 @@ components:
         API for signature verification, should contain the service URI. Required
         if signature verification is used, for more information, see [the API
         Signature
-        document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set).
+        document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).
     FSPIOP-HTTP-Method:
       name: FSPIOP-HTTP-Method
       in: header
@@ -4189,7 +4188,7 @@ components:
         by the API for signature verification, should contain the service HTTP
         method. Required if signature verification is used, for more
         information, see [the API Signature
-        document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set).
+        document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).
     Accept:
       name: Accept
       in: header

package/docs/fspiop-rest-v1.1-openapi3-snippets.yaml

@@ -4,14 +4,14 @@ info:
   title: Open API for FSP Interoperability (FSPIOP)
   description: >-
     Based on [API Definition updated on 2020-05-19 Version
-    1.1](https://github.com/mojaloop/mojaloop-specification/blob/master/documents/v1.1-document-set/API%20Definition_v1.1.pdf).
+    1.1](https://github.com/mojaloop/mojaloop-specification/blob/main/documents/v1.1-document-set/API%20Definition_v1.1.pdf).
 
 
     **Note:** The API supports a maximum size of 65536 bytes (64 Kilobytes) in
     the HTTP header.
   license:
     name: CC BY-ND 4.0
-    url: https://github.com/mojaloop/mojaloop-specification/blob/master/LICENSE.md
+    url: https://github.com/mojaloop/mojaloop-specification/blob/main/LICENSE.md
   contact:
     name: Sam Kummary
     url: https://github.com/mojaloop/mojaloop-specification/issues
@@ -3730,7 +3730,7 @@ components:
         API for signature verification, should contain the service URI. Required
         if signature verification is used, for more information, see [the API
         Signature
-        document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set).
+        document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).
     FSPIOP-HTTP-Method:
       name: FSPIOP-HTTP-Method
       in: header
@@ -3742,7 +3742,7 @@ components:
         by the API for signature verification, should contain the service HTTP
         method. Required if signature verification is used, for more
         information, see [the API Signature
-        document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set).
+        document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).
     Accept:
       name: Accept
       in: header