PagoPA Network Testing API

openapi: 3.2.0
info:
  title: Pagopa Network Testing API
  version: 1.3.3-SNAPSHOT
  contact:
    name: PagoPA S.p.A.
    email: cstar@pagopa.it
  description: 'Operations tagged Network Testing across 2 of this provider''s published API definitions: mdc-emd-tpp-testing.yml, pagopa-mdc-tpp-testing-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- description: Development Test
  url: https://api-emd.dev.cstar.pagopa.it/emd/mdc/tpp
  x-internal: true
- description: User Acceptance Test
  url: https://api-emd.uat.cstar.pagopa.it/emd/mdc/tpp
  x-internal: true
- description: Prod
  url: https://api-emd.cstar.pagopa.it/emd/mdc/tpp
  x-internal: false
tags:
- name: Network Testing
  description: Testing network connection
paths:
  /network/connection/{tppName}:
    get:
      tags:
      - Network Testing
      summary: 'ENG: Returns the confirm of network connection from TPP to PagoPA'
      operationId: getNetworkConnection
      description: Get network connection info
      security:
      - oAuth2: []
      parameters:
      - name: Accept-Language
        in: header
        description: 'ENG: Language - IT: Lingua'
        schema:
          type: string
          pattern: ^[ -~]{2,5}$
          minLength: 2
          maxLength: 5
          example: it-IT
          default: it-IT
        required: true
      - name: tppName
        in: path
        description: Company Name
        required: true
        schema:
          type: string
          pattern: ^[ -~]{1,70}$
          minLength: 1
          maxLength: 70
          example: BancaX
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TppNetworkConnectionResponse'
          headers:
            Access-Control-Allow-Origin:
              description: Indicates whether the response can be shared with requesting code from the given origin
              required: false
              schema:
                $ref: '#/components/schemas/AccessControlAllowOrigin'
            RateLimit-Limit:
              description: The number of allowed requests in the current period
              required: false
              schema:
                $ref: '#/components/schemas/RateLimitLimit'
            RateLimit-Reset:
              description: The number of seconds left in the current period
              required: false
              schema:
                $ref: '#/components/schemas/RateLimitReset'
            Retry-After:
              description: The number of seconds to wait before allowing a follow-up request
              required: false
              schema:
                $ref: '#/components/schemas/RetryAfter'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TPPErrorDTO'
              example:
                code: TPP_BAD_REQUEST
                message: Something went wrong handling the request
          headers:
            Access-Control-Allow-Origin:
              description: Indicates whether the response can be shared with requesting code from the given origin
              required: false
              schema:
                $ref: '#/components/schemas/AccessControlAllowOrigin'
            RateLimit-Limit:
              description: The number of allowed requests in the current period
              required: false
              schema:
                $ref: '#/components/schemas/RateLimitLimit'
            RateLimit-Reset:
              description: The number of seconds left in the current period
              required: false
              schema:
                $ref: '#/components/schemas/RateLimitReset'
            Retry-After:
              description: The number of seconds to wait before allowing a follow-up request
              required: false
              schema:
                $ref: '#/components/schemas/RetryAfter'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TPPErrorDTO'
              example:
                code: TPP_AUTHENTICATION_FAILED
                message: Something went wrong with authentication
          headers:
            Access-Control-Allow-Origin:
              description: Indicates whether the response can be shared with requesting code from the given origin
              required: false
              schema:
                $ref: '#/components/schemas/AccessControlAllowOrigin'
            RateLimit-Limit:
              description: The number of allowed requests in the current period
              required: false
              schema:
                $ref: '#/components/schemas/RateLimitLimit'
            RateLimit-Reset:
              description: The number of seconds left in the current period
              required: false
              schema:
                $ref: '#/components/schemas/RateLimitReset'
            Retry-After:
              description: The number of seconds to wait before allowing a follow-up request
              required: false
              schema:
                $ref: '#/components/schemas/RetryAfter'
        '404':
          description: The TPP was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TPPErrorDTO'
              example:
                code: TPP_NOT_ONBOARDED
                message: Tpp not onboarded
          headers:
            Access-Control-Allow-Origin:
              description: Indicates whether the response can be shared with requesting code from the given origin
              required: false
              schema:
                $ref: '#/components/schemas/AccessControlAllowOrigin'
            RateLimit-Limit:
              description: The number of allowed requests in the current period
              required: false
              schema:
                $ref: '#/components/schemas/RateLimitLimit'
            RateLimit-Reset:
              description: The number of seconds left in the current period
              required: false
              schema:
                $ref: '#/components/schemas/RateLimitReset'
            Retry-After:
              description: The number of seconds to wait before allowing a follow-up request
              required: false
              schema:
                $ref: '#/components/schemas/RetryAfter'
        '429':
          description: Too many Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TPPErrorDTO'
              example:
                code: TPP_TOO_MANY_REQUESTS
                message: Too many requests
          headers:
            Access-Control-Allow-Origin:
              description: Indicates whether the response can be shared with requesting code from the given origin
              required: false
              schema:
                $ref: '#/components/schemas/AccessControlAllowOrigin'
            RateLimit-Limit:
              description: The number of allowed requests in the current period
              required: false
              schema:
                $ref: '#/components/schemas/RateLimitLimit'
            RateLimit-Reset:
              description: The number of seconds left in the current period
              required: false
              schema:
                $ref: '#/components/schemas/RateLimitReset'
            Retry-After:
              description: The number of seconds to wait before allowing a follow-up request
              required: false
              schema:
                $ref: '#/components/schemas/RetryAfter'
        '500':
          description: Server ERROR
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TPPErrorDTO'
              example:
                code: TPP_GENERIC_ERROR
                message: Application error
          headers:
            Access-Control-Allow-Origin:
              description: Indicates whether the response can be shared with requesting code from the given origin
              required: false
              schema:
                $ref: '#/components/schemas/AccessControlAllowOrigin'
            RateLimit-Limit:
              description: The number of allowed requests in the current period
              required: false
              schema:
                $ref: '#/components/schemas/RateLimitLimit'
            RateLimit-Reset:
              description: The number of seconds left in the current period
              required: false
              schema:
                $ref: '#/components/schemas/RateLimitReset'
            Retry-After:
              description: The number of seconds to wait before allowing a follow-up request
              required: false
              schema:
                $ref: '#/components/schemas/RetryAfter'
    servers:
    - description: Development Test
      url: https://api-emd.dev.cstar.pagopa.it/emd/mdc/tpp
      x-internal: true
    - description: User Acceptance Test
      url: https://api-emd.uat.cstar.pagopa.it/emd/mdc/tpp
      x-internal: true
    - description: Prod
      url: https://api-emd.cstar.pagopa.it/emd/mdc/tpp
      x-internal: false
components:
  schemas:
    TPPErrorDTO:
      type: object
      required:
      - code
      - message
      properties:
        code:
          type: string
          enum:
          - TPP_BAD_REQUEST
          - TPP_TOO_MANY_REQUESTS
          - TPP_GENERIC_ERROR
          - TPP_AUTHENTICATION_FAILED
          description: "\"ENG: Error code: TPP_BAD_REQUEST: Something went wrong handling the request,\n TPP_TOO_MANY_REQUESTS: Too many requests,\n TPP_GENERIC_ERROR: Application Error,\n TPP_AUTHENTICATION_FAILED: Something went wrong with authentication - IT: Codice di errore:\n TPP_BAD_REQUEST:  Qualcosa è andato storto durante l'invio della richiesta,\n TPP_TOO_MANY_REQUESTS: Troppe richieste,\n TPP_GENERIC_ERROR: Errore generico,\n TPP_AUTHENTICATION_FAILED: Qualcosa è andato storto con l'autenticazione,"
        message:
          type: string
          description: 'ENG: Error message - IT: Messaggio di errore'
          maxLength: 250
          pattern: ^[\w\s.,!?'"-]+$
    RetryAfter:
      description: The number of seconds to wait before allowing a follow-up request
      type: integer
      format: int32
      minimum: 1
      maximum: 240
    RateLimitLimit:
      description: The number of allowed requests in the current period
      type: integer
      format: int32
      minimum: 1
      maximum: 240
    RateLimitReset:
      description: The number of seconds left in the current period
      type: integer
      format: int32
      minimum: 1
      maximum: 60
    AccessControlAllowOrigin:
      description: Indicates whether the response can be shared with requesting code from the given origin
      type: string
      pattern: ^[ -~]{1,2048}$
      minLength: 1
      maxLength: 2048
    TppNetworkConnectionResponse:
      type: object
      required:
      - code
      - message
      properties:
        code:
          type: string
          enum:
          - PAGOPA_NETWORK_TEST
          description: "\"ENG: Message code: PAGOPA_NETWORK_TEST: BancaX has reached our systems,\n - IT: Codice messaggio: PAGOPA_NETWORK_TEST: BancaX ha raggiunto i nostri sistemi\""
        message:
          type: string
          description: 'ENG: Messagge - IT: Messaggio'
          maxLength: 250
          pattern: ^[\w\s.,!?'"-]+$
          example: BancaX has reached our systems
  securitySchemes:
    oAuth2:
      description: 'A bearer token in the format of a JWS and conforms to the specifications

        included in RFC8725.

        '
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: /token
          refreshUrl: /token
          scopes: {}
x-refined-from:
- mdc-emd-tpp-testing.yml
- pagopa-mdc-tpp-testing-openapi.yml