openapi: 3.2.0 info: title: Pagopa Streams API version: 1.0.0 contact: name: 'SEND: supporto enti' url: https://pagopa.atlassian.net/servicedesk/customer/portal/5 termsOfService: https://selfcare.notifichedigitali.it/termini-di-servizio x-api-id: api-external-b2b-pa x-summary: 'Piattaforma Notifiche: API B2B per le Pubbliche Amministrazioni' description: 'Operations tagged Streams across 2 of this provider''s published API definitions: send-b2b-pa-bundle.yaml, pagopa-send-b2b-pa-openapi.yml. Each path carries the servers of the definition it was published in.' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo security: - ApiKeyAuth: [] tags: - name: Streams description: Gestione degli stream di eventi che PN mette a disposizione paths: /delivery-progresses/v2.9/streams: post: summary: Crea nuovo stream di eventi v2.9 description: 'Creazione di un flusso di eventi specificando se gli eventi saranno relativi ai cambi di stato o agli eventi di timeline. In risposta, Piattaforma Notifiche, comunicherà un identificativo dello stream e il timestamp di effettiva attivazione del flusso, tipicamente pochi secondi dopo che è stata invocata l''operazione.' tags: - Streams operationId: createEventStreamV29 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StreamCreationRequestV29' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StreamMetadataResponseV29' '400': description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: ReplacedId Stream not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' get: summary: Elenca stream di eventi v2.9 description: Elenca gli stream di eventi tags: - Streams operationId: listEventStreamsV29 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StreamListResponse' '400': description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo /delivery-progresses/v2.9/streams/{streamId}: parameters: - $ref: '#/components/parameters/pathStreamId' get: summary: Leggi metadata dello stream v2.9 description: Lettura delle configurazioni di uno stream di eventi. tags: - Streams operationId: retrieveEventStreamV29 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StreamMetadataResponseV29' '400': description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: Stream not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' put: summary: Update Stream metadata v2.9 description: Modifica delle configurazioni dei filtri associati a uno stream di eventi, non è possibile cambiare il valore del flag waitForAccepted. tags: - Streams operationId: updateEventStreamV29 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StreamRequestV29' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StreamMetadataResponseV29' '400': description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: Stream not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' delete: summary: Remove Event Stream v2.9 description: 'Cancellazione dello steam di eventi: elimina sia le configurazioni sia tutti gli eventi associati allo stream e non ancora consumati.' tags: - Streams operationId: removeEventStreamV29 responses: '204': description: OK '400': description: Bad request content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: Stream not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo /delivery-progresses/v2.9/streams/{streamId}/action/disable: post: summary: Disabilita uno stream v2.9 description: 'Disabilita uno stream. Da uno stream disabilitato è possibile leggere gli eventi presenti nello stream salvati prima della disabilitazione, ma non ne saranno aggiunti di nuovi. Non è possibile modificare o riabilitare uno stream disabilitato. Uno stream disabilitato non rientra nel conteggio degli stream massimi, non può essere riabilitato e verrà eliminato automaticamente dopo 14 giorni.' tags: - Streams operationId: disableEventStreamV29 parameters: - $ref: '#/components/parameters/pathStreamId' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StreamMetadataResponseV29' '400': description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: Stream not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo /delivery-progresses/streams: post: deprecated: true summary: Crea nuovo stream di eventi v1 description: 'Viene richiesta la creazione di un flusso di eventi specificando se gli eventi saranno relativi ai cambi di stato o agli eventi di timeline. In risposta, Piattaforma Notifiche, comunicherà un identificativo dello stream e il timestamp di effettiva attivazione del flusso, tipicamente pochi secondi dopo che è stata invocata l''operazione.' tags: - Streams operationId: createEventStream requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StreamCreationRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StreamMetadataResponse' '400': description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' get: deprecated: true summary: Elenca stream di eventi v1 description: Elenca gli stream di eventi tags: - Streams operationId: listEventStreams responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StreamListResponse' '400': description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo /delivery-progresses/streams/{streamId}: parameters: - $ref: '#/components/parameters/pathStreamId' get: deprecated: true summary: Leggi metadati dello stream v1 description: Permette di leggere le configurazioni di uno stream di eventi. tags: - Streams operationId: retrieveEventStream responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StreamMetadataResponse' '400': description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' put: deprecated: true summary: Update Stream metadata v1 description: Permette di cambiare le configurazioni dei filtri associati a uno stream di eventi tags: - Streams operationId: updateEventStream requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StreamCreationRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StreamMetadataResponse' '400': description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' delete: deprecated: true summary: Remove Event Stream v1 description: 'Elimina uno steam di eventi: elimina sia le configurazioni sia tutti gli eventi associati allo stream e non ancora consumati.' tags: - Streams operationId: removeEventStream responses: '204': description: OK '400': description: Bad request content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo /delivery-progresses/v2.3/streams: post: deprecated: true summary: Crea nuovo stream di eventi v2.3 description: 'Creazione di un flusso di eventi specificando se gli eventi saranno relativi ai cambi di stato o agli eventi di timeline. In risposta, Piattaforma Notifiche, comunicherà un identificativo dello stream e il timestamp di effettiva attivazione del flusso, tipicamente pochi secondi dopo che è stata invocata l''operazione.' tags: - Streams operationId: createEventStreamV23 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StreamCreationRequestV23' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StreamMetadataResponseV23' '400': description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: ReplacedId Stream not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' get: deprecated: true summary: Elenca stream di eventi v2.3 description: Elenca gli stream di eventi tags: - Streams operationId: listEventStreamsV23 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StreamListResponse' '400': description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo /delivery-progresses/v2.3/streams/{streamId}: parameters: - $ref: '#/components/parameters/pathStreamId' get: deprecated: true summary: Leggi metadata dello stream v2.3 description: Lettura delle configurazioni di uno stream di eventi. tags: - Streams operationId: retrieveEventStreamV23 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StreamMetadataResponseV23' '400': description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: Stream not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' put: deprecated: true summary: Update Stream metadata v2.3 description: Modifica delle configurazioni dei filtri associati a uno stream di eventi tags: - Streams operationId: updateEventStreamV23 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StreamRequestV23' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StreamMetadataResponseV23' '400': description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: Stream not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' delete: deprecated: true summary: Remove Event Stream v2.3 description: 'Cancellazione dello steam di eventi: elimina sia le configurazioni sia tutti gli eventi associati allo stream e non ancora consumati.' tags: - Streams operationId: removeEventStreamV23 responses: '204': description: OK '400': description: Bad request content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: Stream not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo /delivery-progresses/v2.3/streams/{streamId}/action/disable: post: deprecated: true summary: Disabilita uno stream v2.3 description: 'Disabilita uno stream. Da uno stream disabilitato è possibile leggere gli eventi presenti nello stream salvati prima della disabilitazione, ma non ne saranno aggiunti di nuovi. Non è possibile modificare o riabilitare uno stream disabilitato. Uno stream disabilitato non rientra nel conteggio degli stream massimi, non può essere riabilitato e verrà eliminato automaticamente dopo 14 giorni.' tags: - Streams operationId: disableEventStreamV23 parameters: - $ref: '#/components/parameters/pathStreamId' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StreamMetadataResponseV23' '400': description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: Stream not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo /delivery-progresses/v2.4/streams: post: deprecated: true summary: Crea nuovo stream di eventi v2.4 description: 'Creazione di un flusso di eventi specificando se gli eventi saranno relativi ai cambi di stato o agli eventi di timeline. In risposta, Piattaforma Notifiche, comunicherà un identificativo dello stream e il timestamp di effettiva attivazione del flusso, tipicamente pochi secondi dopo che è stata invocata l''operazione.' tags: - Streams operationId: createEventStreamV24 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StreamCreationRequestV24' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StreamMetadataResponseV24' '400': description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: ReplacedId Stream not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' get: deprecated: true summary: Elenca stream di eventi v2.4 description: Elenca gli stream di eventi tags: - Streams operationId: listEventStreamsV24 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StreamListResponse' '400': description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo /delivery-progresses/v2.4/streams/{streamId}: parameters: - $ref: '#/components/parameters/pathStreamId' get: deprecated: true summary: Leggi metadata dello stream v2.4 description: Lettura delle configurazioni di uno stream di eventi. tags: - Streams operationId: retrieveEventStreamV24 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StreamMetadataResponseV24' '400': description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: Stream not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' put: deprecated: true summary: Update Stream metadata v2.4 description: Modifica delle configurazioni dei filtri associati a uno stream di eventi tags: - Streams operationId: updateEventStreamV24 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StreamRequestV24' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StreamMetadataResponseV24' '400': description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: Stream not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' delete: deprecated: true summary: Remove Event Stream v2.4 description: 'Cancellazione dello steam di eventi: elimina sia le configurazioni sia tutti gli eventi associati allo stream e non ancora consumati.' tags: - Streams operationId: removeEventStreamV24 responses: '204': description: OK '400': description: Bad request content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: Stream not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo /delivery-progresses/v2.4/streams/{streamId}/action/disable: post: deprecated: true summary: Disabilita uno stream v2.4 description: 'Disabilita uno stream. Da uno stream disabilitato è possibile leggere gli eventi presenti nello stream salvati prima della disabilitazione, ma non ne saranno aggiunti di nuovi. Non è possibile modificare o riabilitare uno stream disabilitato. Uno stream disabilitato non rientra nel conteggio degli stream massimi, non può essere riabilitato e verrà eliminato automaticamente dopo 14 giorni.' tags: - Streams operationId: disableEventStreamV24 parameters: - $ref: '#/components/parameters/pathStreamId' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StreamMetadataResponseV24' '400': description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: Stream not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo /delivery-progresses/v2.5/streams: post: deprecated: true summary: Crea nuovo stream di eventi v2.5 description: 'Creazione di un flusso di eventi specificando se gli eventi saranno relativi ai cambi di stato o agli eventi di timeline. In risposta, Piattaforma Notifiche, comunicherà un identificativo dello stream e il timestamp di effettiva attivazione del flusso, tipicamente pochi secondi dopo che è stata invocata l''operazione.' tags: - Streams operationId: createEventStreamV25 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StreamCreationRequestV25' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StreamMetadataResponseV25' '400': description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: ReplacedId Stream not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' get: deprecated: true summary: Elenca stream di eventi v2.5 description: Elenca gli stream di eventi tags: - Streams operationId: listEventStreamsV25 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StreamListResponse' '400': description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo /delivery-progresses/v2.5/streams/{streamId}: parameters: - $ref: '#/components/parameters/pathStreamId' get: deprecated: true summary: Leggi metadata dello stream v2.5 description: Lettura delle configurazioni di uno stream di eventi. tags: - Streams operationId: retrieveEventStreamV25 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StreamMetadataResponseV25' '400': description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: Stream not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' put: deprecated: true summary: Update Stream metadata v2.5 description: Modifica delle configurazioni dei filtri associati a uno stream di eventi tags: - Streams operationId: updateEventStreamV25 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StreamRequestV25' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StreamMetadataResponseV25' '400': description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: Stream not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' delete: deprecated: true summary: Remove Event Stream v2.5 description: 'Cancellazione dello steam di eventi: elimina sia le configurazioni sia tutti gli eventi associati allo stream e non ancora consumati.' tags: - Streams operationId: removeEventStreamV25 responses: '204': description: OK '400': description: Bad request content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: Stream not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo /delivery-progresses/v2.5/streams/{streamId}/action/disable: post: deprecated: true summary: Disabilita uno stream v2.5 description: 'Disabilita uno stream. Da uno stream disabilitato è possibile leggere gli eventi presenti nello stream salvati prima della disabilitazione, ma non ne saranno aggiunti di nuovi. Non è possibile modificare o riabilitare uno stream disabilitato. Uno stream disabilitato non rientra nel conteggio degli stream massimi, non può essere riabilitato e verrà eliminato automaticamente dopo 14 giorni.' tags: - Streams operationId: disableEventStreamV25 parameters: - $ref: '#/components/parameters/pathStreamId' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StreamMetadataResponseV25' '400': description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: Stream not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo /delivery-progresses/v2.6/streams: post: deprecated: true summary: Crea nuovo stream di eventi v2.6 description: 'Creazione di un flusso di eventi specificando se gli eventi saranno relativi ai cambi di stato o agli eventi di timeline. In risposta, Piattaforma Notifiche, comunicherà un identificativo dello stream e il timestamp di effettiva attivazione del flusso, tipicamente pochi secondi dopo che è stata invocata l''operazione.' tags: - Streams operationId: createEventStreamV26 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StreamCreationRequestV26' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StreamMetadataResponseV26' '400': description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: ReplacedId Stream not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' get: deprecated: true summary: Elenca stream di eventi v2.6 description: Elenca gli stream di eventi tags: - Streams operationId: listEventStreamsV26 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StreamListResponse' '400': description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo /delivery-progresses/v2.6/streams/{streamId}: parameters: - $ref: '#/components/parameters/pathStreamId' get: deprecated: true summary: Leggi metadata dello stream v2.6 description: Lettura delle configurazioni di uno stream di eventi. tags: - Streams operationId: retrieveEventStreamV26 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StreamMetadataResponseV26' '400': description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: Stream not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' put: deprecated: true summary: Update Stream metadata v2.6 description: Modifica delle configurazioni dei filtri associati a uno stream di eventi tags: - Streams operationId: updateEventStreamV26 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StreamRequestV26' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StreamMetadataResponseV26' '400': description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: Stream not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' delete: deprecated: true summary: Remove Event Stream v2.6 description: 'Cancellazione dello steam di eventi: elimina sia le configurazioni sia tutti gli eventi associati allo stream e non ancora consumati.' tags: - Streams operationId: removeEventStreamV26 responses: '204': description: OK '400': description: Bad request content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: Stream not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo /delivery-progresses/v2.6/streams/{streamId}/action/disable: post: deprecated: true summary: Disabilita uno stream v2.6 description: 'Disabilita uno stream. Da uno stream disabilitato è possibile leggere gli eventi presenti nello stream salvati prima della disabilitazione, ma non ne saranno aggiunti di nuovi. Non è possibile modificare o riabilitare uno stream disabilitato. Uno stream disabilitato non rientra nel conteggio degli stream massimi, non può essere riabilitato e verrà eliminato automaticamente dopo 14 giorni.' tags: - Streams operationId: disableEventStreamV26 parameters: - $ref: '#/components/parameters/pathStreamId' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StreamMetadataResponseV26' '400': description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: Stream not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo /delivery-progresses/v2.7/streams: post: deprecated: true summary: Crea nuovo stream di eventi v2.7 description: 'Creazione di un flusso di eventi specificando se gli eventi saranno relativi ai cambi di stato o agli eventi di timeline. In risposta, Piattaforma Notifiche, comunicherà un identificativo dello stream e il timestamp di effettiva attivazione del flusso, tipicamente pochi secondi dopo che è stata invocata l''operazione.' tags: - Streams operationId: createEventStreamV27 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StreamCreationRequestV27' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StreamMetadataResponseV27' '400': description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: ReplacedId Stream not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' get: deprecated: true summary: Elenca stream di eventi v2.7 description: Elenca gli stream di eventi tags: - Streams operationId: listEventStreamsV27 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StreamListResponse' '400': description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo /delivery-progresses/v2.7/streams/{streamId}: parameters: - $ref: '#/components/parameters/pathStreamId' get: deprecated: true summary: Leggi metadata dello stream v2.7 description: Lettura delle configurazioni di uno stream di eventi. tags: - Streams operationId: retrieveEventStreamV27 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StreamMetadataResponseV27' '400': description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: Stream not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' put: deprecated: true summary: Update Stream metadata v2.7 description: Modifica delle configurazioni dei filtri associati a uno stream di eventi, non è possibile cambiare il valore del flag waitForAccepted. tags: - Streams operationId: updateEventStreamV27 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StreamRequestV27' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StreamMetadataResponseV27' '400': description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: Stream not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' delete: deprecated: true summary: Remove Event Stream v2.7 description: 'Cancellazione dello steam di eventi: elimina sia le configurazioni sia tutti gli eventi associati allo stream e non ancora consumati.' tags: - Streams operationId: removeEventStreamV27 responses: '204': description: OK '400': description: Bad request content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: Stream not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo /delivery-progresses/v2.7/streams/{streamId}/action/disable: post: deprecated: true summary: Disabilita uno stream v2.7 description: 'Disabilita uno stream. Da uno stream disabilitato è possibile leggere gli eventi presenti nello stream salvati prima della disabilitazione, ma non ne saranno aggiunti di nuovi. Non è possibile modificare o riabilitare uno stream disabilitato. Uno stream disabilitato non rientra nel conteggio degli stream massimi, non può essere riabilitato e verrà eliminato automaticamente dopo 14 giorni.' tags: - Streams operationId: disableEventStreamV27 parameters: - $ref: '#/components/parameters/pathStreamId' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StreamMetadataResponseV27' '400': description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: Stream not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo /delivery-progresses/v2.8/streams: post: deprecated: true summary: EXPERIMENTAL - Crea nuovo stream di eventi v2.8 description: '(EXPERIMENTAL) Creazione di un flusso di eventi specificando se gli eventi saranno relativi ai cambi di stato o agli eventi di timeline. In risposta, Piattaforma Notifiche, comunicherà un identificativo dello stream e il timestamp di effettiva attivazione del flusso, tipicamente pochi secondi dopo che è stata invocata l''operazione.' tags: - Streams operationId: createEventStreamV28 x-pagopa-lambda-name: pn-versioningV1V2StreamLambda:live x-pagopa-lambda-account: core requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StreamCreationRequestV28' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StreamMetadataResponseV28' '400': description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: ReplacedId Stream not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' get: deprecated: true summary: EXPERIMENTAL - Elenca stream di eventi v2.8 description: (EXPERIMENTAL) Elenca gli stream di eventi tags: - Streams operationId: listEventStreamsV28 x-pagopa-lambda-name: pn-versioningV1V2StreamLambda:live x-pagopa-lambda-account: core responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StreamListResponse' '400': description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo /delivery-progresses/v2.8/streams/{streamId}: parameters: - $ref: '#/components/parameters/pathStreamId' get: deprecated: true summary: EXPERIMENTAL - Leggi metadata dello stream v2.8 description: (EXPERIMENTAL) Lettura delle configurazioni di uno stream di eventi. tags: - Streams operationId: retrieveEventStreamV28 x-pagopa-lambda-name: pn-versioningV1V2StreamLambda:live x-pagopa-lambda-account: core responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StreamMetadataResponseV28' '400': description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: Stream not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' put: deprecated: true summary: EXPERIMENTAL - Update Stream metadata v2.8 description: (EXPERIMENTAL) Modifica delle configurazioni dei filtri associati a uno stream di eventi, non è possibile cambiare il valore del flag waitForAccepted. tags: - Streams operationId: updateEventStreamV28 x-pagopa-lambda-name: pn-versioningV1V2StreamLambda:live x-pagopa-lambda-account: core requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StreamRequestV28' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StreamMetadataResponseV28' '400': description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: Stream not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' delete: deprecated: true summary: EXPERIMENTAL - Remove Event Stream v2.8 description: '(EXPERIMENTAL) Cancellazione dello steam di eventi: elimina sia le configurazioni sia tutti gli eventi associati allo stream e non ancora consumati.' tags: - Streams operationId: removeEventStreamV28 x-pagopa-lambda-name: pn-versioningV1V2StreamLambda:live x-pagopa-lambda-account: core responses: '204': description: OK '400': description: Bad request content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: Stream not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo /delivery-progresses/v2.8/streams/{streamId}/action/disable: post: deprecated: true summary: EXPERIMENTAL - Disabilita uno stream v2.8 description: '(EXPERIMENTAL) Disabilita uno stream. Da uno stream disabilitato è possibile leggere gli eventi presenti nello stream salvati prima della disabilitazione, ma non ne saranno aggiunti di nuovi. Non è possibile modificare o riabilitare uno stream disabilitato. Uno stream disabilitato non rientra nel conteggio degli stream massimi, non può essere riabilitato e verrà eliminato automaticamente dopo 14 giorni.' tags: - Streams operationId: disableEventStreamV28 x-pagopa-lambda-name: pn-versioningV1V2StreamLambda:live x-pagopa-lambda-account: core parameters: - $ref: '#/components/parameters/pathStreamId' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StreamMetadataResponseV28' '400': description: Invalid input content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: Stream not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo components: schemas: StreamRequestV24: description: Struttura comune per eventi di creazione/aggiornamento di uno stream di eventi di avanzamento delle notifiche. L'aggiornamento delle proprietà dello stream è soggetta al controllo di autorizzazione dell'apiKey sui gruppi. type: object required: - title - eventType - groups properties: title: description: Nome sintetico dello stream type: string maxLength: 256 pattern: ^.*$ eventType: description: "Tipo di eventi presenti nel flusso:\n - _STATUS_: cambiamenti di stato delle notifiche\n - _TIMELINE_: eventi a granularità fine" type: string enum: - STATUS - TIMELINE groups: description: rappresenta l'elenco degli id gruppi abilitati a richiedere i dettagli. Una apiKey può consumare o modificare uno stream solo se non ha gruppi o se tutti i gruppi dello stream sono presenti nella apiKey. Se viene specificato array vuoto, si noti che solo apiKey senza gruppi potranno consumare o modificare lo stream. Inoltre, nel caso di updateEventStream, la lista dei gruppi presente nello stream deve essere un sottoinsieme dei gruppi passati nella richiesta (in pratica si possono solo aggiungere gruppi a quelli esistenti) oppure entrambi array vuoti. type: array items: allOf: - $ref: '#/components/schemas/StreamGroup' minLength: 0 filterValues: description: rappresenta l'elenco degli stati o elementi di timeline che si vogliono filtrare; inserendo un array vuoto [] si riceveranno solo gli elementi relativi alla versione con cui è stato creato lo stream. Se specificati invece, avranno priorità rispetto agli eventi della versione (quindi se sono un sottoinsieme, si riceveranno solo quelli. Se si specificano eventi introdotti in versioni più recenti, questi saranno inviati) Infine, è possibile utilizzare il placeholder "DEFAULT" per specificare l'insieme di eventi più rilevanti di una notifica. type: array items: type: string minLength: 4 maxLength: 256 pattern: ^[A-Z_]+$ StreamCreationRequestV26: description: Richiesta di creazione di uno stream di eventi di avanzamento delle notifiche. Lo stream verrà creato nello stato abilitato type: object allOf: - $ref: '#/components/schemas/StreamRequestV26' - type: object properties: replacedStreamId: description: opzionale, eventuale streamId che viene sostituito da questo. Se specificato, lo stream indicato sarà disabilitato contestualmente alla creazione del nuovo stream, permettendo di consumare tutti gli eventi del vecchio stream senza che ne vengano aggiunti di nuovi. Inoltre, il nuovo stream partirà da un eventId successivo rispetto al vecchio stream (anche se non "esattamente" successivo per evitare sovrapposizioni con eventuali eventi salvati durante il cambio di configurazione). La creazione del nuovo stream è soggetta al controllo di autorizzazione dell'apiKey sui gruppi del precedente stream. type: string format: uuid StreamMetadataResponseV23: description: Configurazioni di un flusso di eventi allOf: - $ref: '#/components/schemas/StreamRequestV23' - type: object required: - streamId - activationDate properties: streamId: description: Identificativo del flusso di eventi type: string format: uuid activationDate: description: Timestamp in cui il flusso di eventi è stato attivato type: string format: date-time disabledDate: description: Timestamp in cui il flusso di eventi è stato disabilitato type: string format: date-time version: description: versione di base dello stream. type: string pattern: ^v\d\d\d?$ StreamMetadataResponseV26: description: Configurazioni di un flusso di eventi allOf: - $ref: '#/components/schemas/StreamRequestV26' - type: object required: - streamId - activationDate properties: streamId: description: Identificativo del flusso di eventi type: string format: uuid activationDate: description: Timestamp in cui il flusso di eventi è stato attivato type: string format: date-time disabledDate: description: Timestamp in cui il flusso di eventi è stato disabilitato type: string format: date-time version: description: versione di base dello stream. type: string pattern: ^v\d\d\d?$ Problem: 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 StreamMetadataResponseV29: description: Configurazioni di un flusso di eventi allOf: - $ref: '#/components/schemas/StreamRequestV29' - type: object required: - streamId - activationDate properties: streamId: description: Identificativo del flusso di eventi type: string format: uuid activationDate: description: Timestamp in cui il flusso di eventi è stato attivato type: string format: date-time disabledDate: description: Timestamp in cui il flusso di eventi è stato disabilitato type: string format: date-time version: description: versione di base dello stream. type: string pattern: ^v\d\d\d?$ StreamCreationRequestV29: description: Richiesta di creazione di uno stream di eventi di avanzamento delle notifiche. Lo stream verrà creato nello stato abilitato type: object allOf: - $ref: '#/components/schemas/StreamRequestV29' - type: object properties: replacedStreamId: description: opzionale, eventuale streamId che viene sostituito da questo. Se specificato, lo stream indicato sarà disabilitato contestualmente alla creazione del nuovo stream, permettendo di consumare tutti gli eventi del vecchio stream senza che ne vengano aggiunti di nuovi. Inoltre, il nuovo stream partirà da un eventId successivo rispetto al vecchio stream (anche se non "esattamente" successivo per evitare sovrapposizioni con eventuali eventi salvati durante il cambio di configurazione). La creazione del nuovo stream è soggetta al controllo di autorizzazione dell'apiKey sui gruppi del precedente stream. type: string format: uuid StreamCreationRequestV23: description: Richiesta di creazione di uno stream di eventi di avanzamento delle notifiche. Lo stream verrà creato nello stato abilitato type: object allOf: - $ref: '#/components/schemas/StreamRequestV23' - type: object properties: replacedStreamId: description: opzionale, eventuale streamId che viene sostituito da questo. Se specificato, lo stream indicato sarà disabilitato contestualmente alla creazione del nuovo stream, permettendo di consumare tutti gli eventi del vecchio stream senza che ne vengano aggiunti di nuovi. Inoltre, il nuovo stream partirà da un eventId successivo rispetto al vecchio stream (anche se non "esattamente" successivo per evitare sovrapposizioni con eventuali eventi salvati durante il cambio di configurazione). La creazione del nuovo stream è soggetta al controllo di autorizzazione dell'apiKey sui gruppi del precedente stream. type: string format: uuid StreamMetadataResponseV28: description: Configurazioni di un flusso di eventi allOf: - $ref: '#/components/schemas/StreamRequestV28' - type: object required: - streamId - activationDate properties: streamId: description: Identificativo del flusso di eventi type: string format: uuid activationDate: description: Timestamp in cui il flusso di eventi è stato attivato type: string format: date-time disabledDate: description: Timestamp in cui il flusso di eventi è stato disabilitato type: string format: date-time version: description: versione di base dello stream. type: string pattern: ^v\d\d\d?$ StreamListElement: type: object required: - title - streamId properties: streamId: type: string format: uuid title: type: string maxLength: 256 pattern: ^.*$ StreamRequestV25: description: Struttura comune per eventi di creazione/aggiornamento di uno stream di eventi di avanzamento delle notifiche. L'aggiornamento delle proprietà dello stream è soggetta al controllo di autorizzazione dell'apiKey sui gruppi. type: object required: - title - eventType - groups properties: title: description: Nome sintetico dello stream type: string maxLength: 256 pattern: ^.*$ eventType: description: "Tipo di eventi presenti nel flusso:\n - _STATUS_: cambiamenti di stato delle notifiche\n - _TIMELINE_: eventi a granularità fine" type: string enum: - STATUS - TIMELINE groups: description: rappresenta l'elenco degli id gruppi abilitati a richiedere i dettagli. Una apiKey può consumare o modificare uno stream solo se non ha gruppi o se tutti i gruppi dello stream sono presenti nella apiKey. Se viene specificato array vuoto, si noti che solo apiKey senza gruppi potranno consumare o modificare lo stream. Inoltre, nel caso di updateEventStream, la lista dei gruppi presente nello stream deve essere un sottoinsieme dei gruppi passati nella richiesta (in pratica si possono solo aggiungere gruppi a quelli esistenti) oppure entrambi array vuoti. type: array items: allOf: - $ref: '#/components/schemas/StreamGroup' minLength: 0 filterValues: description: rappresenta l'elenco degli stati o elementi di timeline che si vogliono filtrare; inserendo un array vuoto [] si riceveranno solo gli elementi relativi alla versione con cui è stato creato lo stream. Se specificati invece, avranno priorità rispetto agli eventi della versione (quindi se sono un sottoinsieme, si riceveranno solo quelli. Se si specificano eventi introdotti in versioni più recenti, questi saranno inviati) Infine, è possibile utilizzare il placeholder "DEFAULT" per specificare l'insieme di eventi più rilevanti di una notifica. type: array items: type: string minLength: 4 maxLength: 256 pattern: ^[A-Z_]+$ StreamCreationRequestV24: description: Richiesta di creazione di uno stream di eventi di avanzamento delle notifiche. Lo stream verrà creato nello stato abilitato type: object allOf: - $ref: '#/components/schemas/StreamRequestV24' - type: object properties: replacedStreamId: description: opzionale, eventuale streamId che viene sostituito da questo. Se specificato, lo stream indicato sarà disabilitato contestualmente alla creazione del nuovo stream, permettendo di consumare tutti gli eventi del vecchio stream senza che ne vengano aggiunti di nuovi. Inoltre, il nuovo stream partirà da un eventId successivo rispetto al vecchio stream (anche se non "esattamente" successivo per evitare sovrapposizioni con eventuali eventi salvati durante il cambio di configurazione). La creazione del nuovo stream è soggetta al controllo di autorizzazione dell'apiKey sui gruppi del precedente stream. type: string format: uuid StreamRequestV27: description: Struttura comune per eventi di creazione/aggiornamento di uno stream di eventi di avanzamento delle notifiche. L'aggiornamento delle proprietà dello stream è soggetta al controllo di autorizzazione dell'apiKey sui gruppi. type: object required: - title - eventType - groups properties: title: description: Nome sintetico dello stream type: string maxLength: 256 pattern: ^.*$ eventType: description: "Tipo di eventi presenti nel flusso:\n - _STATUS_: cambiamenti di stato delle notifiche\n - _TIMELINE_: eventi a granularità fine" type: string enum: - STATUS - TIMELINE groups: description: rappresenta l'elenco degli id gruppi abilitati a richiedere i dettagli. Una apiKey può consumare o modificare uno stream solo se non ha gruppi o se tutti i gruppi dello stream sono presenti nella apiKey. Se viene specificato array vuoto, si noti che solo apiKey senza gruppi potranno consumare o modificare lo stream. Inoltre, nel caso di updateEventStream, la lista dei gruppi presente nello stream deve essere un sottoinsieme dei gruppi passati nella richiesta (in pratica si possono solo aggiungere gruppi a quelli esistenti) oppure entrambi array vuoti. type: array items: allOf: - $ref: '#/components/schemas/StreamGroup' minLength: 0 filterValues: description: rappresenta l'elenco degli stati o elementi di timeline che si vogliono filtrare; inserendo un array vuoto [] si riceveranno solo gli elementi relativi alla versione con cui è stato creato lo stream. Se specificati invece, avranno priorità rispetto agli eventi della versione (quindi se sono un sottoinsieme, si riceveranno solo quelli. Se si specificano eventi introdotti in versioni più recenti, questi saranno inviati) Infine, è possibile utilizzare il placeholder "DEFAULT" per specificare l'insieme di eventi più rilevanti di una notifica. type: array items: type: string minLength: 4 maxLength: 256 pattern: ^[A-Z_]+$ waitForAccepted: description: 'Stream di tipo TIMELINE: se true pubblica gli eventi sullo stream solo dopo la pubblicazione dell''evento di accettazione/rifiuto della notifica. Tutti gli eventi dello stato IN_VALIDATION vengono pubblicati senza ritardo. Stream di tipo STATUS: se true pubblica gli stati garantendo che il primo stato sia l''ACCEPTED o il REFUSED' type: boolean StreamGroup: type: string description: Identificativo del gruppo. StreamMetadataResponseV27: description: Configurazioni di un flusso di eventi allOf: - $ref: '#/components/schemas/StreamRequestV27' - type: object required: - streamId - activationDate properties: streamId: description: Identificativo del flusso di eventi type: string format: uuid activationDate: description: Timestamp in cui il flusso di eventi è stato attivato type: string format: date-time disabledDate: description: Timestamp in cui il flusso di eventi è stato disabilitato type: string format: date-time version: description: versione di base dello stream. type: string pattern: ^v\d\d\d?$ StreamCreationRequestV25: description: Richiesta di creazione di uno stream di eventi di avanzamento delle notifiche. Lo stream verrà creato nello stato abilitato type: object allOf: - $ref: '#/components/schemas/StreamRequestV25' - type: object properties: replacedStreamId: description: opzionale, eventuale streamId che viene sostituito da questo. Se specificato, lo stream indicato sarà disabilitato contestualmente alla creazione del nuovo stream, permettendo di consumare tutti gli eventi del vecchio stream senza che ne vengano aggiunti di nuovi. Inoltre, il nuovo stream partirà da un eventId successivo rispetto al vecchio stream (anche se non "esattamente" successivo per evitare sovrapposizioni con eventuali eventi salvati durante il cambio di configurazione). La creazione del nuovo stream è soggetta al controllo di autorizzazione dell'apiKey sui gruppi del precedente stream. type: string format: uuid StreamRequestV26: description: Struttura comune per eventi di creazione/aggiornamento di uno stream di eventi di avanzamento delle notifiche. L'aggiornamento delle proprietà dello stream è soggetta al controllo di autorizzazione dell'apiKey sui gruppi. type: object required: - title - eventType - groups properties: title: description: Nome sintetico dello stream type: string maxLength: 256 pattern: ^.*$ eventType: description: "Tipo di eventi presenti nel flusso:\n - _STATUS_: cambiamenti di stato delle notifiche\n - _TIMELINE_: eventi a granularità fine" type: string enum: - STATUS - TIMELINE groups: description: rappresenta l'elenco degli id gruppi abilitati a richiedere i dettagli. Una apiKey può consumare o modificare uno stream solo se non ha gruppi o se tutti i gruppi dello stream sono presenti nella apiKey. Se viene specificato array vuoto, si noti che solo apiKey senza gruppi potranno consumare o modificare lo stream. Inoltre, nel caso di updateEventStream, la lista dei gruppi presente nello stream deve essere un sottoinsieme dei gruppi passati nella richiesta (in pratica si possono solo aggiungere gruppi a quelli esistenti) oppure entrambi array vuoti. type: array items: allOf: - $ref: '#/components/schemas/StreamGroup' minLength: 0 filterValues: description: rappresenta l'elenco degli stati o elementi di timeline che si vogliono filtrare; inserendo un array vuoto [] si riceveranno solo gli elementi relativi alla versione con cui è stato creato lo stream. Se specificati invece, avranno priorità rispetto agli eventi della versione (quindi se sono un sottoinsieme, si riceveranno solo quelli. Se si specificano eventi introdotti in versioni più recenti, questi saranno inviati) Infine, è possibile utilizzare il placeholder "DEFAULT" per specificare l'insieme di eventi più rilevanti di una notifica. type: array items: type: string minLength: 4 maxLength: 256 pattern: ^[A-Z_]+$ StreamRequestV23: description: Struttura comune per eventi di creazione/aggiornamento di uno stream di eventi di avanzamento delle notifiche. L'aggiornamento delle proprietà dello stream è soggetta al controllo di autorizzazione dell'apiKey sui gruppi. type: object required: - title - eventType - groups properties: title: description: Nome sintetico dello stream type: string maxLength: 256 pattern: ^.*$ eventType: description: "Tipo di eventi presenti nel flusso:\n - _STATUS_: cambiamenti di stato delle notifiche\n - _TIMELINE_: eventi a granularità fine" type: string enum: - STATUS - TIMELINE groups: description: rappresenta l'elenco degli id gruppi abilitati a richiedere i dettagli. Una apiKey può consumare o modificare uno stream solo se non ha gruppi o se tutti i gruppi dello stream sono presenti nella apiKey. Se viene specificato array vuoto, si noti che solo apiKey senza gruppi potranno consumare o modificare lo stream. Inoltre, nel caso di updateEventStream, la lista dei gruppi presente nello stream deve essere un sottoinsieme dei gruppi passati nella richiesta (in pratica si possono solo aggiungere gruppi a quelli esistenti) oppure entrambi array vuoti. type: array items: allOf: - $ref: '#/components/schemas/StreamGroup' minLength: 0 filterValues: description: rappresenta l'elenco degli stati o elementi di timeline che si vogliono filtrare; inserendo un array vuoto [] si riceveranno solo gli elementi relativi alla versione con cui è stato creato lo stream. Se specificati invece, avranno priorità rispetto agli eventi della versione (quindi se sono un sottoinsieme, si riceveranno solo quelli. Se si specificano eventi introdotti in versioni più recenti, questi saranno inviati) Infine, è possibile utilizzare il placeholder "DEFAULT" per specificare l'insieme di eventi più rilevanti di una notifica. type: array items: type: string minLength: 4 maxLength: 256 pattern: ^[A-Z_]+$ StreamMetadataResponse: description: Configurazioni di un flusso di eventi allOf: - $ref: '#/components/schemas/StreamCreationRequest' - type: object required: - streamId - activationDate properties: streamId: description: Identificativo del flusso di eventi type: string format: uuid activationDate: description: Timestamp in cui il flusso di eventi è stato attivato type: string format: date-time StreamCreationRequestV28: description: Richiesta di creazione di uno stream di eventi di avanzamento delle notifiche. Lo stream verrà creato nello stato abilitato type: object allOf: - $ref: '#/components/schemas/StreamRequestV28' - type: object properties: replacedStreamId: description: opzionale, eventuale streamId che viene sostituito da questo. Se specificato, lo stream indicato sarà disabilitato contestualmente alla creazione del nuovo stream, permettendo di consumare tutti gli eventi del vecchio stream senza che ne vengano aggiunti di nuovi. Inoltre, il nuovo stream partirà da un eventId successivo rispetto al vecchio stream (anche se non "esattamente" successivo per evitare sovrapposizioni con eventuali eventi salvati durante il cambio di configurazione). La creazione del nuovo stream è soggetta al controllo di autorizzazione dell'apiKey sui gruppi del precedente stream. type: string format: uuid StreamCreationRequestV27: description: Richiesta di creazione di uno stream di eventi di avanzamento delle notifiche. Lo stream verrà creato nello stato abilitato type: object allOf: - $ref: '#/components/schemas/StreamRequestV27' - type: object properties: replacedStreamId: description: opzionale, eventuale streamId che viene sostituito da questo. Se specificato, lo stream indicato sarà disabilitato contestualmente alla creazione del nuovo stream, permettendo di consumare tutti gli eventi del vecchio stream senza che ne vengano aggiunti di nuovi. Inoltre, il nuovo stream partirà da un eventId successivo rispetto al vecchio stream (anche se non "esattamente" successivo per evitare sovrapposizioni con eventuali eventi salvati durante il cambio di configurazione). La creazione del nuovo stream è soggetta al controllo di autorizzazione dell'apiKey sui gruppi del precedente stream. type: string format: uuid StreamMetadataResponseV24: description: Configurazioni di un flusso di eventi allOf: - $ref: '#/components/schemas/StreamRequestV24' - type: object required: - streamId - activationDate properties: streamId: description: Identificativo del flusso di eventi type: string format: uuid activationDate: description: Timestamp in cui il flusso di eventi è stato attivato type: string format: date-time disabledDate: description: Timestamp in cui il flusso di eventi è stato disabilitato type: string format: date-time version: description: versione di base dello stream. type: string pattern: ^v\d\d\d?$ StreamMetadataResponseV25: description: Configurazioni di un flusso di eventi allOf: - $ref: '#/components/schemas/StreamRequestV25' - type: object required: - streamId - activationDate properties: streamId: description: Identificativo del flusso di eventi type: string format: uuid activationDate: description: Timestamp in cui il flusso di eventi è stato attivato type: string format: date-time disabledDate: description: Timestamp in cui il flusso di eventi è stato disabilitato type: string format: date-time version: description: versione di base dello stream. type: string pattern: ^v\d\d\d?$ StreamRequestV29: description: Struttura comune per eventi di creazione/aggiornamento di uno stream di eventi di avanzamento delle notifiche. L'aggiornamento delle proprietà dello stream è soggetta al controllo di autorizzazione dell'apiKey sui gruppi. type: object required: - title - eventType - groups properties: title: description: Nome sintetico dello stream type: string maxLength: 256 pattern: ^.*$ eventType: description: "Tipo di eventi presenti nel flusso:\n - _STATUS_: cambiamenti di stato delle notifiche\n - _TIMELINE_: eventi a granularità fine" type: string enum: - STATUS - TIMELINE groups: description: rappresenta l'elenco degli id gruppi abilitati a richiedere i dettagli. Una apiKey può consumare o modificare uno stream solo se non ha gruppi o se tutti i gruppi dello stream sono presenti nella apiKey. Se viene specificato array vuoto, si noti che solo apiKey senza gruppi potranno consumare o modificare lo stream. Inoltre, nel caso di updateEventStream, la lista dei gruppi presente nello stream deve essere un sottoinsieme dei gruppi passati nella richiesta (in pratica si possono solo aggiungere gruppi a quelli esistenti) oppure entrambi array vuoti. type: array items: allOf: - $ref: '#/components/schemas/StreamGroup' minLength: 0 filterValues: description: rappresenta l'elenco degli stati o elementi di timeline che si vogliono filtrare; inserendo un array vuoto [] si riceveranno solo gli elementi relativi alla versione con cui è stato creato lo stream. Se specificati invece, avranno priorità rispetto agli eventi della versione (quindi se sono un sottoinsieme, si riceveranno solo quelli. Se si specificano eventi introdotti in versioni più recenti, questi saranno inviati) Infine, è possibile utilizzare il placeholder "DEFAULT" per specificare l'insieme di eventi più rilevanti di una notifica. type: array items: type: string minLength: 4 maxLength: 256 pattern: ^[A-Z_]+$ waitForAccepted: description: 'Stream di tipo TIMELINE: se true pubblica gli eventi sullo stream solo dopo la pubblicazione dell''evento di accettazione/rifiuto della notifica. Tutti gli eventi dello stato IN_VALIDATION vengono pubblicati senza ritardo. Stream di tipo STATUS: se true pubblica gli stati garantendo che il primo stato sia l''ACCEPTED o il REFUSED' type: boolean StreamRequestV28: description: Struttura comune per eventi di creazione/aggiornamento di uno stream di eventi di avanzamento delle notifiche. L'aggiornamento delle proprietà dello stream è soggetta al controllo di autorizzazione dell'apiKey sui gruppi. type: object required: - title - eventType - groups properties: title: description: Nome sintetico dello stream type: string maxLength: 256 pattern: ^.*$ eventType: description: "Tipo di eventi presenti nel flusso:\n - _STATUS_: cambiamenti di stato delle notifiche\n - _TIMELINE_: eventi a granularità fine" type: string enum: - STATUS - TIMELINE groups: description: rappresenta l'elenco degli id gruppi abilitati a richiedere i dettagli. Una apiKey può consumare o modificare uno stream solo se non ha gruppi o se tutti i gruppi dello stream sono presenti nella apiKey. Se viene specificato array vuoto, si noti che solo apiKey senza gruppi potranno consumare o modificare lo stream. Inoltre, nel caso di updateEventStream, la lista dei gruppi presente nello stream deve essere un sottoinsieme dei gruppi passati nella richiesta (in pratica si possono solo aggiungere gruppi a quelli esistenti) oppure entrambi array vuoti. type: array items: allOf: - $ref: '#/components/schemas/StreamGroup' minLength: 0 filterValues: description: rappresenta l'elenco degli stati o elementi di timeline che si vogliono filtrare; inserendo un array vuoto [] si riceveranno solo gli elementi relativi alla versione con cui è stato creato lo stream. Se specificati invece, avranno priorità rispetto agli eventi della versione (quindi se sono un sottoinsieme, si riceveranno solo quelli. Se si specificano eventi introdotti in versioni più recenti, questi saranno inviati) Infine, è possibile utilizzare il placeholder "DEFAULT" per specificare l'insieme di eventi più rilevanti di una notifica. type: array items: type: string minLength: 4 maxLength: 256 pattern: ^[A-Z_]+$ waitForAccepted: description: 'Stream di tipo TIMELINE: se true pubblica gli eventi sullo stream solo dopo la pubblicazione dell''evento di accettazione/rifiuto della notifica. Tutti gli eventi dello stato IN_VALIDATION vengono pubblicati senza ritardo. Stream di tipo STATUS: se true pubblica gli stati garantendo che il primo stato sia l''ACCEPTED o il REFUSED' type: boolean StreamListResponse: description: Elenco di flussi di eventi type: array items: $ref: '#/components/schemas/StreamListElement' StreamCreationRequest: description: Richiesta di creazione di uno stream di eventi di avanzamento delle notifiche. type: object required: - title - eventType properties: title: description: Nome sintetico dello stream type: string maxLength: 256 pattern: ^.*$ eventType: description: "Tipo di eventi presenti nel flusso:\n - _STATUS_: cambiamenti di stato delle notifiche\n - _TIMELINE_: eventi a granularità fine" type: string enum: - STATUS - TIMELINE filterValues: description: rappresenta l'elenco degli stati o elementi di timeline che si vogliono filtrare; inserendo un array vuoto [] si riceveranno solo gli elementi relativi a v1 type: array items: type: string minLength: 4 maxLength: 256 pattern: ^[A-Z_]+$ parameters: pathStreamId: description: Identificativo dello stream di eventi name: streamId in: path required: true schema: type: string format: uuid securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key x-refined-from: - send-b2b-pa-bundle.yaml - pagopa-send-b2b-pa-openapi.yml