Proposte per parametri custom Servizi Nazionali #15
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -30,18 +30,65 @@ info: | |
| name: Technical Management Board di E015 | ||
| url: http://www.e015.regione.lombardia.it/PE015/esplora-i-contenuti/i-servizi/muoversi-lombardia | ||
| email: [email protected] | ||
| x-publisher: [dati publisher] | ||
| x-provider: [dati provider servizi] | ||
| x-complexity-index: [valore della complessità delle api (in FP)] | ||
| x-gdpr: | ||
| - data: [Informazione da gestire (ad es. Codice Fiscale)] | ||
| data-type: [Tipologia (ad es. personale|sensibile|giudiziario)] | ||
| x-lifecycle: | ||
|
Contributor
There was a problem hiding this comment. Possiamo prendere i valori dal file di specifica E015? Chi lo gestisce? Possiamo coinvolgerli in modo da ottenere un template che loro possono riusare.
Contributor
There was a problem hiding this comment. |
||
| published: [Data-Pubblicazione-Progetto] | ||
| retires: [Data-Ritiro-Progetto] | ||
| maturity: [enum di valori stable|deprecated|new|alpha|beta] | ||
| x-audience: | ||
| visibility: [Set di valori che definiscono chi può visualizzare questa API] | ||
| allowed-profiles: [Elenco dei profili business abilitati a consumare l'API] | ||
| x-ecosystem: | ||
|
Contributor
There was a problem hiding this comment.
Author
There was a problem hiding this comment. si, faccio una pull request per apportare la modifica |
||
| - name: [Nome ecosistema] | ||
|
Contributor
There was a problem hiding this comment. In questo caso (Muoversi Lombardia) potete valorizzare i campi? @stefkohub |
||
| url: [Url verso ecosistema di cui fa parte questa definizione API] | ||
| description: [Descrizione Ecosistema] | ||
| x-catalog: | ||
| tag: [TAG1,TAG2] | ||
| category: [CATEGORY1,CATEGORY2] | ||
| context: | ||
| - name: [Nome contesto] | ||
| description: [Descrizione contesto] | ||
| x-rating: | ||
| stats: [URL lettura statistiche KPI API] | ||
| rating: [URL lettura rating API] | ||
| x-api-id: [Identificativo univoco insieme di funzionalita'] | ||
|
Contributor
There was a problem hiding this comment. Qui ci mettiamo un bel provvisiorio
Contributor
There was a problem hiding this comment. Fai tu PR non devi fare merge delle mie modifiche. |
||
| x-business-function: | ||
| - name: [Nome business function] | ||
| description: [Descrizione business function] | ||
| x-technology-type: [Da definire secondo glossario/dominio dei valori] | ||
| x-glossary: | ||
|
Contributor
There was a problem hiding this comment. Le info di glossario non le metterei direttamente qui ma in Guarda in questo draft come le informazioni di glossario siano indicate sia sulla classe Un parser può semplicemente ricostruire tutto il gioco leggendo lo yaml e ricavare l'informazione completa e aggiornata. |
||
| name: [Nome glossario] | ||
| url: [http://URL-GLOSSARIO] | ||
| description: [Descrizione breve glossario] | ||
| publisher: [Soggetto che ha redatto il glossario] | ||
| ecosystem: [Ecosistema cui afferisce il glossario] | ||
| version: [Versione glossario] | ||
|
|
||
| version: 1.0.0 | ||
| termsOfService: >- | ||
| http://www.e015.regione.lombardia.it/PE015/system/files_force/allegati/policy-servizio/policy_servizio_muoversi_in_lombardia_0.pdf?download=1&download=1 | ||
| servers: | ||
| - url: https://muoversi2015.e015.servizirl.it/planner/rest/soluzioniJson | ||
| description: Server accessibile dall'ecosistema E015 | ||
| x-healthcheck: | ||
| url: [http://URL-SERVIZIO-ISALIVE] | ||
ioggstream marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| interval: [intervallo in secondi del polling isalive] | ||
|
|
||
| paths: | ||
| /e015Search: | ||
| get: | ||
| description: Sulla base del testo inserito per effettuare la ricerca, il servizio | ||
| restituisce una lista di punti, ognuno dei quali corredato da una descrizione, | ||
| una tipologia e la coppia di coordinate che ne individua la posizione. | ||
| x-lifecycle: | ||
|
Contributor
There was a problem hiding this comment. Questo se definito fa' override del default definito per l'API, corretto? Per i campi scaduti useremo
Author
There was a problem hiding this comment. Sono a due livelli differenti. Può esserci l'API "Muoversi in Lombardia" con stato "stable" in generale, ma un metodo "/droneManage" in versione "alpha" ed il metodo "/carriola" in "deprecated".
Contributor
There was a problem hiding this comment. generalmente d'accordo, ma devo capire come marcare i metodi in alpha in maniera |
||
| published: [Data-di-pubblicazione-singola-API] | ||
| retires: [data-di-ritiro-singola-API] | ||
| maturity: [stable|deprecated|new|alpha|beta] | ||
| responses: | ||
| 200: | ||
| description: I luoghi corrspondenti a una ricerca. | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Questo avrebbe senso gestirlo con la granularità negli schemas, in modo da poter taggare i singoli campi e appoggiarsi ad eventuali schemi metadatabili (Eg. vedi il riferimento che questo schema ha verso le ontologie https://github.com/teamdigitale/openapi/blob/master/docs/schemas/tax_code.yaml)
In questo caso si potrebbe fare anche un lavoro più articolato, collegando i singoli schemi e/o dati alle ontologie agid.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
totalmente d'accordo, va spostato negli schemas. Il parser lato server può comporre tutte le informazioni relative alla privacy scorrendo le informazioni sulla privacy dei dati che vanno trattati direttamente nella definizione dei dati stessi.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Esatto, e le indicazioni potrebbero essere addirittura prese dall'ontologia agid: per questo è importante usare ove possibile quei riferimenti ed uniformare progressivamente i glossari.
Il gruppo che segue https://github.com/italia/daf-ontologie-vocabolari-controllati è molto ferrato. Se serve possiamo contattarli tramite slack.developers.italia.it #ontologie.