Comuni-Chiamo OpenAPI Changelog

Ultima release: 2.0.8

Legenda

Tipi di aggiornamenti:

Added per le nuove features.
Changed per i cambiamenti fatti alle features esistenti.
Fixed per i bug fixati.
Deprecated per features deprecate che saranno rimosse nelle prossime release.
Removed per features rimosse.
Security in caso di vulnerabilità.

Version 2.0.8 - 12 Mar 2024

Fixed

fix minori per mantenere la stabilità dell'applicativo e migliorarne le performance

Version 2.0.7 - 06 Feb 2024

Fixed

fix minori per mantenere la stabilità dell'applicativo e migliorarne le performance

Version 2.0.6 - 01 Feb 2024

Fixed

fix minori per mantenere la stabilità dell'applicativo e migliorarne le performance

Version 2.0.5 - 14 Dic 2023

Fixed

fixato errore nell'endpoint di assegnazione

Version 2.0.4 - 27 Nov 2023

Fixed

fix minori per mantenere la stabilità dell'applicativo e migliorarne le performance

Version 2.0.3 - 10 Ott 2023

Fixed

fix minori per mantenere la stabilità dell'applicativo e migliorarne le performance

Version 2.0.2

Fixed

Sistemato errore negli endpoint di GET del dettaglio di una segnalazione

Version 2.0.1

Fixed

Sistemato valore del campo `status` nella GET di dettaglio segnalazione

Version 2.0.0

Changed

Aggiornata l'implementazione delle API seguendo lo standard OpenAPI e le indicazioni date da Agid per l'interoperabilità

Added

Aggiunta documentazione per la v2
Aggiunta documentazione per la migrazione dalla v1 alla v2

Removed

Rimosso endpoint per gestire gli utenti usando l'email nell'URL
```
GET /entities/{entity_id}/crm/users/{crm_email}
```
Vedi migration guide alla sezione CRM per maggior informazioni

Version 1.0.22

Fixed

Sistemati errori ricevuti dopo l'aggiornamento delle dipendenze del progetto nel caso di POST senza payload o di Content-Type con il valore sbagliato

Version 1.0.21

Added

Aggiornata documentazione relativa all'endpoint di invio messaggi.
Aumentata la validità di un OAuth2 Client da 3 mesi a 12 mesi.
Aggiunto sistema di alerting via email per notificare gli utenti integrati che il loro OAuth2 Client è scaduto.
Aggiornata la documentazione dell'endpoint per aggiornare un punto di interesse, aggiunti esempi di payload da utilizzare per aggiornare i vari campi

Fixed

Fixato bug nell'endpoint per aggiornare un punto di interesse.

Version 1.0.20

Fixed

Corretta documentazione degli endpoint per ottenere la lista delle segnalazioni, mancava la s finale nel filtro filter_by_status_ids (non è stata apportata nessuna modifica al filtro, solo la documentazione).

Version 1.0.19

Added

Nel dettaglio di una segnalazione è stata aggiunto il parametro meta che contiene informazioni extra relative alla segnalazione.
Nell'aggiornamento di una segnalazione è stata aggiunta la possibilità di aggiornare anche il valore dei campi meta.
Aggiornate le documentazioni relative a questi due endpoint.

Version 1.0.18

Fixed

Corretto URL di riferimento per il dettaglio di una segnalazione nelle informazioni di un utente CRM.

Version 1.0.17

Added

Aggiunto nuovo endpoint per ottenere il dettaglio di un utente CRM tramite la sua email.
Nel dettaglio di un utente CRM sono state aggiunte nuove informazioni sulle segnalazioni che ha creato.
Aggiornata documentazione relativa agli endpoint del CRM.

Fixed

Fixata paginazione nell'endpoint della lista di utenti CRM.

Version 1.0.16

Added

Aggiunti filtro per data di creazione e filtro per data di ultima modifica nella lista di utenti del CRM.
Aggiunta documentazione relativa ai due nuovi filtri.
Aggiornata documentazione con informazioni mancanti sulla paginazione nell'endpoint della lista di utenti del CRM.

Fixed

Fixato errore nell'endpoint del dettaglio di un utente CRM.
Fixata paginazione nell'endpoint della lista di utenti CRM.

Version 1.0.15

Added

Aggiunto nuovo endpoint per ottenere la lista degli utenti censiti all'interno di un particolare ente.
Aggiunto nuovo endpoint per ottenere il dettaglio di un utente censito all'interno di un particolare ente.
Aggiunto nuovo endpoint per ottenere la lista degli ID di tutti gli utenti che erano censiti all'interno di un particolare ente, ma che sono stati cancellati.
Aggiunta la documentazione per i tre nuovi endpoint.

Version 1.0.14

Fixed

Fixato piccolo bug nell'aggiunta dei campi featured dei punti di interesse. Dato che soltanto una informazione per ogni lingua può essere messa in evidenza, nel caso in cui vengano passate 2 o più informazioni con il is_featured = True, verrà messa in evidenza soltanto la prima mentre le successive saranno settate automaticamente a False.

Changed

Aggiornato il limite massimo di punti di interesse che si possono aggiungere ad ogni mappa pari a 500 poiché in seguito a diversi test fatti sulle piattaforme mobile, abbiamo visto che raggiunto questo limite una buona parte di device iniziano ad avere problemi di performance.

Version 1.0.13

Security

Quando si interrogano gli endpoint relativi alle segnalazioni, se si utilizzano gli ID delle segnalazioni in formato esadecimale, si consiglia di utilizzare sempre il prefisso 0x davanti all'ID esadecimale. Questo evita un raro ma spiacevole caso in cui gli endpoint rispondano con access_denied poiché hanno interpretato un ID esadecimale come ID intero (ad esempio l'ID 42356 è difficile capire se è intero o esadecimale, ma passandolo come 0x42356 si sta esplicitando il suo formato).

Version 1.0.12

Fixed

Fixato errore nell'endpoint per l'aggiornamento di un punto di interesse.
Fixato status code non corretto nel caso di errore dalle API.
Fixato limite di massimo 3000 punti totali per mappa.

Version 1.0.11

Fixed

Fixato errore nell'endpoint che restituisce la lista delle segnalazioni (in mancanza del filtro filter_by_results_set non veniva restituito nessun risultato)

Version 1.0.10

Added

Aggiunto nuovo filtro per stato della segnalazione (filter_by_status_ids) all'endpoint utilizzato per ottenere la lista delle segnalazioni.
Aggiornata la documentazione relativa alla lista delle segnalazioni con il nuovo filtro per stato della segnalazione (filter_by_status_ids).

Fixed

Rimossi alcuni valori errati restituiti dall'endpoint /dictionaries/issue_statuses.

Changed

Backend improvements per migliorare le performance degli endpoint e dell'applicativo.

Version 1.0.9

Fixed

Corretta documentazione per la creazione e l'aggiornamento delle mappe (i metodi PUT e POST erano invertiti).
Corretta documentazione per la creazione e l'aggiornamento dei punti di interesse (i metodi PUT e POST erano invertiti).

Version 1.0.8

Added

Aggiunti 4 nuovi endpoint per la gestione dei punti di interesse.
Aggiunti 4 nuovi endpoint per la gestione delle mappe.
Aggiunto endpoint per ottenere la lista degli ID delle possibili icone da associare ad un punto di interesse.
Aggiunto endpoint per ottenere la lista dei possibili valori di filter_by_geometry_type per filtrare i punti di interesse.
Aggiunto endpoint per ottenere la lista dei possibili valori di publication_status relativi ad una mappa.
Aggiunta documentazione per i nuovi endpoint relativi ai punti di interesse.
Aggiunta documentazione per i nuovi endpoint relativi alle mappe.

Changed

Aggiunte restrizioni sul filtro per data negli endpoint relativi alla lista delle segnalazioni, lista delle mappe e lista dei punti di interesse.
Aggiornata la documentazione relativa al filtro per date nell'endpoint per ottenere la lista delle segnalazioni.
Aggiornata la documentazione relativa al dettaglio di una segnalazione, mappati i campi relativi agli allegati di una segnalazione.

Version 1.0.7

Added

Aggiunto endpoint per l'invio di messaggi al cittadino.
Aggiunto codice identificativo del proprio utente nella risposta dell'endpoint /me.

Changed

Migliorato il parametro filter_by_date utilizzato dall'endpoint per la lista delle segnalazioni. Grazie al nuovo aggiornamento adesso è possibile filtrare anche per un orario specifico e non solo per data. Maggiori dettagli nella documentazione delle API.
Migliorati i messaggi di errore restituiti dall'endpoint per l'aggiornamento dello stato di una segnalazione.
Aggiornata la documentazione con i nuovi messaggi d'errore ed alcuni dettagli aggiuntivi sui vincoli relativo al cambio di stato di una segnalazione.
Migliorata la documentazione dei parametri alert_id, status_id, outcome_value e type_id utilizzati da alcuni endpoint.
Riorganizzata la documentazione con la creazione di gruppi di endpoint.

Fixed

Corretto il testo del messaggio di errore restituito dall'endpoint per l'invio di messaggi.

Version 1.0.6

Added

Creato nuovo endpoint per inviare attività dentro una segnalazione.

Changed

L'endpoint di invio segnalazione passa da POST a PUT.

Version 1.0.5

Added

Creato nuovo endpoint per poter assegnare o disassegnare un utente o un gruppo da una segnalazione.
Aggiunta documentazione relativa al nuovo endpoint.
Aggiunta la sezione FAQ nel file README presente sul repository Git.

Changed

Migliorata la documentazione degli endpoint aggiungendo le descrizioni mancanti dei parametri che compongono l'URL delle richieste.
Aggiornata la documentazione per l'endpoint /oauth/authorize migliorando la descrizione del parametro scope e dei suoi utilizzi.
Aggiornata la documentazione con la descrizione degli scope richiesti da ogni singolo endpoint.
Aggiornati gli esempi di richieste presenti sul repository Git.

Removed

Rimosso /update dagli URL degli endpoint.

Version 1.0.4

Changed

Aggiornata la documentazione, ora negli endpoint vengono indicati tra parentesi graffe quali sono i parametri da specificare nell'URL, mentre nella documentazione di ogni endpoint viene specificato il tipo di quel parametro.
Ad esempio per ottenere la lista delle segnalazioni al posto del parametro {entity_id} bisognerà specificare il codice identificativo univoce dell'Ente in questione.

Fixed

Fixato endpoint /me che restituiva sempre 401.

Removed

Rimossa la basic authentication dagli endpoint delle API, ora è sufficiente specificare il token ottenuto dagli endpoint di autorizzazione.
La funzionalità Try it out che si trova nella documentazione non è ancora funzionante per tutti gli endpoint.

Version 1.0.3

Added

Aggiunto nuovo endpoint per aggiornare l'esito di chiusura di una segnalazione.
Aggiunta documentazione per il nuovo endpoint.

Changed

Migliorata la documentazione per gli endpoint relativi alle decodifiche dei dati.
Documentati alcuni esempi su come utilizzare l'endpoint per aggiornare lo stato di una segnalazione.

Version 1.0.2

Added

Nuova versione degli scope di OAuth2, ora sono 3: read_data, read_users_data, write_data. Nella documentazione maggiori informazioni. L'implementazione non è comunque ancora terminata sotto quest'aspetto.
4 nuovi endpoint per le decodifiche dei dati.
6 nuovi endpoint per interagire più profondamente con Comuni-Chiamo.
Creato il canale pubblico di Telegram per il supporto.
Migliorata la documentazione, anche se non è ancora la versione definitiva.