Merge pull request #130 from pagopa/PAGOPA-1495-doc-aggiornamento-doc…

…umentazione

PAGOPA-1495 modifying doc and openapi

.github/workflows/check_pr.yml

@@ -84,7 +84,7 @@ jobs:
       - name: Check Size
         uses: actions/[email protected]
         env:
-          IGNORED_FILES: openapi.json, openapi-node.json
+          IGNORED_FILES: openapi-v1.json, openapi-v2.json, openapi-node-v1.json, openapi-node-v2.json
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           script: |

.github/workflows/update_infra.yml

@@ -6,8 +6,10 @@ on:
       - main
     types: [ closed ]
     paths:
-      - 'openapi/openapi.json'
-      - 'openapi/openapi-node.json'
+      - 'openapi/openapi-v1.json'
+      - 'openapi/openapi-v2.json'
+      - 'openapi/openapi-node-v1.json'
+      - 'openapi/openapi-node-v2.json'
 
 
   workflow_dispatch:

.opex/internal/env/prod/config.yaml

@@ -1,4 +1,4 @@
-oa3_spec: ./openapi/openapi.json # If start with http the file would be downloaded from the internet
+oa3_spec: ./openapi/openapi-v1.json # If start with http the file would be downloaded from the internet
 name: opex_pagopa-afm-calculator
 location: West Europe
 timespan: 5m # Default, a number or a timespan https://docs.microsoft.com/en-us/azure/data-explorer/kusto/query/scalar-data-types/timespan

.opex/node/env/prod/config.yaml

@@ -1,4 +1,4 @@
-oa3_spec: ./openapi/openapi-node.json # If start with http the file would be downloaded from the internet
+oa3_spec: ./openapi/openapi-node-v1.json # If start with http the file would be downloaded from the internet
 name: opex_pagopa-afm-calculator_node
 location: West Europe
 timespan: 5m # Default, a number or a timespan https://docs.microsoft.com/en-us/azure/data-explorer/kusto/query/scalar-data-types/timespan

README.md

@@ -15,7 +15,11 @@ Spring Application exposes API to calculate taxpayer fees according to [_AFM Mar
 
 ---
 ## API Documentation 📖
-See the [OpenApi 3 here](https://editor.swagger.io/?url=https://raw.githubusercontent.com/pagopa/pagopa-afm-calculator/main/openapi/openapi.json)
+See the Openapi files at the following links:
+- [OpenApi V1](https://editor.swagger.io/?url=https://raw.githubusercontent.com/pagopa/pagopa-afm-calculator/main/openapi/openapi-v1.json)
+- [OpenApi V2](https://editor.swagger.io/?url=https://raw.githubusercontent.com/pagopa/pagopa-afm-calculator/main/openapi/openapi-v2.json)
+- [OpenApi for Nodo dei pagamenti V1](https://editor.swagger.io/?url=https://raw.githubusercontent.com/pagopa/pagopa-afm-calculator/main/openapi/openapi-node-v1.json)
+- [OpenApi for Nodo dei pagamenti V2](https://editor.swagger.io/?url=https://raw.githubusercontent.com/pagopa/pagopa-afm-calculator/main/openapi/openapi-node-v2.json)
 
 See the [OpenApi 3 here](https://editor.swagger.io/?url=https://raw.githubusercontent.com/pagopa/pagopa-afm-calculator/main/openapi/openapi-node.json) **for Nodo dei pagamenti**
 

openapi/generate_openapi.sh

@@ -1,12 +1,7 @@
 #!/bin/bash
 
-# install api-spec-converter if not present
-if [ $(npm list -g | grep -c api-spec-converter) -eq 0 ]; then
-  npm install -g api-spec-converter
+if [[ "$(pwd)" =~ .*"openapi".* ]]; then
+    cd ..
 fi
 
-# save openapi
-curl http://localhost:8080/v3/api-docs | python3 -m json.tool > ./openapi.json
-python3 generate_openapi_node.py ./openapi.json
-
-# UI mode http://localhost:8080/swagger-ui/index.html
+mvn test -Dtest=OpenApiGenerationTest