From 78c97380e64c6b99b68ac01808b3485819bfc483 Mon Sep 17 00:00:00 2001 From: pagopa-github-bot Date: Thu, 25 Jul 2024 07:22:39 +0000 Subject: [PATCH] Bump to version 1.1.3 [skip ci] --- helm/Chart.yaml | 4 +- helm/values-dev.yaml | 2 +- helm/values-prod.yaml | 2 +- helm/values-uat.yaml | 2 +- openapi/openapi.json | 1488 ++++++++++-------- openapi/openapi_backoffice_external_ec.json | 1011 ++++++------ openapi/openapi_backoffice_external_psp.json | 476 +++--- openapi/openapi_backoffice_helpdesk.json | 407 ++--- pom.xml | 2 +- 9 files changed, 1803 insertions(+), 1591 deletions(-) diff --git a/helm/Chart.yaml b/helm/Chart.yaml index e0b218d..729848b 100644 --- a/helm/Chart.yaml +++ b/helm/Chart.yaml @@ -2,8 +2,8 @@ apiVersion: v2 name: pagopa-afm-calculator description: Microservice that handles calculation for pagoPA Advanced Fees Management type: application -version: 0.29.0 -appVersion: 1.1.2 +version: 0.30.0 +appVersion: 1.1.3 dependencies: - name: microservice-chart version: 2.8.0 diff --git a/helm/values-dev.yaml b/helm/values-dev.yaml index 417bad4..e9412b2 100644 --- a/helm/values-dev.yaml +++ b/helm/values-dev.yaml @@ -4,7 +4,7 @@ microservice-chart: fullnameOverride: "backoffice-external" image: repository: ghcr.io/pagopa/pagopa-backoffice-external - tag: "1.1.2" + tag: "1.1.3" pullPolicy: Always livenessProbe: httpGet: diff --git a/helm/values-prod.yaml b/helm/values-prod.yaml index f3454b3..ba0d25b 100644 --- a/helm/values-prod.yaml +++ b/helm/values-prod.yaml @@ -4,7 +4,7 @@ microservice-chart: fullnameOverride: "backoffice-external" image: repository: ghcr.io/pagopa/pagopa-backoffice-external - tag: "1.1.2" + tag: "1.1.3" pullPolicy: Always livenessProbe: httpGet: diff --git a/helm/values-uat.yaml b/helm/values-uat.yaml index e9d1103..3959e45 100644 --- a/helm/values-uat.yaml +++ b/helm/values-uat.yaml @@ -4,7 +4,7 @@ microservice-chart: fullnameOverride: "backoffice-external" image: repository: ghcr.io/pagopa/pagopa-backoffice-external - tag: "1.1.2" + tag: "1.1.3" pullPolicy: Always livenessProbe: httpGet: diff --git a/openapi/openapi.json b/openapi/openapi.json index 761cf69..53c3260 100644 --- a/openapi/openapi.json +++ b/openapi/openapi.json @@ -1,903 +1,997 @@ { - "openapi" : "3.0.1", - "info" : { - "description" : "Microservice to expose REST API to contact PagoPA Backoffice", - "termsOfService" : "https://www.pagopa.gov.it/", - "title" : "Backoffice External", - "version" : "1.1.2" + "openapi": "3.0.1", + "info": { + "description": "Microservice to expose REST API to contact PagoPA Backoffice", + "termsOfService": "https://www.pagopa.gov.it/", + "title": "Backoffice External", + "version": "1.1.3" }, - "servers" : [ { - "url" : "http://localhost:8080" - }, { - "url" : "{host}{basePath}", - "variables" : { - "basePath" : { - "default" : "/backoffice/external/psp/v1", - "enum" : [ "/backoffice/external/psp/v1", "/backoffice/external/ec/v1", "/backoffice/helpdesk/v1" ] - }, - "host" : { - "default" : "https://api.platform.pagopa.it", - "enum" : [ "https://api.dev.platform.pagopa.it", "https://api.uat.platform.pagopa.it", "https://api.platform.pagopa.it" ] + "servers": [ + { + "url": "http://localhost:8080" + }, + { + "url": "{host}{basePath}", + "variables": { + "basePath": { + "default": "/backoffice/external/psp/v1", + "enum": [ + "/backoffice/external/psp/v1", + "/backoffice/external/ec/v1", + "/backoffice/helpdesk/v1" + ] + }, + "host": { + "default": "https://api.platform.pagopa.it", + "enum": [ + "https://api.dev.platform.pagopa.it", + "https://api.uat.platform.pagopa.it", + "https://api.platform.pagopa.it" + ] + } } } - } ], - "paths" : { - "/brokers/{brokerCode}/creditor_institutions" : { - "get" : { - "description" : "Internal | External | Synchronous | Authorization | Authentication | TPS | Idempotency | Stateless | Read/Write Intense | Cacheable\n-|-|-|-|-|-|-|-|-|-\nN | Y | Y | ApiKey | ApiKey | 1.0/sec | Y | Y | Read | Y\nReturn the list of Creditor Institutions of a Broker", - "operationId" : "getBrokerInstitutions", - "parameters" : [ { - "description" : "Broker Code to use as filter for the retrieved creditor institution list", - "in" : "path", - "name" : "brokerCode", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "description" : "Number of elements on one page. Default = 10", - "in" : "query", - "name" : "limit", - "required" : false, - "schema" : { - "maximum" : 100, - "minimum" : 0, - "type" : "integer", - "format" : "int32", - "default" : 10 - } - }, { - "description" : "Page number. Page value starts from 0", - "in" : "query", - "name" : "page", - "required" : true, - "schema" : { - "minimum" : 0, - "type" : "integer", - "format" : "int32" + ], + "paths": { + "/brokers/{brokerCode}/creditor_institutions": { + "get": { + "description": "Internal | External | Synchronous | Authorization | Authentication | TPS | Idempotency | Stateless | Read/Write Intense | Cacheable\n-|-|-|-|-|-|-|-|-|-\nN | Y | Y | ApiKey | ApiKey | 1.0/sec | Y | Y | Read | Y\nReturn the list of Creditor Institutions of a Broker", + "operationId": "getBrokerInstitutions", + "parameters": [ + { + "description": "Broker Code to use as filter for the retrieved creditor institution list", + "in": "path", + "name": "brokerCode", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Number of elements on one page. Default = 10", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "maximum": 100, + "minimum": 0, + "type": "integer", + "format": "int32", + "default": 10 + } + }, + { + "description": "Page number. Page value starts from 0", + "in": "query", + "name": "page", + "required": true, + "schema": { + "minimum": 0, + "type": "integer", + "format": "int32" + } } - } ], - "responses" : { - "200" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/BrokerInstitutionsResponse" + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BrokerInstitutionsResponse" } } }, - "description" : "OK", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "description": "OK", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "400" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } }, - "description" : "Bad Request", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "description": "Bad Request", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "401" : { - "description" : "Unauthorized", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "401": { + "description": "Unauthorized", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "403" : { - "description" : "Forbidden", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "403": { + "description": "Forbidden", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "404" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } }, - "description" : "Institutions for the brokerCode not found", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "description": "Institutions for the brokerCode not found", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "429" : { - "description" : "Too many requests", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "429": { + "description": "Too many requests", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "500" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "500": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } }, - "description" : "Service unavailable", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "description": "Service unavailable", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } } }, - "security" : [ { - "ApiKey" : [ ] - } ], - "summary" : "getBrokerInstitutions", - "tags" : [ "External APIs" ] + "security": [ + { + "ApiKey": [] + } + ], + "summary": "getBrokerInstitutions", + "tags": [ + "External APIs" + ] }, - "parameters" : [ { - "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "in" : "header", - "name" : "X-Request-Id", - "schema" : { - "type" : "string" + "parameters": [ + { + "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "in": "header", + "name": "X-Request-Id", + "schema": { + "type": "string" + } } - } ] + ] }, - "/brokers/{brokerCode}/ibans" : { - "get" : { - "description" : "Internal | External | Synchronous | Authorization | Authentication | TPS | Idempotency | Stateless | Read/Write Intense | Cacheable\n-|-|-|-|-|-|-|-|-|-\nN | Y | Y | ApiKey | ApiKey | 1.0/sec | Y | Y | Read | Y\nReturn the list of Ibans of all the Creditor Institutions intermediated by the Broker", - "operationId" : "getBrokerIbans", - "parameters" : [ { - "description" : "Broker Code to use as filter for the retrieved ibans list", - "in" : "path", - "name" : "brokerCode", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "description" : "Number of elements on one page. Default = 10", - "in" : "query", - "name" : "limit", - "required" : false, - "schema" : { - "maximum" : 100, - "minimum" : 0, - "type" : "integer", - "format" : "int32", - "default" : 10 - } - }, { - "description" : "Page number. Page value starts from 0", - "in" : "query", - "name" : "page", - "required" : true, - "schema" : { - "minimum" : 0, - "type" : "integer", - "format" : "int32" + "/brokers/{brokerCode}/ibans": { + "get": { + "description": "Internal | External | Synchronous | Authorization | Authentication | TPS | Idempotency | Stateless | Read/Write Intense | Cacheable\n-|-|-|-|-|-|-|-|-|-\nN | Y | Y | ApiKey | ApiKey | 1.0/sec | Y | Y | Read | Y\nReturn the list of Ibans of all the Creditor Institutions intermediated by the Broker", + "operationId": "getBrokerIbans", + "parameters": [ + { + "description": "Broker Code to use as filter for the retrieved ibans list", + "in": "path", + "name": "brokerCode", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Number of elements on one page. Default = 10", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "maximum": 100, + "minimum": 0, + "type": "integer", + "format": "int32", + "default": 10 + } + }, + { + "description": "Page number. Page value starts from 0", + "in": "query", + "name": "page", + "required": true, + "schema": { + "minimum": 0, + "type": "integer", + "format": "int32" + } } - } ], - "responses" : { - "200" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/CIIbansResponse" + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CIIbansResponse" } } }, - "description" : "OK", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "description": "OK", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "400" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } }, - "description" : "Bad Request", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "description": "Bad Request", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "401" : { - "description" : "Unauthorized", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "401": { + "description": "Unauthorized", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "403" : { - "description" : "Forbidden", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "403": { + "description": "Forbidden", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "404" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } }, - "description" : "ibans for the brokerCode not found", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "description": "ibans for the brokerCode not found", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "429" : { - "description" : "Too many requests", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "429": { + "description": "Too many requests", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "500" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "500": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } }, - "description" : "Service unavailable", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "description": "Service unavailable", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } } }, - "security" : [ { - "ApiKey" : [ ] - } ], - "summary" : "getBrokerIbans", - "tags" : [ "External APIs" ] + "security": [ + { + "ApiKey": [] + } + ], + "summary": "getBrokerIbans", + "tags": [ + "External APIs" + ] }, - "parameters" : [ { - "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "in" : "header", - "name" : "X-Request-Id", - "schema" : { - "type" : "string" + "parameters": [ + { + "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "in": "header", + "name": "X-Request-Id", + "schema": { + "type": "string" + } } - } ] + ] }, - "/creditor_institutions/ibans" : { - "get" : { - "description" : "Internal | External | Synchronous | Authorization | Authentication | TPS | Idempotency | Stateless | Read/Write Intense | Cacheable\n-|-|-|-|-|-|-|-|-|-\nN | Y | Y | ApiKey | ApiKey | 1.0/sec | Y | Y | Read | Y\nReturn the full list of Ibans of all CIs ", - "operationId" : "getCIsIbans", - "parameters" : [ { - "description" : "Number of elements on one page. Default = 10", - "in" : "query", - "name" : "limit", - "required" : false, - "schema" : { - "maximum" : 100, - "minimum" : 0, - "type" : "integer", - "format" : "int32", - "default" : 10 - } - }, { - "description" : "Page number. Page value starts from 0", - "in" : "query", - "name" : "page", - "required" : true, - "schema" : { - "minimum" : 0, - "type" : "integer", - "format" : "int32" + "/creditor_institutions/ibans": { + "get": { + "description": "Internal | External | Synchronous | Authorization | Authentication | TPS | Idempotency | Stateless | Read/Write Intense | Cacheable\n-|-|-|-|-|-|-|-|-|-\nN | Y | Y | ApiKey | ApiKey | 1.0/sec | Y | Y | Read | Y\nReturn the full list of Ibans of all CIs ", + "operationId": "getCIsIbans", + "parameters": [ + { + "description": "Number of elements on one page. Default = 10", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "maximum": 100, + "minimum": 0, + "type": "integer", + "format": "int32", + "default": 10 + } + }, + { + "description": "Page number. Page value starts from 0", + "in": "query", + "name": "page", + "required": true, + "schema": { + "minimum": 0, + "type": "integer", + "format": "int32" + } } - } ], - "responses" : { - "200" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/CIIbansResponse" + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CIIbansResponse" } } }, - "description" : "OK", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "description": "OK", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "400" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } }, - "description" : "Bad Request", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "description": "Bad Request", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "401" : { - "description" : "Unauthorized", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "401": { + "description": "Unauthorized", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "429" : { - "description" : "Too many requests", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "429": { + "description": "Too many requests", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "500" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "500": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } }, - "description" : "Service unavailable", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "description": "Service unavailable", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } } }, - "security" : [ { - "ApiKey" : [ ] - } ], - "summary" : "getCIsIbans", - "tags" : [ "External APIs" ] + "security": [ + { + "ApiKey": [] + } + ], + "summary": "getCIsIbans", + "tags": [ + "External APIs" + ] }, - "parameters" : [ { - "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "in" : "header", - "name" : "X-Request-Id", - "schema" : { - "type" : "string" + "parameters": [ + { + "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "in": "header", + "name": "X-Request-Id", + "schema": { + "type": "string" + } } - } ] + ] }, - "/info" : { - "get" : { - "description" : "Return OK if application is started", - "operationId" : "healthCheck", - "responses" : { - "200" : { - "content" : { - "*/*" : { - "schema" : { - "$ref" : "#/components/schemas/AppInfo" + "/info": { + "get": { + "description": "Return OK if application is started", + "operationId": "healthCheck", + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/AppInfo" } } }, - "description" : "OK", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "description": "OK", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } } }, - "security" : [ { - "ApiKey" : [ ] - } ], - "summary" : "health check", - "tags" : [ "Home" ] + "security": [ + { + "ApiKey": [] + } + ], + "summary": "health check", + "tags": [ + "Home" + ] }, - "parameters" : [ { - "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "in" : "header", - "name" : "X-Request-Id", - "schema" : { - "type" : "string" + "parameters": [ + { + "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "in": "header", + "name": "X-Request-Id", + "schema": { + "type": "string" + } } - } ] + ] }, - "/operative_tables" : { - "get" : { - "description" : "Internal | External | Synchronous | Authorization | Authentication | TPS | Idempotency | Stateless | Read/Write Intense | Cacheable\n-|-|-|-|-|-|-|-|-|-\nN | Y | Y | ApiKey | ApiKey | 1.0/sec | Y | Y | | Y\nGet All operative tables", - "operationId" : "getOperativeTables", - "parameters" : [ { - "description" : "Tax code", - "in" : "query", - "name" : "taxCode", - "required" : false, - "schema" : { - "type" : "string", - "default" : "" - } - }, { - "description" : "Business name", - "in" : "query", - "name" : "businessName", - "required" : false, - "schema" : { - "type" : "string", - "default" : "" + "/operative_tables": { + "get": { + "description": "Internal | External | Synchronous | Authorization | Authentication | TPS | Idempotency | Stateless | Read/Write Intense | Cacheable\n-|-|-|-|-|-|-|-|-|-\nN | Y | Y | ApiKey | ApiKey | 1.0/sec | Y | Y | | Y\nGet All operative tables", + "operationId": "getOperativeTables", + "parameters": [ + { + "description": "Tax code", + "in": "query", + "name": "taxCode", + "required": false, + "schema": { + "type": "string", + "default": "" + } + }, + { + "description": "Business name", + "in": "query", + "name": "businessName", + "required": false, + "schema": { + "type": "string", + "default": "" + } } - } ], - "responses" : { - "200" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/OperativeTableResourceList" + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OperativeTableResourceList" } } }, - "description" : "OK", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "description": "OK", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "400" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } }, - "description" : "Bad Request", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "description": "Bad Request", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "401" : { - "description" : "Unauthorized", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "401": { + "description": "Unauthorized", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "429" : { - "description" : "Too many requests", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "429": { + "description": "Too many requests", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "500" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "500": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } }, - "description" : "Service unavailable", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "description": "Service unavailable", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } } }, - "security" : [ { - "ApiKey" : [ ] - } ], - "summary" : "getOperativeTables", - "tags" : [ "Operative Tables" ] + "security": [ + { + "ApiKey": [] + } + ], + "summary": "getOperativeTables", + "tags": [ + "Operative Tables" + ] }, - "parameters" : [ { - "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "in" : "header", - "name" : "X-Request-Id", - "schema" : { - "type" : "string" + "parameters": [ + { + "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "in": "header", + "name": "X-Request-Id", + "schema": { + "type": "string" + } } - } ] + ] } }, - "components" : { - "schemas" : { - "AppInfo" : { - "type" : "object", - "properties" : { - "environment" : { - "type" : "string" - }, - "name" : { - "type" : "string" - }, - "version" : { - "type" : "string" + "components": { + "schemas": { + "AppInfo": { + "type": "object", + "properties": { + "environment": { + "type": "string" + }, + "name": { + "type": "string" + }, + "version": { + "type": "string" } } }, - "BrokerInstitutionResource" : { - "required" : [ "auxDigit", "brokerCompanyName", "brokerTaxCode", "ciStatus", "companyName", "intermediated", "model", "stationState", "taxCode", "version" ], - "type" : "object", - "properties" : { - "activationDate" : { - "type" : "string", - "description" : "activation date", - "format" : "date-time" - }, - "applicationCode" : { - "type" : "string", - "description" : "application code of the relation station-ec (unique per auxdigit)" - }, - "auxDigit" : { - "type" : "string", - "description" : "aux digit number (0,1,2,3, 0/3)" - }, - "broadcast" : { - "type" : "boolean", - "description" : "true if the station is for broadcast" - }, - "brokerCompanyName" : { - "type" : "string", - "description" : "broker name" - }, - "brokerTaxCode" : { - "type" : "string", - "description" : "broker tax code" - }, - "cbillCode" : { - "type" : "string", - "description" : "CBILL code" - }, - "ciStatus" : { - "type" : "boolean", - "description" : "True if the CI is enabled" - }, - "companyName" : { - "type" : "string", - "description" : "Creditor Institution name" - }, - "endpointMU" : { - "type" : "string", - "description" : "endpoint for Modello Unico" - }, - "endpointRT" : { - "type" : "string", - "description" : "endpoint for Ricevuta Telematica" - }, - "endpointRedirect" : { - "type" : "string", - "description" : "endpoint for Redirect" - }, - "intermediated" : { - "type" : "boolean", - "description" : "true if the EC has a broker" - }, - "model" : { - "type" : "integer", - "description" : "model of the station", - "format" : "int32" - }, - "primitiveVersion" : { - "type" : "integer", - "description" : "Version of the primitive", - "format" : "int32" - }, - "pspPayment" : { - "type" : "boolean", - "description" : "true if allows payments by the psp" - }, - "segregationCode" : { - "type" : "string", - "description" : "segregation code of the relation station-ec (unique per auxdigit)" - }, - "stationId" : { - "type" : "string", - "description" : "station code" - }, - "stationState" : { - "type" : "string", - "description" : "station state", - "example" : "enabled" - }, - "taxCode" : { - "type" : "string", - "description" : "Creditor Institution tax code" - }, - "version" : { - "type" : "string", - "description" : "station version", - "example" : "1" + "BrokerInstitutionResource": { + "required": [ + "auxDigit", + "brokerCompanyName", + "brokerTaxCode", + "ciStatus", + "companyName", + "intermediated", + "model", + "stationState", + "taxCode", + "version" + ], + "type": "object", + "properties": { + "activationDate": { + "type": "string", + "description": "activation date", + "format": "date-time" + }, + "applicationCode": { + "type": "string", + "description": "application code of the relation station-ec (unique per auxdigit)" + }, + "auxDigit": { + "type": "string", + "description": "aux digit number (0,1,2,3, 0/3)" + }, + "broadcast": { + "type": "boolean", + "description": "true if the station is for broadcast" + }, + "brokerCompanyName": { + "type": "string", + "description": "broker name" + }, + "brokerTaxCode": { + "type": "string", + "description": "broker tax code" + }, + "cbillCode": { + "type": "string", + "description": "CBILL code" + }, + "ciStatus": { + "type": "boolean", + "description": "True if the CI is enabled" + }, + "companyName": { + "type": "string", + "description": "Creditor Institution name" + }, + "endpointMU": { + "type": "string", + "description": "endpoint for Modello Unico" + }, + "endpointRT": { + "type": "string", + "description": "endpoint for Ricevuta Telematica" + }, + "endpointRedirect": { + "type": "string", + "description": "endpoint for Redirect" + }, + "intermediated": { + "type": "boolean", + "description": "true if the EC has a broker" + }, + "model": { + "type": "integer", + "description": "model of the station", + "format": "int32" + }, + "primitiveVersion": { + "type": "integer", + "description": "Version of the primitive", + "format": "int32" + }, + "pspPayment": { + "type": "boolean", + "description": "true if allows payments by the psp" + }, + "segregationCode": { + "type": "string", + "description": "segregation code of the relation station-ec (unique per auxdigit)" + }, + "stationId": { + "type": "string", + "description": "station code" + }, + "stationState": { + "type": "string", + "description": "station state", + "example": "enabled" + }, + "taxCode": { + "type": "string", + "description": "Creditor Institution tax code" + }, + "version": { + "type": "string", + "description": "station version", + "example": "1" } }, - "description" : "List of creditor institutions" + "description": "List of creditor institutions" }, - "BrokerInstitutionsResponse" : { - "required" : [ "creditorInstitutions", "pageInfo" ], - "type" : "object", - "properties" : { - "creditorInstitutions" : { - "type" : "array", - "description" : "List of creditor institutions", - "items" : { - "$ref" : "#/components/schemas/BrokerInstitutionResource" - } - }, - "pageInfo" : { - "$ref" : "#/components/schemas/PageInfo" + "BrokerInstitutionsResponse": { + "required": [ + "creditorInstitutions", + "pageInfo" + ], + "type": "object", + "properties": { + "creditorInstitutions": { + "type": "array", + "description": "List of creditor institutions", + "items": { + "$ref": "#/components/schemas/BrokerInstitutionResource" + } + }, + "pageInfo": { + "$ref": "#/components/schemas/PageInfo" } } }, - "CIIbansResource" : { - "required" : [ "ciFiscalCode", "ciName", "iban", "status", "validityDate" ], - "type" : "object", - "properties" : { - "ciFiscalCode" : { - "type" : "string", - "description" : "Creditor Institution tax code" - }, - "ciName" : { - "type" : "string", - "description" : "Creditor Institution name" - }, - "description" : { - "type" : "string", - "description" : "description" - }, - "iban" : { - "type" : "string", - "description" : "iban" - }, - "label" : { - "type" : "string", - "description" : "label", - "example" : "CUP" - }, - "status" : { - "type" : "string", - "description" : "status", - "example" : "ENABLED" - }, - "validityDate" : { - "type" : "string", - "description" : "Activation Date", - "format" : "date-time" + "CIIbansResource": { + "required": [ + "ciFiscalCode", + "ciName", + "iban", + "status", + "validityDate" + ], + "type": "object", + "properties": { + "ciFiscalCode": { + "type": "string", + "description": "Creditor Institution tax code" + }, + "ciName": { + "type": "string", + "description": "Creditor Institution name" + }, + "description": { + "type": "string", + "description": "description" + }, + "iban": { + "type": "string", + "description": "iban" + }, + "label": { + "type": "string", + "description": "label", + "example": "CUP" + }, + "status": { + "type": "string", + "description": "status", + "example": "ENABLED" + }, + "validityDate": { + "type": "string", + "description": "Activation Date", + "format": "date-time" } }, - "description" : "list of IBANs" + "description": "list of IBANs" }, - "CIIbansResponse" : { - "required" : [ "ibans", "pageInfo" ], - "type" : "object", - "properties" : { - "ibans" : { - "type" : "array", - "description" : "list of IBANs", - "items" : { - "$ref" : "#/components/schemas/CIIbansResource" - } - }, - "pageInfo" : { - "$ref" : "#/components/schemas/PageInfo" + "CIIbansResponse": { + "required": [ + "ibans", + "pageInfo" + ], + "type": "object", + "properties": { + "ibans": { + "type": "array", + "description": "list of IBANs", + "items": { + "$ref": "#/components/schemas/CIIbansResource" + } + }, + "pageInfo": { + "$ref": "#/components/schemas/PageInfo" } } }, - "OperativeTable" : { - "required" : [ "createdBy", "email", "modifiedAt", "modifiedBy", "name", "referent", "taxCode", "telephone" ], - "type" : "object", - "properties" : { - "createdAt" : { - "type" : "string", - "format" : "date-time" - }, - "createdBy" : { - "type" : "string" - }, - "email" : { - "type" : "string" - }, - "modifiedAt" : { - "type" : "string", - "format" : "date-time" - }, - "modifiedBy" : { - "type" : "string" - }, - "name" : { - "type" : "string" - }, - "referent" : { - "type" : "string" - }, - "taxCode" : { - "type" : "string" - }, - "telephone" : { - "type" : "string" + "OperativeTable": { + "required": [ + "createdBy", + "email", + "modifiedAt", + "modifiedBy", + "name", + "referent", + "taxCode", + "telephone" + ], + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "format": "date-time" + }, + "createdBy": { + "type": "string" + }, + "email": { + "type": "string" + }, + "modifiedAt": { + "type": "string", + "format": "date-time" + }, + "modifiedBy": { + "type": "string" + }, + "name": { + "type": "string" + }, + "referent": { + "type": "string" + }, + "taxCode": { + "type": "string" + }, + "telephone": { + "type": "string" } } }, - "OperativeTableResourceList" : { - "required" : [ "operativeTableList" ], - "type" : "object", - "properties" : { - "operativeTableList" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/OperativeTable" + "OperativeTableResourceList": { + "required": [ + "operativeTableList" + ], + "type": "object", + "properties": { + "operativeTableList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OperativeTable" } } } }, - "PageInfo" : { - "required" : [ "limit", "page", "totalElements", "totalPages" ], - "type" : "object", - "properties" : { - "limit" : { - "type" : "integer", - "description" : "number of elements per page", - "format" : "int32" - }, - "page" : { - "type" : "integer", - "description" : "page number (0 is the first page)", - "format" : "int32" - }, - "totalElements" : { - "type" : "integer", - "description" : "total elements of elements", - "format" : "int64" - }, - "totalPages" : { - "type" : "integer", - "description" : "total number of pages", - "format" : "int64" + "PageInfo": { + "required": [ + "limit", + "page", + "totalElements", + "totalPages" + ], + "type": "object", + "properties": { + "limit": { + "type": "integer", + "description": "number of elements per page", + "format": "int32" + }, + "page": { + "type": "integer", + "description": "page number (0 is the first page)", + "format": "int32" + }, + "totalElements": { + "type": "integer", + "description": "total elements of elements", + "format": "int64" + }, + "totalPages": { + "type": "integer", + "description": "total number of pages", + "format": "int64" } }, - "description" : "information about the pagination" + "description": "information about the pagination" }, - "ProblemJson" : { - "type" : "object", - "properties" : { - "detail" : { - "type" : "string", - "description" : "A human readable explanation specific to this occurrence of the problem.", - "example" : "There was an error processing the request" - }, - "status" : { - "maximum" : 600, - "minimum" : 100, - "type" : "integer", - "description" : "The HTTP status code generated by the origin server for this occurrence of the problem.", - "format" : "int32", - "example" : 200 - }, - "title" : { - "type" : "string", - "description" : "A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized); example: Service Unavailable" + "ProblemJson": { + "type": "object", + "properties": { + "detail": { + "type": "string", + "description": "A human readable explanation specific to this occurrence of the problem.", + "example": "There was an error processing the request" + }, + "status": { + "maximum": 600, + "minimum": 100, + "type": "integer", + "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", + "format": "int32", + "example": 200 + }, + "title": { + "type": "string", + "description": "A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized); example: Service Unavailable" } } } }, - "securitySchemes" : { - "ApiKey" : { - "description" : "The Azure Subscription Key to access this API.", - "in" : "header", - "name" : "Ocp-Apim-Subscription-Key", - "type" : "apiKey" + "securitySchemes": { + "ApiKey": { + "description": "The Azure Subscription Key to access this API.", + "in": "header", + "name": "Ocp-Apim-Subscription-Key", + "type": "apiKey" } } } -} \ No newline at end of file +} diff --git a/openapi/openapi_backoffice_external_ec.json b/openapi/openapi_backoffice_external_ec.json index cfcec96..00ec243 100644 --- a/openapi/openapi_backoffice_external_ec.json +++ b/openapi/openapi_backoffice_external_ec.json @@ -1,610 +1,667 @@ { - "openapi" : "3.0.1", - "info" : { - "description" : "Microservice to expose REST API to contact PagoPA Backoffice", - "termsOfService" : "https://www.pagopa.gov.it/", - "title" : "Backoffice External - Backoffice External EC", - "version" : "1.1.2" + "openapi": "3.0.1", + "info": { + "description": "Microservice to expose REST API to contact PagoPA Backoffice", + "termsOfService": "https://www.pagopa.gov.it/", + "title": "Backoffice External - Backoffice External EC", + "version": "1.1.3" }, - "servers" : [ { - "url" : "http://localhost:8080" - }, { - "url" : "https://api.platform.pagopa.it/backoffice/external/ec/v1" - } ], - "paths" : { - "/brokers/{brokerCode}/creditor_institutions" : { - "get" : { - "description" : "Return the list of Creditor Institutions of a Broker", - "operationId" : "getBrokerInstitutions", - "parameters" : [ { - "description" : "Broker Code to use as filter for the retrieved creditor institution list", - "in" : "path", - "name" : "brokerCode", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "description" : "Number of elements on one page. Default = 10", - "in" : "query", - "name" : "limit", - "required" : false, - "schema" : { - "maximum" : 100, - "minimum" : 0, - "type" : "integer", - "format" : "int32", - "default" : 10 - } - }, { - "description" : "Page number. Page value starts from 0", - "in" : "query", - "name" : "page", - "required" : true, - "schema" : { - "minimum" : 0, - "type" : "integer", - "format" : "int32" + "servers": [ + { + "url": "http://localhost:8080" + }, + { + "url": "https://api.platform.pagopa.it/backoffice/external/ec/v1" + } + ], + "paths": { + "/brokers/{brokerCode}/creditor_institutions": { + "get": { + "description": "Return the list of Creditor Institutions of a Broker", + "operationId": "getBrokerInstitutions", + "parameters": [ + { + "description": "Broker Code to use as filter for the retrieved creditor institution list", + "in": "path", + "name": "brokerCode", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Number of elements on one page. Default = 10", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "maximum": 100, + "minimum": 0, + "type": "integer", + "format": "int32", + "default": 10 + } + }, + { + "description": "Page number. Page value starts from 0", + "in": "query", + "name": "page", + "required": true, + "schema": { + "minimum": 0, + "type": "integer", + "format": "int32" + } } - } ], - "responses" : { - "200" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/BrokerInstitutionsResponse" + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BrokerInstitutionsResponse" } } }, - "description" : "OK", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "description": "OK", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "400" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } }, - "description" : "Bad Request", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "description": "Bad Request", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "401" : { - "description" : "Unauthorized", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "401": { + "description": "Unauthorized", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "403" : { - "description" : "Forbidden", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "403": { + "description": "Forbidden", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "404" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } }, - "description" : "Institutions for the brokerCode not found", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "description": "Institutions for the brokerCode not found", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "429" : { - "description" : "Too many requests", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "429": { + "description": "Too many requests", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "500" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "500": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } }, - "description" : "Service unavailable", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "description": "Service unavailable", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } } }, - "security" : [ { - "ApiKey" : [ ] - } ], - "summary" : "getBrokerInstitutions", - "tags" : [ "External APIs" ] + "security": [ + { + "ApiKey": [] + } + ], + "summary": "getBrokerInstitutions", + "tags": [ + "External APIs" + ] }, - "parameters" : [ { - "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "in" : "header", - "name" : "X-Request-Id", - "schema" : { - "type" : "string" + "parameters": [ + { + "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "in": "header", + "name": "X-Request-Id", + "schema": { + "type": "string" + } } - } ] + ] }, - "/brokers/{brokerCode}/ibans" : { - "get" : { - "description" : "Return the list of Ibans of all the Creditor Institutions intermediated by the Broker", - "operationId" : "getBrokerIbans", - "parameters" : [ { - "description" : "Broker Code to use as filter for the retrieved ibans list", - "in" : "path", - "name" : "brokerCode", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "description" : "Number of elements on one page. Default = 10", - "in" : "query", - "name" : "limit", - "required" : false, - "schema" : { - "maximum" : 100, - "minimum" : 0, - "type" : "integer", - "format" : "int32", - "default" : 10 - } - }, { - "description" : "Page number. Page value starts from 0", - "in" : "query", - "name" : "page", - "required" : true, - "schema" : { - "minimum" : 0, - "type" : "integer", - "format" : "int32" + "/brokers/{brokerCode}/ibans": { + "get": { + "description": "Return the list of Ibans of all the Creditor Institutions intermediated by the Broker", + "operationId": "getBrokerIbans", + "parameters": [ + { + "description": "Broker Code to use as filter for the retrieved ibans list", + "in": "path", + "name": "brokerCode", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Number of elements on one page. Default = 10", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "maximum": 100, + "minimum": 0, + "type": "integer", + "format": "int32", + "default": 10 + } + }, + { + "description": "Page number. Page value starts from 0", + "in": "query", + "name": "page", + "required": true, + "schema": { + "minimum": 0, + "type": "integer", + "format": "int32" + } } - } ], - "responses" : { - "200" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/CIIbansResponse" + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CIIbansResponse" } } }, - "description" : "OK", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "description": "OK", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "400" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } }, - "description" : "Bad Request", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "description": "Bad Request", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "401" : { - "description" : "Unauthorized", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "401": { + "description": "Unauthorized", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "403" : { - "description" : "Forbidden", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "403": { + "description": "Forbidden", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "404" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } }, - "description" : "ibans for the brokerCode not found", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "description": "ibans for the brokerCode not found", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "429" : { - "description" : "Too many requests", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "429": { + "description": "Too many requests", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "500" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "500": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } }, - "description" : "Service unavailable", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "description": "Service unavailable", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } } }, - "security" : [ { - "ApiKey" : [ ] - } ], - "summary" : "getBrokerIbans", - "tags" : [ "External APIs" ] + "security": [ + { + "ApiKey": [] + } + ], + "summary": "getBrokerIbans", + "tags": [ + "External APIs" + ] }, - "parameters" : [ { - "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "in" : "header", - "name" : "X-Request-Id", - "schema" : { - "type" : "string" + "parameters": [ + { + "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "in": "header", + "name": "X-Request-Id", + "schema": { + "type": "string" + } } - } ] + ] }, - "/info" : { - "get" : { - "description" : "Return OK if application is started", - "operationId" : "healthCheck", - "responses" : { - "200" : { - "content" : { - "*/*" : { - "schema" : { - "$ref" : "#/components/schemas/AppInfo" + "/info": { + "get": { + "description": "Return OK if application is started", + "operationId": "healthCheck", + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/AppInfo" } } }, - "description" : "OK", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "description": "OK", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } } }, - "security" : [ { - "ApiKey" : [ ] - } ], - "summary" : "health check", - "tags" : [ "Home" ] + "security": [ + { + "ApiKey": [] + } + ], + "summary": "health check", + "tags": [ + "Home" + ] }, - "parameters" : [ { - "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "in" : "header", - "name" : "X-Request-Id", - "schema" : { - "type" : "string" + "parameters": [ + { + "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "in": "header", + "name": "X-Request-Id", + "schema": { + "type": "string" + } } - } ] + ] } }, - "components" : { - "schemas" : { - "AppInfo" : { - "type" : "object", - "properties" : { - "environment" : { - "type" : "string" - }, - "name" : { - "type" : "string" - }, - "version" : { - "type" : "string" + "components": { + "schemas": { + "AppInfo": { + "type": "object", + "properties": { + "environment": { + "type": "string" + }, + "name": { + "type": "string" + }, + "version": { + "type": "string" } } }, - "BrokerInstitutionResource" : { - "required" : [ "auxDigit", "brokerCompanyName", "brokerTaxCode", "ciStatus", "companyName", "intermediated", "model", "stationState", "taxCode", "version" ], - "type" : "object", - "properties" : { - "activationDate" : { - "type" : "string", - "description" : "activation date", - "format" : "date-time" - }, - "applicationCode" : { - "type" : "string", - "description" : "application code of the relation station-ec (unique per auxdigit)" - }, - "auxDigit" : { - "type" : "string", - "description" : "aux digit number (0,1,2,3, 0/3)" - }, - "broadcast" : { - "type" : "boolean", - "description" : "true if the station is for broadcast" - }, - "brokerCompanyName" : { - "type" : "string", - "description" : "broker name" - }, - "brokerTaxCode" : { - "type" : "string", - "description" : "broker tax code" - }, - "cbillCode" : { - "type" : "string", - "description" : "CBILL code" - }, - "ciStatus" : { - "type" : "boolean", - "description" : "True if the CI is enabled" - }, - "companyName" : { - "type" : "string", - "description" : "Creditor Institution name" - }, - "endpointMU" : { - "type" : "string", - "description" : "endpoint for Modello Unico" - }, - "endpointRT" : { - "type" : "string", - "description" : "endpoint for Ricevuta Telematica" - }, - "endpointRedirect" : { - "type" : "string", - "description" : "endpoint for Redirect" - }, - "intermediated" : { - "type" : "boolean", - "description" : "true if the EC has a broker" - }, - "model" : { - "type" : "integer", - "description" : "model of the station", - "format" : "int32" - }, - "primitiveVersion" : { - "type" : "integer", - "description" : "Version of the primitive", - "format" : "int32" - }, - "pspPayment" : { - "type" : "boolean", - "description" : "true if allows payments by the psp" - }, - "segregationCode" : { - "type" : "string", - "description" : "segregation code of the relation station-ec (unique per auxdigit)" - }, - "stationId" : { - "type" : "string", - "description" : "station code" - }, - "stationState" : { - "type" : "string", - "description" : "station state", - "example" : "enabled" - }, - "taxCode" : { - "type" : "string", - "description" : "Creditor Institution tax code" - }, - "version" : { - "type" : "string", - "description" : "station version", - "example" : "1" + "BrokerInstitutionResource": { + "required": [ + "auxDigit", + "brokerCompanyName", + "brokerTaxCode", + "ciStatus", + "companyName", + "intermediated", + "model", + "stationState", + "taxCode", + "version" + ], + "type": "object", + "properties": { + "activationDate": { + "type": "string", + "description": "activation date", + "format": "date-time" + }, + "applicationCode": { + "type": "string", + "description": "application code of the relation station-ec (unique per auxdigit)" + }, + "auxDigit": { + "type": "string", + "description": "aux digit number (0,1,2,3, 0/3)" + }, + "broadcast": { + "type": "boolean", + "description": "true if the station is for broadcast" + }, + "brokerCompanyName": { + "type": "string", + "description": "broker name" + }, + "brokerTaxCode": { + "type": "string", + "description": "broker tax code" + }, + "cbillCode": { + "type": "string", + "description": "CBILL code" + }, + "ciStatus": { + "type": "boolean", + "description": "True if the CI is enabled" + }, + "companyName": { + "type": "string", + "description": "Creditor Institution name" + }, + "endpointMU": { + "type": "string", + "description": "endpoint for Modello Unico" + }, + "endpointRT": { + "type": "string", + "description": "endpoint for Ricevuta Telematica" + }, + "endpointRedirect": { + "type": "string", + "description": "endpoint for Redirect" + }, + "intermediated": { + "type": "boolean", + "description": "true if the EC has a broker" + }, + "model": { + "type": "integer", + "description": "model of the station", + "format": "int32" + }, + "primitiveVersion": { + "type": "integer", + "description": "Version of the primitive", + "format": "int32" + }, + "pspPayment": { + "type": "boolean", + "description": "true if allows payments by the psp" + }, + "segregationCode": { + "type": "string", + "description": "segregation code of the relation station-ec (unique per auxdigit)" + }, + "stationId": { + "type": "string", + "description": "station code" + }, + "stationState": { + "type": "string", + "description": "station state", + "example": "enabled" + }, + "taxCode": { + "type": "string", + "description": "Creditor Institution tax code" + }, + "version": { + "type": "string", + "description": "station version", + "example": "1" } }, - "description" : "List of creditor institutions" + "description": "List of creditor institutions" }, - "BrokerInstitutionsResponse" : { - "required" : [ "creditorInstitutions", "pageInfo" ], - "type" : "object", - "properties" : { - "creditorInstitutions" : { - "type" : "array", - "description" : "List of creditor institutions", - "items" : { - "$ref" : "#/components/schemas/BrokerInstitutionResource" + "BrokerInstitutionsResponse": { + "required": [ + "creditorInstitutions", + "pageInfo" + ], + "type": "object", + "properties": { + "creditorInstitutions": { + "type": "array", + "description": "List of creditor institutions", + "items": { + "$ref": "#/components/schemas/BrokerInstitutionResource" } }, - "pageInfo" : { - "$ref" : "#/components/schemas/PageInfo" + "pageInfo": { + "$ref": "#/components/schemas/PageInfo" } } }, - "CIIbansResource" : { - "required" : [ "ciFiscalCode", "ciName", "iban", "status", "validityDate" ], - "type" : "object", - "properties" : { - "ciFiscalCode" : { - "type" : "string", - "description" : "Creditor Institution tax code" - }, - "ciName" : { - "type" : "string", - "description" : "Creditor Institution name" - }, - "description" : { - "type" : "string", - "description" : "description" - }, - "iban" : { - "type" : "string", - "description" : "iban" - }, - "label" : { - "type" : "string", - "description" : "label", - "example" : "CUP" - }, - "status" : { - "type" : "string", - "description" : "status", - "example" : "ENABLED" - }, - "validityDate" : { - "type" : "string", - "description" : "Activation Date", - "format" : "date-time" + "CIIbansResource": { + "required": [ + "ciFiscalCode", + "ciName", + "iban", + "status", + "validityDate" + ], + "type": "object", + "properties": { + "ciFiscalCode": { + "type": "string", + "description": "Creditor Institution tax code" + }, + "ciName": { + "type": "string", + "description": "Creditor Institution name" + }, + "description": { + "type": "string", + "description": "description" + }, + "iban": { + "type": "string", + "description": "iban" + }, + "label": { + "type": "string", + "description": "label", + "example": "CUP" + }, + "status": { + "type": "string", + "description": "status", + "example": "ENABLED" + }, + "validityDate": { + "type": "string", + "description": "Activation Date", + "format": "date-time" } }, - "description" : "list of IBANs" + "description": "list of IBANs" }, - "CIIbansResponse" : { - "required" : [ "ibans", "pageInfo" ], - "type" : "object", - "properties" : { - "ibans" : { - "type" : "array", - "description" : "list of IBANs", - "items" : { - "$ref" : "#/components/schemas/CIIbansResource" + "CIIbansResponse": { + "required": [ + "ibans", + "pageInfo" + ], + "type": "object", + "properties": { + "ibans": { + "type": "array", + "description": "list of IBANs", + "items": { + "$ref": "#/components/schemas/CIIbansResource" } }, - "pageInfo" : { - "$ref" : "#/components/schemas/PageInfo" + "pageInfo": { + "$ref": "#/components/schemas/PageInfo" } } }, - "PageInfo" : { - "required" : [ "limit", "page", "totalElements", "totalPages" ], - "type" : "object", - "properties" : { - "limit" : { - "type" : "integer", - "description" : "number of elements per page", - "format" : "int32" - }, - "page" : { - "type" : "integer", - "description" : "page number (0 is the first page)", - "format" : "int32" - }, - "totalElements" : { - "type" : "integer", - "description" : "total elements of elements", - "format" : "int64" - }, - "totalPages" : { - "type" : "integer", - "description" : "total number of pages", - "format" : "int64" + "PageInfo": { + "required": [ + "limit", + "page", + "totalElements", + "totalPages" + ], + "type": "object", + "properties": { + "limit": { + "type": "integer", + "description": "number of elements per page", + "format": "int32" + }, + "page": { + "type": "integer", + "description": "page number (0 is the first page)", + "format": "int32" + }, + "totalElements": { + "type": "integer", + "description": "total elements of elements", + "format": "int64" + }, + "totalPages": { + "type": "integer", + "description": "total number of pages", + "format": "int64" } }, - "description" : "information about the pagination" + "description": "information about the pagination" }, - "ProblemJson" : { - "type" : "object", - "properties" : { - "detail" : { - "type" : "string", - "description" : "A human readable explanation specific to this occurrence of the problem.", - "example" : "There was an error processing the request" - }, - "status" : { - "maximum" : 600, - "minimum" : 100, - "type" : "integer", - "description" : "The HTTP status code generated by the origin server for this occurrence of the problem.", - "format" : "int32", - "example" : 200 - }, - "title" : { - "type" : "string", - "description" : "A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized); example: Service Unavailable" + "ProblemJson": { + "type": "object", + "properties": { + "detail": { + "type": "string", + "description": "A human readable explanation specific to this occurrence of the problem.", + "example": "There was an error processing the request" + }, + "status": { + "maximum": 600, + "minimum": 100, + "type": "integer", + "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", + "format": "int32", + "example": 200 + }, + "title": { + "type": "string", + "description": "A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized); example: Service Unavailable" } } } }, - "securitySchemes" : { - "ApiKey" : { - "description" : "The Azure Subscription Key to access this API.", - "in" : "header", - "name" : "Ocp-Apim-Subscription-Key", - "type" : "apiKey" + "securitySchemes": { + "ApiKey": { + "description": "The Azure Subscription Key to access this API.", + "in": "header", + "name": "Ocp-Apim-Subscription-Key", + "type": "apiKey" } } } -} \ No newline at end of file +} diff --git a/openapi/openapi_backoffice_external_psp.json b/openapi/openapi_backoffice_external_psp.json index 777c00e..61ed964 100644 --- a/openapi/openapi_backoffice_external_psp.json +++ b/openapi/openapi_backoffice_external_psp.json @@ -1,304 +1,336 @@ { - "openapi" : "3.0.1", - "info" : { - "description" : "Microservice to expose REST API to contact PagoPA Backoffice", - "termsOfService" : "https://www.pagopa.gov.it/", - "title" : "Backoffice External - Backoffice External PSP", - "version" : "1.1.2" + "openapi": "3.0.1", + "info": { + "description": "Microservice to expose REST API to contact PagoPA Backoffice", + "termsOfService": "https://www.pagopa.gov.it/", + "title": "Backoffice External - Backoffice External PSP", + "version": "1.1.3" }, - "servers" : [ { - "url" : "http://localhost:8080" - }, { - "url" : "https://api.platform.pagopa.it/backoffice/external/psp/v1" - } ], - "paths" : { - "/creditor_institutions/ibans" : { - "get" : { - "description" : "Return the full list of Ibans of all CIs ", - "operationId" : "getCIsIbans", - "parameters" : [ { - "description" : "Number of elements on one page. Default = 10", - "in" : "query", - "name" : "limit", - "required" : false, - "schema" : { - "maximum" : 100, - "minimum" : 0, - "type" : "integer", - "format" : "int32", - "default" : 10 - } - }, { - "description" : "Page number. Page value starts from 0", - "in" : "query", - "name" : "page", - "required" : true, - "schema" : { - "minimum" : 0, - "type" : "integer", - "format" : "int32" + "servers": [ + { + "url": "http://localhost:8080" + }, + { + "url": "https://api.platform.pagopa.it/backoffice/external/psp/v1" + } + ], + "paths": { + "/creditor_institutions/ibans": { + "get": { + "description": "Return the full list of Ibans of all CIs ", + "operationId": "getCIsIbans", + "parameters": [ + { + "description": "Number of elements on one page. Default = 10", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "maximum": 100, + "minimum": 0, + "type": "integer", + "format": "int32", + "default": 10 + } + }, + { + "description": "Page number. Page value starts from 0", + "in": "query", + "name": "page", + "required": true, + "schema": { + "minimum": 0, + "type": "integer", + "format": "int32" + } } - } ], - "responses" : { - "200" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/CIIbansResponse" + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CIIbansResponse" } } }, - "description" : "OK", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "description": "OK", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "400" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } }, - "description" : "Bad Request", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "description": "Bad Request", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "401" : { - "description" : "Unauthorized", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "401": { + "description": "Unauthorized", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "429" : { - "description" : "Too many requests", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "429": { + "description": "Too many requests", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "500" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "500": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } }, - "description" : "Service unavailable", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "description": "Service unavailable", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } } }, - "security" : [ { - "ApiKey" : [ ] - } ], - "summary" : "getCIsIbans", - "tags" : [ "External APIs" ] + "security": [ + { + "ApiKey": [] + } + ], + "summary": "getCIsIbans", + "tags": [ + "External APIs" + ] }, - "parameters" : [ { - "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "in" : "header", - "name" : "X-Request-Id", - "schema" : { - "type" : "string" + "parameters": [ + { + "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "in": "header", + "name": "X-Request-Id", + "schema": { + "type": "string" + } } - } ] + ] }, - "/info" : { - "get" : { - "description" : "Return OK if application is started", - "operationId" : "healthCheck", - "responses" : { - "200" : { - "content" : { - "*/*" : { - "schema" : { - "$ref" : "#/components/schemas/AppInfo" + "/info": { + "get": { + "description": "Return OK if application is started", + "operationId": "healthCheck", + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/AppInfo" } } }, - "description" : "OK", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "description": "OK", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } } }, - "security" : [ { - "ApiKey" : [ ] - } ], - "summary" : "health check", - "tags" : [ "Home" ] + "security": [ + { + "ApiKey": [] + } + ], + "summary": "health check", + "tags": [ + "Home" + ] }, - "parameters" : [ { - "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "in" : "header", - "name" : "X-Request-Id", - "schema" : { - "type" : "string" + "parameters": [ + { + "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "in": "header", + "name": "X-Request-Id", + "schema": { + "type": "string" + } } - } ] + ] } }, - "components" : { - "schemas" : { - "AppInfo" : { - "type" : "object", - "properties" : { - "environment" : { - "type" : "string" + "components": { + "schemas": { + "AppInfo": { + "type": "object", + "properties": { + "environment": { + "type": "string" }, - "name" : { - "type" : "string" + "name": { + "type": "string" }, - "version" : { - "type" : "string" + "version": { + "type": "string" } } }, - "CIIbansResource" : { - "required" : [ "ciFiscalCode", "ciName", "iban", "status", "validityDate" ], - "type" : "object", - "properties" : { - "ciFiscalCode" : { - "type" : "string", - "description" : "Creditor Institution tax code" + "CIIbansResource": { + "required": [ + "ciFiscalCode", + "ciName", + "iban", + "status", + "validityDate" + ], + "type": "object", + "properties": { + "ciFiscalCode": { + "type": "string", + "description": "Creditor Institution tax code" }, - "ciName" : { - "type" : "string", - "description" : "Creditor Institution name" + "ciName": { + "type": "string", + "description": "Creditor Institution name" }, - "description" : { - "type" : "string", - "description" : "description" + "description": { + "type": "string", + "description": "description" }, - "iban" : { - "type" : "string", - "description" : "iban" + "iban": { + "type": "string", + "description": "iban" }, - "label" : { - "type" : "string", - "description" : "label", - "example" : "CUP" + "label": { + "type": "string", + "description": "label", + "example": "CUP" }, - "status" : { - "type" : "string", - "description" : "status", - "example" : "ENABLED" + "status": { + "type": "string", + "description": "status", + "example": "ENABLED" }, - "validityDate" : { - "type" : "string", - "description" : "Activation Date", - "format" : "date-time" + "validityDate": { + "type": "string", + "description": "Activation Date", + "format": "date-time" } }, - "description" : "list of IBANs" + "description": "list of IBANs" }, - "CIIbansResponse" : { - "required" : [ "ibans", "pageInfo" ], - "type" : "object", - "properties" : { - "ibans" : { - "type" : "array", - "description" : "list of IBANs", - "items" : { - "$ref" : "#/components/schemas/CIIbansResource" + "CIIbansResponse": { + "required": [ + "ibans", + "pageInfo" + ], + "type": "object", + "properties": { + "ibans": { + "type": "array", + "description": "list of IBANs", + "items": { + "$ref": "#/components/schemas/CIIbansResource" } }, - "pageInfo" : { - "$ref" : "#/components/schemas/PageInfo" + "pageInfo": { + "$ref": "#/components/schemas/PageInfo" } } }, - "PageInfo" : { - "required" : [ "limit", "page", "totalElements", "totalPages" ], - "type" : "object", - "properties" : { - "limit" : { - "type" : "integer", - "description" : "number of elements per page", - "format" : "int32" + "PageInfo": { + "required": [ + "limit", + "page", + "totalElements", + "totalPages" + ], + "type": "object", + "properties": { + "limit": { + "type": "integer", + "description": "number of elements per page", + "format": "int32" }, - "page" : { - "type" : "integer", - "description" : "page number (0 is the first page)", - "format" : "int32" + "page": { + "type": "integer", + "description": "page number (0 is the first page)", + "format": "int32" }, - "totalElements" : { - "type" : "integer", - "description" : "total elements of elements", - "format" : "int64" + "totalElements": { + "type": "integer", + "description": "total elements of elements", + "format": "int64" }, - "totalPages" : { - "type" : "integer", - "description" : "total number of pages", - "format" : "int64" + "totalPages": { + "type": "integer", + "description": "total number of pages", + "format": "int64" } }, - "description" : "information about pagination" + "description": "information about pagination" }, - "ProblemJson" : { - "type" : "object", - "properties" : { - "detail" : { - "type" : "string", - "description" : "A human readable explanation specific to this occurrence of the problem.", - "example" : "There was an error processing the request" + "ProblemJson": { + "type": "object", + "properties": { + "detail": { + "type": "string", + "description": "A human readable explanation specific to this occurrence of the problem.", + "example": "There was an error processing the request" }, - "status" : { - "maximum" : 600, - "minimum" : 100, - "type" : "integer", - "description" : "The HTTP status code generated by the origin server for this occurrence of the problem.", - "format" : "int32", - "example" : 200 + "status": { + "maximum": 600, + "minimum": 100, + "type": "integer", + "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", + "format": "int32", + "example": 200 }, - "title" : { - "type" : "string", - "description" : "A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized); example: Service Unavailable" + "title": { + "type": "string", + "description": "A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized); example: Service Unavailable" } } } }, - "securitySchemes" : { - "ApiKey" : { - "description" : "The Azure Subscription Key to access this API.", - "in" : "header", - "name" : "Ocp-Apim-Subscription-Key", - "type" : "apiKey" + "securitySchemes": { + "ApiKey": { + "description": "The Azure Subscription Key to access this API.", + "in": "header", + "name": "Ocp-Apim-Subscription-Key", + "type": "apiKey" } } } -} \ No newline at end of file +} diff --git a/openapi/openapi_backoffice_helpdesk.json b/openapi/openapi_backoffice_helpdesk.json index 11c5ddc..f24978a 100644 --- a/openapi/openapi_backoffice_helpdesk.json +++ b/openapi/openapi_backoffice_helpdesk.json @@ -1,266 +1,295 @@ { - "openapi" : "3.0.1", - "info" : { - "description" : "Microservice to expose REST API to contact PagoPA Backoffice", - "termsOfService" : "https://www.pagopa.gov.it/", - "title" : "Backoffice External - Backoffice Helpdesk", - "version" : "1.1.2" + "openapi": "3.0.1", + "info": { + "description": "Microservice to expose REST API to contact PagoPA Backoffice", + "termsOfService": "https://www.pagopa.gov.it/", + "title": "Backoffice External - Backoffice Helpdesk", + "version": "1.1.3" }, - "servers" : [ { - "url" : "http://localhost:8080" - }, { - "url" : "https://api.platform.pagopa.it/backoffice/helpdesk/v1" - } ], - "paths" : { - "/info" : { - "get" : { - "description" : "Return OK if application is started", - "operationId" : "healthCheck", - "responses" : { - "200" : { - "content" : { - "*/*" : { - "schema" : { - "$ref" : "#/components/schemas/AppInfo" + "servers": [ + { + "url": "http://localhost:8080" + }, + { + "url": "https://api.platform.pagopa.it/backoffice/helpdesk/v1" + } + ], + "paths": { + "/info": { + "get": { + "description": "Return OK if application is started", + "operationId": "healthCheck", + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/AppInfo" } } }, - "description" : "OK", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "description": "OK", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } } }, - "security" : [ { - "ApiKey" : [ ] - } ], - "summary" : "health check", - "tags" : [ "Home" ] + "security": [ + { + "ApiKey": [] + } + ], + "summary": "health check", + "tags": [ + "Home" + ] }, - "parameters" : [ { - "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "in" : "header", - "name" : "X-Request-Id", - "schema" : { - "type" : "string" + "parameters": [ + { + "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "in": "header", + "name": "X-Request-Id", + "schema": { + "type": "string" + } } - } ] + ] }, - "/operative_tables" : { - "get" : { - "description" : "Get All operative tables", - "operationId" : "getOperativeTables", - "parameters" : [ { - "description" : "Tax code", - "in" : "query", - "name" : "taxCode", - "required" : false, - "schema" : { - "type" : "string", - "default" : "" - } - }, { - "description" : "Business name", - "in" : "query", - "name" : "businessName", - "required" : false, - "schema" : { - "type" : "string", - "default" : "" + "/operative_tables": { + "get": { + "description": "Get All operative tables", + "operationId": "getOperativeTables", + "parameters": [ + { + "description": "Tax code", + "in": "query", + "name": "taxCode", + "required": false, + "schema": { + "type": "string", + "default": "" + } + }, + { + "description": "Business name", + "in": "query", + "name": "businessName", + "required": false, + "schema": { + "type": "string", + "default": "" + } } - } ], - "responses" : { - "200" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/OperativeTableResourceList" + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OperativeTableResourceList" } } }, - "description" : "OK", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "description": "OK", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "400" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } }, - "description" : "Bad Request", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "description": "Bad Request", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "401" : { - "description" : "Unauthorized", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "401": { + "description": "Unauthorized", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "429" : { - "description" : "Too many requests", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "429": { + "description": "Too many requests", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "500" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "500": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } }, - "description" : "Service unavailable", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "description": "Service unavailable", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } } }, - "security" : [ { - "ApiKey" : [ ] - } ], - "summary" : "getOperativeTables", - "tags" : [ "Operative Tables" ] + "security": [ + { + "ApiKey": [] + } + ], + "summary": "getOperativeTables", + "tags": [ + "Operative Tables" + ] }, - "parameters" : [ { - "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "in" : "header", - "name" : "X-Request-Id", - "schema" : { - "type" : "string" + "parameters": [ + { + "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "in": "header", + "name": "X-Request-Id", + "schema": { + "type": "string" + } } - } ] + ] } }, - "components" : { - "schemas" : { - "AppInfo" : { - "type" : "object", - "properties" : { - "environment" : { - "type" : "string" + "components": { + "schemas": { + "AppInfo": { + "type": "object", + "properties": { + "environment": { + "type": "string" }, - "name" : { - "type" : "string" + "name": { + "type": "string" }, - "version" : { - "type" : "string" + "version": { + "type": "string" } } }, - "OperativeTable" : { - "required" : [ "createdBy", "email", "modifiedAt", "modifiedBy", "name", "referent", "taxCode", "telephone" ], - "type" : "object", - "properties" : { - "createdAt" : { - "type" : "string", - "format" : "date-time" + "OperativeTable": { + "required": [ + "createdBy", + "email", + "modifiedAt", + "modifiedBy", + "name", + "referent", + "taxCode", + "telephone" + ], + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "format": "date-time" }, - "createdBy" : { - "type" : "string" + "createdBy": { + "type": "string" }, - "email" : { - "type" : "string" + "email": { + "type": "string" }, - "modifiedAt" : { - "type" : "string", - "format" : "date-time" + "modifiedAt": { + "type": "string", + "format": "date-time" }, - "modifiedBy" : { - "type" : "string" + "modifiedBy": { + "type": "string" }, - "name" : { - "type" : "string" + "name": { + "type": "string" }, - "referent" : { - "type" : "string" + "referent": { + "type": "string" }, - "taxCode" : { - "type" : "string" + "taxCode": { + "type": "string" }, - "telephone" : { - "type" : "string" + "telephone": { + "type": "string" } } }, - "OperativeTableResourceList" : { - "required" : [ "operativeTableList" ], - "type" : "object", - "properties" : { - "operativeTableList" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/OperativeTable" + "OperativeTableResourceList": { + "required": [ + "operativeTableList" + ], + "type": "object", + "properties": { + "operativeTableList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OperativeTable" } } } }, - "ProblemJson" : { - "type" : "object", - "properties" : { - "detail" : { - "type" : "string", - "description" : "A human readable explanation specific to this occurrence of the problem.", - "example" : "There was an error processing the request" + "ProblemJson": { + "type": "object", + "properties": { + "detail": { + "type": "string", + "description": "A human readable explanation specific to this occurrence of the problem.", + "example": "There was an error processing the request" }, - "status" : { - "maximum" : 600, - "minimum" : 100, - "type" : "integer", - "description" : "The HTTP status code generated by the origin server for this occurrence of the problem.", - "format" : "int32", - "example" : 200 + "status": { + "maximum": 600, + "minimum": 100, + "type": "integer", + "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", + "format": "int32", + "example": 200 }, - "title" : { - "type" : "string", - "description" : "A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized); example: Service Unavailable" + "title": { + "type": "string", + "description": "A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized); example: Service Unavailable" } } } }, - "securitySchemes" : { - "ApiKey" : { - "description" : "The Azure Subscription Key to access this API.", - "in" : "header", - "name" : "Ocp-Apim-Subscription-Key", - "type" : "apiKey" + "securitySchemes": { + "ApiKey": { + "description": "The Azure Subscription Key to access this API.", + "in": "header", + "name": "Ocp-Apim-Subscription-Key", + "type": "apiKey" } } } -} \ No newline at end of file +} diff --git a/pom.xml b/pom.xml index 2eb7d3c..5e52a91 100644 --- a/pom.xml +++ b/pom.xml @@ -12,7 +12,7 @@ it.pagopa.selfcare.pagopa pagopa-backoffice-external - 1.1.2 + 1.1.3 Backoffice External Microservice to expose REST API to contact PagoPA Backoffice