PagoPA Health Check API

openapi: 3.2.0
info:
  title: Pagopa Health Check API
  x-refined-note:
  - x-api-id differs across the merged source definitions and was not carried
  - x-audience differs across the merged source definitions and was not carried
  - x-summary differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged Health Check across 4 of this provider''s published API definitions: interop-organization-id-verification.yaml, io-sign-issuer.yaml, pagopa-firma-con-io-issuer-openapi.yml, pagopa-pdnd-attestation-organization-id-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- description: Ambiente di Attestazione
  url: https://mtls.eservices.att.interop.pagopa.it/
- url: https://api.io.pagopa.it/api/v1/sign
  description: production
- url: http://localhost:7071/api/v1/sign
  description: local
tags:
- name: Health Check
  description: Unauthenticated endpoint for checking service status
paths:
  /organization-id-verification/status:
    get:
      summary: Returns the application state
      description: 'Returns the application status: 200 if it is working correctly

        or an error if the application is temporarily unavailable

        for maintenance or a technical problem.'
      operationId: get_status
      tags:
      - Health Check
      responses:
        '200':
          description: 'The server has returned to status. In case of problems

            always returns a problem+json.

            '
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
    servers:
    - description: Ambiente di Attestazione
      url: https://mtls.eservices.att.interop.pagopa.it/
  /info:
    get:
      operationId: getInfo
      tags:
      - Health Check
      summary: Health check endpoint
      security: []
      responses:
        '200':
          description: Used to check if the function is active
          content:
            application/json:
              schema:
                type: object
                required:
                - message
                - version
                properties:
                  message:
                    type: string
                    example: It's working!
                  version:
                    type: string
                    example: 0.20.1
        '500':
          $ref: '#/components/responses/Unexpected'
        default:
          $ref: '#/components/responses/Unexpected'
    servers:
    - url: https://api.io.pagopa.it/api/v1/sign
      description: production
    - url: http://localhost:7071/api/v1/sign
      description: local
  /keychain-mock/status:
    get:
      summary: Returns the application state
      description: 'Returns the application status: 200 if it is working correctly

        or an error if the application is temporarily unavailable

        for maintenance or a technical problem.'
      operationId: get_status
      tags:
      - Health Check
      responses:
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '429':
          $ref: '#/components/responses/429TooManyRequests'
        '503':
          $ref: '#/components/responses/503ServiceUnavailable'
        default:
          $ref: '#/components/responses/default'
        '200':
          description: 'The server has returned to status. In case of problems

            always returns a problem+json..

            '
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
    servers:
    - description: Ambiente di Attestazione
      url: https://mtls.eservices.att.interop.pagopa.it/
  /subject-id-verification/status:
    get:
      summary: Returns the application state
      description: 'Returns the application status: 200 if it is working correctly

        or an error if the application is temporarily unavailable

        for maintenance or a technical problem.'
      operationId: getSubjectIdVerificationStatus
      tags:
      - Health Check
      responses:
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '429':
          $ref: '#/components/responses/429TooManyRequests'
        '503':
          $ref: '#/components/responses/503ServiceUnavailable'
        default:
          $ref: '#/components/responses/default'
        '200':
          description: 'The server has returned to status. In case of problems

            always returns a problem+json..

            '
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      x-operation-id-source: normalized
      x-operation-id-original: get_status
    servers:
    - description: Ambiente di Attestazione
      url: https://mtls.eservices.att.interop.pagopa.it/
  /status:
    get:
      summary: status path
      description: status path per verificare lo stato di Piattaforma Notifiche
      tags:
      - Health Check
      operationId: status
      responses:
        '200':
          description: Ok
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/PnStatusResponse'
              example:
                functionalities:
                - NOTIFICATION_CREATE
                - NOTIFICATION_VISUALIZATION
                - NOTIFICATION_WORKFLOW
                openIncidents: []
        '400':
          description: Bad request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem_2'
        '500':
          description: Internal Server Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/PnStatusResponse'
              example:
                functionalities:
                - NOTIFICATION_CREATE
                - NOTIFICATION_VISUALIZATION
                - NOTIFICATION_WORKFLOW
                openIncidents:
                - functionality: NOTIFICATION_CREATE
                  status: KO
                  startDate: '2019-08-24T14:15:22Z'
      security:
      - ApiKeyAuth: []
    servers:
    - url: https://api.notifichedigitali.it
      description: Ambiente di produzione
    - url: https://api.uat.notifichedigitali.it
      description: Ambiente di collaudo
components:
  schemas:
    Problem:
      properties:
        detail:
          description: 'A human readable explanation specific to this occurrence of the

            problem. You MUST NOT expose internal informations, personal

            data or implementation details through this field.

            '
          example: Request took too long to complete.
          type: string
        instance:
          description: 'An absolute URI that identifies the specific occurrence of the problem.

            It may or may not yield further information if dereferenced.

            '
          format: uri
          type: string
        status:
          description: 'The HTTP status code generated by the origin server for this occurrence

            of the problem.

            '
          example: 503
          format: int32
          minimum: 100
          type: integer
          exclusiveMaximum: 600
        title:
          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

            '
          type: string
        type:
          default: about:blank
          description: 'An absolute URI that identifies the problem type.  When dereferenced,

            it SHOULD provide human-readable documentation for the problem type

            (e.g., using HTML).

            '
          format: uri
          type: string
      type: object
    ProblemDetail:
      type: object
      properties:
        type:
          type: string
          format: uri
          description: 'An absolute URI that identifies the problem type. When dereferenced,

            it SHOULD provide human-readable documentation for the problem type

            (e.g., using HTML).'
          default: about:blank
          example: https://example.com/problem/constraint-violation
        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'
        status:
          type: integer
          format: int32
          description: The HTTP status code generated by the origin server for this occurrence of the problem.
          minimum: 100
          example: 200
          exclusiveMaximum: 600
        detail:
          type: string
          description: 'A human readable explanation specific to this occurrence of the

            problem.'
          example: There was an error processing the request
        instance:
          type: string
          format: uri
          description: An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
    PnFunctionality:
      title: Funzionalità di PN
      description: "- __NOTIFICATION_CREATE__: la possibilità di creare nuove notifiche.\n- __NOTIFICATION_VISUALIZATION__: la possibilità di visualizzare le notifiche e scaricare gli atti. \n- __NOTIFICATION_WORKFLOW__: l'avanzamento del processo di notifica. "
      type: string
      enum:
      - NOTIFICATION_CREATE
      - NOTIFICATION_VISUALIZATION
      - NOTIFICATION_WORKFLOW
      x-enum-varnames:
      - NOTIFICATION_CREATE
      - NOTIFICATION_VISUALIZATION
      - NOTIFICATION_WORKFLOW
    PnDowntimeEntry:
      title: Dati relativi ad un disservizio di PN.
      type: object
      required:
      - functionality
      - status
      - startDate
      properties:
        functionality:
          $ref: '#/components/schemas/PnFunctionality'
        status:
          $ref: '#/components/schemas/PnFunctionalityStatus'
        startDate:
          title: data inizio disservizio
          type: string
          format: date-time
        endDate:
          title: data fine disservizio
          description: se il disservizio è ancora attivo questo campo sarà assente o con valore _null_
          type: string
          format: date-time
        legalFactId:
          title: id dell'atto opponibile a terzi
          description: Se assente o valorizzato _null_ indica che l'atto opponibile a terzi non è ancora disponibile. Questo avviene per i disservizi ancora aperti e per i disservizi  terminati da pochi minuti. <br/> Questo valore è da utilizzare con l'API _getLegalFact_ di questo stesso servizio.
          type: string
        fileAvailable:
          type: boolean
    PnStatusResponse:
      title: Stato attuale di PN
      description: Elenco delle funzionalità della piattaforma ed elenco dei disservizi noti e attivi  al momento della richiesta. I disservizi (_openIncidents_) segnalati sono al più uno  per funzionalità; gli attributi _endDate_ e _legalFactId_ non saranno valorizzati.
      type: object
      required:
      - functionalities
      - openIncidents
      properties:
        status:
          description: Bad Request
          example: 400
          format: int32
          minimum: 100
          type: integer
          exclusiveMaximum: 600
        title:
          description: The server cannot process the request
          example: Bad Request
          maxLength: 64
          pattern: ^[ -~]{0,64}$
          type: string
        detail:
          description: The server cannot process the request
          example: Bad Request
          maxLength: 4096
          pattern: ^.{0,4096}$
          type: string
        functionalities:
          title: elenco funzionalità di PN
          description: Un array che comprende tutti i possibili valori dell'enum _PnFunctionality_
          type: array
          items:
            $ref: '#/components/schemas/PnFunctionality'
        openIncidents:
          title: elenco disservizi correnti
          description: Al più uno per funzionalità
          type: array
          items:
            $ref: '#/components/schemas/PnDowntimeEntry'
    Problem_2:
      properties:
        type:
          description: URI reference of type definition
          type: string
        status:
          description: The HTTP status code generated by the origin server for this occurrence of the problem.
          type: integer
          format: int32
          example: 503
          minimum: 100
          exclusiveMaximum: 600
        title:
          description: A short, summary of the problem type. Written in english and readable
          example: Service Unavailable
          maxLength: 64
          pattern: ^[ -~]{0,64}$
          type: string
        detail:
          description: A human readable explanation of the problem.
          example: Request took too long to complete.
          maxLength: 4096
          pattern: ^.{0,4096}$
          type: string
        traceId:
          description: Internal support identifier associated to error
          example: 123e4567-e89b-12d3-a456-426614174000
          type: string
        timestamp:
          description: date and time referred to UTC
          example: '2022-07-27T12:22:33.444Z'
          type: string
          format: date-time
        errors:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/ProblemError'
      required:
      - status
      - errors
    ProblemError:
      properties:
        code:
          description: Internal code of the error, in human-readable format
          example: PN_PARAMETER_TOO_LONG | PN_PARAMETER_TOO_SHORT | PN_DUPLICATE_ENTRY | etc...
          type: string
        element:
          description: Parameter or request body field name for validation error
          example: body.order.item[2].quantity
          type: string
        detail:
          description: A human readable explanation specific to this occurrence of the problem.
          example: Parameter not valid
          maxLength: 1024
          type: string
      required:
      - code
    PnFunctionalityStatus:
      type: string
      enum:
      - KO
      - OK
    Problem_3:
      properties:
        type:
          description: URI reference of type definition
          type: string
        status:
          description: The HTTP status code generated by the origin server for this occurrence of the problem.
          type: integer
          format: int32
          example: 503
          minimum: 100
          exclusiveMaximum: 600
        title:
          description: A short, summary of the problem type. Written in english and readable
          example: Service Unavailable
          maxLength: 64
          pattern: ^[ -~]{0,64}$
          type: string
        detail:
          description: A human readable explanation of the problem.
          example: Request took too long to complete.
          maxLength: 4096
          pattern: ^.{0,4096}$
          type: string
        traceId:
          description: Internal support identifier associated to error
          example: 123e4567-e89b-12d3-a456-426614174000
          type: string
        timestamp:
          description: date and time referred to UTC
          example: '2022-07-27T12:22:33.444Z'
          type: string
          format: date-time
        errors:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/ProblemError'
      required:
      - status
      - errors
  responses:
    Unexpected:
      description: Unexpected error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ProblemDetail'
    429TooManyRequests:
      description: Too many requests
      headers:
        Retry-After:
          $ref: '#/components/headers/Retry-After'
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
    401Unauthorized:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
      headers:
        WWW-Authenticate:
          $ref: '#/components/headers/WWW-Authenticate'
      description: Not authorized
    400BadRequest:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
      description: Bad Request
    default:
      description: Unexpected error
    503ServiceUnavailable:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
      description: Service Unavailable
      headers:
        Retry-After:
          $ref: '#/components/headers/Retry-After'
  securitySchemes:
    SubscriptionKey:
      type: apiKey
      name: Ocp-Apim-Subscription-Key
      in: header
      description: The API key can be obtained from the reserved area
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
  headers:
    WWW-Authenticate:
      description: 'Auth realm=APIkey

        See https://tools.ietf.org/html/rfc7235#section-4.1'
      schema:
        type: string
    Retry-After:
      description: 'Retry contacting the endpoint *at least* after seconds.

        See https://tools.ietf.org/html/rfc7231#section-7.1.3'
      schema:
        type: string
    X-RateLimit-Limit:
      description: The number of allowed requests in the current period
      schema:
        type: string
    X-RateLimit-Remaining:
      description: The number of remaining requests in the current period
      schema:
        type: string
    X-RateLimit-Reset:
      description: The number of seconds left in the current period
      schema:
        type: string
x-refined-from:
- interop-organization-id-verification.yaml
- io-sign-issuer.yaml
- pagopa-firma-con-io-issuer-openapi.yml
- pagopa-pdnd-attestation-organization-id-openapi.yml