openapi: 3.2.0
info:
  title: Pagopa Signals API
  version: '1.0'
  contact:
    name: API Support
    url: https://github.com/pagopa/pdnd-interop-frontend/issues
  termsOfService: https://selfcare.interop.pagopa.it/ui/it/termini-di-servizio
  description: 'Operations tagged Signals across 4 of this provider''s published API definitions: signalhub-pull.yaml, signalhub-push.yaml, pagopa-pdnd-signal-hub-pull-openapi.yml, pagopa-pdnd-signal-hub-push-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.signalhub.interop.pagopa.it/1.0/pull
  description: Production environment
- url: https://api.signalhub.interop.pagopa.it/1.0/push
  description: Production environment
tags:
- name: Signals
paths:
  /signals/{eserviceId}:
    get:
      description: Retrieve a list o signals on a specific eservice starting from signalId
      summary: Get a list of signals
      operationId: pullSignal
      parameters:
      - schema:
          type: string
        required: true
        name: eserviceId
        in: path
      - schema:
          type:
          - number
          - 'null'
          minimum: 0
          default: 0
        required: false
        name: signalId
        in: query
      - schema:
          type: number
          minimum: 1
          maximum: 100
          default: 10
        required: false
        name: size
        in: query
      - schema:
          type: string
        required: true
        name: authorization
        in: header
      responses:
        '200':
          description: '200'
          headers:
            X-Rate-Limit-Limit:
              schema:
                type: integer
              description: Max allowed requests within time interval
            X-Rate-Limit-Remaining:
              schema:
                type: integer
              description: Remaining requests within time interval
            X-Rate-Limit-Interval:
              schema:
                type: integer
              description: Time interval in milliseconds. Allowed requests will be constantly replenished during the interval. At the end of the interval the max allowed requests will be available
            X-RateLimit-Reset:
              schema:
                type: integer
              description: Time at which the rate limit resets, specified in UTC epoch time
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignalPullResponse'
        '206':
          description: '206'
          headers:
            X-Rate-Limit-Limit:
              schema:
                type: integer
              description: Max allowed requests within time interval
            X-Rate-Limit-Remaining:
              schema:
                type: integer
              description: Remaining requests within time interval
            X-Rate-Limit-Interval:
              schema:
                type: integer
              description: Time interval in milliseconds. Allowed requests will be constantly replenished during the interval. At the end of the interval the max allowed requests will be available
            X-RateLimit-Reset:
              schema:
                type: integer
              description: Time at which the rate limit resets, specified in UTC epoch time
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignalPullResponse'
        '400':
          description: '400'
          headers:
            X-Rate-Limit-Limit:
              schema:
                type: integer
              description: Max allowed requests within time interval
            X-Rate-Limit-Remaining:
              schema:
                type: integer
              description: Remaining requests within time interval
            X-Rate-Limit-Interval:
              schema:
                type: integer
              description: Time interval in milliseconds. Allowed requests will be constantly replenished during the interval. At the end of the interval the max allowed requests will be available
            X-RateLimit-Reset:
              schema:
                type: integer
              description: Time at which the rate limit resets, specified in UTC epoch time
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/problem'
        '401':
          description: '401'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/problem'
        '403':
          description: '403'
          headers:
            X-Rate-Limit-Limit:
              schema:
                type: integer
              description: Max allowed requests within time interval
            X-Rate-Limit-Remaining:
              schema:
                type: integer
              description: Remaining requests within time interval
            X-Rate-Limit-Interval:
              schema:
                type: integer
              description: Time interval in milliseconds. Allowed requests will be constantly replenished during the interval. At the end of the interval the max allowed requests will be available
            X-RateLimit-Reset:
              schema:
                type: integer
              description: Time at which the rate limit resets, specified in UTC epoch time
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/problem'
        '429':
          description: '429'
          headers:
            X-Rate-Limit-Limit:
              schema:
                type: integer
              description: Max allowed requests within time interval
            X-Rate-Limit-Remaining:
              schema:
                type: integer
              description: Remaining requests within time interval
            X-Rate-Limit-Interval:
              schema:
                type: integer
              description: Time interval in milliseconds. Allowed requests will be constantly replenished during the interval. At the end of the interval the max allowed requests will be available
            X-RateLimit-Reset:
              schema:
                type: integer
              description: Time at which the rate limit resets, specified in UTC epoch time
            Retry-After:
              schema:
                type: integer
              description: How long time to wait before making a new request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/problem'
        '500':
          description: '500'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/problem'
      tags:
      - Signals
    servers:
    - url: https://api.signalhub.interop.pagopa.it/1.0/pull
      description: Production environment
  /signals:
    post:
      description: Insert a signal
      summary: Push Signal
      operationId: pushSignal
      parameters:
      - schema:
          type: string
        required: true
        name: authorization
        in: header
      requestBody:
        description: ''
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignalPayload'
      responses:
        '200':
          description: '200'
          headers:
            X-Rate-Limit-Limit:
              schema:
                type: integer
              description: Max allowed requests within time interval
            X-Rate-Limit-Remaining:
              schema:
                type: integer
              description: Remaining requests within time interval
            X-Rate-Limit-Interval:
              schema:
                type: integer
              description: Time interval in milliseconds. Allowed requests will be constantly replenished during the interval. At the end of the interval the max allowed requests will be available
            X-RateLimit-Reset:
              schema:
                type: integer
              description: Time at which the rate limit resets, specified in UTC epoch time
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignalPushResponse'
        '400':
          description: '400'
          headers:
            X-Rate-Limit-Limit:
              schema:
                type: integer
              description: Max allowed requests within time interval
            X-Rate-Limit-Remaining:
              schema:
                type: integer
              description: Remaining requests within time interval
            X-Rate-Limit-Interval:
              schema:
                type: integer
              description: Time interval in milliseconds. Allowed requests will be constantly replenished during the interval. At the end of the interval the max allowed requests will be available
            X-RateLimit-Reset:
              schema:
                type: integer
              description: Time at which the rate limit resets, specified in UTC epoch time
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/problem'
        '401':
          description: '401'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/problem'
        '403':
          description: '403'
          headers:
            X-Rate-Limit-Limit:
              schema:
                type: integer
              description: Max allowed requests within time interval
            X-Rate-Limit-Remaining:
              schema:
                type: integer
              description: Remaining requests within time interval
            X-Rate-Limit-Interval:
              schema:
                type: integer
              description: Time interval in milliseconds. Allowed requests will be constantly replenished during the interval. At the end of the interval the max allowed requests will be available
            X-RateLimit-Reset:
              schema:
                type: integer
              description: Time at which the rate limit resets, specified in UTC epoch time
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/problem'
        '429':
          description: '429'
          headers:
            X-Rate-Limit-Limit:
              schema:
                type: integer
              description: Max allowed requests within time interval
            X-Rate-Limit-Remaining:
              schema:
                type: integer
              description: Remaining requests within time interval
            X-Rate-Limit-Interval:
              schema:
                type: integer
              description: Time interval in milliseconds. Allowed requests will be constantly replenished during the interval. At the end of the interval the max allowed requests will be available
            X-RateLimit-Reset:
              schema:
                type: integer
              description: Time at which the rate limit resets, specified in UTC epoch time
            Retry-After:
              schema:
                type: integer
              description: How long time to wait before making a new request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/problem'
        '500':
          description: '500'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/problem'
      tags:
      - Signals
    servers:
    - url: https://api.signalhub.interop.pagopa.it/1.0/push
      description: Production environment
components:
  schemas:
    problem:
      type: object
      properties:
        type:
          type: string
        status:
          type: number
        title:
          type: string
        correlationId:
          type:
          - string
          - 'null'
        detail:
          type: string
        errors:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
              detail:
                type: string
            required:
            - code
            - detail
      required:
      - type
      - status
      - title
      - detail
      - errors
    SignalPullResponse:
      type: object
      properties:
        signals:
          type: array
          items:
            type: object
            properties:
              signalType:
                $ref: '#/components/schemas/signalType'
              objectId:
                type: string
              eserviceId:
                type: string
              signalId:
                type: number
              objectType:
                type: string
            required:
            - signalType
            - objectId
            - eserviceId
            - signalId
            - objectType
        lastSignalId:
          type:
          - number
          - 'null'
      required:
      - signals
    signalType:
      type: string
      enum:
      - CREATE
      - UPDATE
      - DELETE
      - SEEDUPDATE
    SignalPushResponse:
      type: object
      properties:
        signalId:
          type: number
      required:
      - signalId
    SignalPayload:
      type: object
      properties:
        signalType:
          $ref: '#/components/schemas/signalType'
        objectId:
          type: string
        eserviceId:
          type: string
        signalId:
          type: number
        objectType:
          type: string
      required:
      - signalType
      - objectId
      - eserviceId
      - signalId
      - objectType
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: A bearer token in the format of a JWS and conformed to the specifications included in [RFC8725](https://tools.ietf.org/html/RFC8725).
x-refined-from:
- signalhub-pull.yaml
- signalhub-push.yaml
- pagopa-pdnd-signal-hub-pull-openapi.yml
- pagopa-pdnd-signal-hub-push-openapi.yml