From acb3f89b94fea8b7c05acde4fcabd9b1a1392451 Mon Sep 17 00:00:00 2001 From: Roberto Polli Date: Thu, 6 Dec 2018 12:26:14 +0100 Subject: [PATCH 01/10] Initial playground for #14 --- external-apis/lombardia/schemas.yaml | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 external-apis/lombardia/schemas.yaml diff --git a/external-apis/lombardia/schemas.yaml b/external-apis/lombardia/schemas.yaml new file mode 100644 index 0000000..644984c --- /dev/null +++ b/external-apis/lombardia/schemas.yaml @@ -0,0 +1,3 @@ +# +# This file contains openapi schemas from Regione Lombardia glossaries (dictionaries). +# From fc6ba049766160a94820c942a1a180a7cb7058bc Mon Sep 17 00:00:00 2001 From: Roberto Polli Date: Tue, 18 Dec 2018 15:38:34 +0100 Subject: [PATCH 02/10] Add x-healthCheck for testing status. --- external-apis/muoversi2015.e015.servizirl.it.yaml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/external-apis/muoversi2015.e015.servizirl.it.yaml b/external-apis/muoversi2015.e015.servizirl.it.yaml index 1f979ac..da45376 100644 --- a/external-apis/muoversi2015.e015.servizirl.it.yaml +++ b/external-apis/muoversi2015.e015.servizirl.it.yaml @@ -36,6 +36,14 @@ info: servers: - url: https://muoversi2015.e015.servizirl.it/planner/rest/soluzioniJson description: Server accessibile dall'ecosistema E015 + x-healtCheck: + # A regime nel catalogo l'url sara' sempre /status + # un codice 2xx e' OK. Altrimenti e' in errore. + url: >- + https://muoversi2015.e015.servizirl.it/planner/rest/soluzioniJson/e015Search/?param=milano&maxResult=1 + interval: 300 # seconds + timeout: 15 # seconds + paths: /e015Search: get: From ecbdfa317766a332c230ff643603622f9ce2fbb9 Mon Sep 17 00:00:00 2001 From: Roberto Polli Date: Tue, 18 Dec 2018 15:58:35 +0100 Subject: [PATCH 03/10] Add x-api-id --- external-apis/muoversi2015.e015.servizirl.it.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/external-apis/muoversi2015.e015.servizirl.it.yaml b/external-apis/muoversi2015.e015.servizirl.it.yaml index da45376..1dd54e3 100644 --- a/external-apis/muoversi2015.e015.servizirl.it.yaml +++ b/external-apis/muoversi2015.e015.servizirl.it.yaml @@ -33,6 +33,7 @@ info: 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 + x-api-id: 00000000-0000-0000-0000-000000000000 servers: - url: https://muoversi2015.e015.servizirl.it/planner/rest/soluzioniJson description: Server accessibile dall'ecosistema E015 From 7937afc2bf246c424ff788db416f09f32d4fdf53 Mon Sep 17 00:00:00 2001 From: stefkohub Date: Wed, 19 Dec 2018 14:40:49 +0100 Subject: [PATCH 04/10] Segnaposto con tutti 0 per nuovo campo info.x-api-id --- external-apis/muoversi2015.e015.servizirl.it.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/external-apis/muoversi2015.e015.servizirl.it.yaml b/external-apis/muoversi2015.e015.servizirl.it.yaml index 1f979ac..581644f 100644 --- a/external-apis/muoversi2015.e015.servizirl.it.yaml +++ b/external-apis/muoversi2015.e015.servizirl.it.yaml @@ -31,6 +31,7 @@ info: url: http://www.e015.regione.lombardia.it/PE015/esplora-i-contenuti/i-servizi/muoversi-lombardia email: e015-tmb@regione.lombardia.it version: 1.0.0 + x-api-id: 00000000-0000-0000-0000-000000000000 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: From 33fb6979908ff9bfb1c8169aee492e1afb116b67 Mon Sep 17 00:00:00 2001 From: stefkohub Date: Wed, 19 Dec 2018 14:48:10 +0100 Subject: [PATCH 05/10] Incluso ecosystem sotto x-catalog --- external-apis/muoversi2015.e015.servizirl.it.yaml | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/external-apis/muoversi2015.e015.servizirl.it.yaml b/external-apis/muoversi2015.e015.servizirl.it.yaml index 1f979ac..4bfa4d8 100644 --- a/external-apis/muoversi2015.e015.servizirl.it.yaml +++ b/external-apis/muoversi2015.e015.servizirl.it.yaml @@ -26,6 +26,16 @@ info: ``` 'https://muoversi2015.e015.servizirl.it/planner/rest/soluzioniJson/e015Search?param=milano&maxResult=1' ``` + x-catalog: + tag: [TAG1,TAG2] + category: [CATEGORY1,CATEGORY2] + context: + - name: [Nome contesto] + description: [Descrizione contesto] + ecosystem: + - name: [Nome ecosistema] + url: [Url verso ecosistema di cui fa parte questa definizione API] + description: [Descrizione Ecosistema] contact: name: Technical Management Board di E015 url: http://www.e015.regione.lombardia.it/PE015/esplora-i-contenuti/i-servizi/muoversi-lombardia From 431b62fe1f2f6aad43e626bb60786af64dfd91b1 Mon Sep 17 00:00:00 2001 From: Roberto Polli Date: Fri, 21 Dec 2018 09:52:18 +0100 Subject: [PATCH 06/10] Fix typos. Add x-catalog.category values. --- external-apis/muoversi2015.e015.servizirl.it.yaml | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/external-apis/muoversi2015.e015.servizirl.it.yaml b/external-apis/muoversi2015.e015.servizirl.it.yaml index 56739d2..3424c37 100644 --- a/external-apis/muoversi2015.e015.servizirl.it.yaml +++ b/external-apis/muoversi2015.e015.servizirl.it.yaml @@ -1,6 +1,8 @@ --- openapi: 3.0.0 info: + version: 3.0.1 + x-api-id: 00000000-0000-0000-0000-000000000000 title: Muoversi in Lombardia x-summary: Il servizio fornisce una soluzione di viaggio intermodale utilizzando il trasporto pubblico in Lombardia. description: |- @@ -27,28 +29,25 @@ info: 'https://muoversi2015.e015.servizirl.it/planner/rest/soluzioniJson/e015Search?param=milano&maxResult=1' ``` x-catalog: - tag: [TAG1,TAG2] + tag: [orari, trasporto pubblico, arrivo, partenza intermodalità, autobus, tram, treno, traghetto, funicolare, metropolitana] category: [CATEGORY1,CATEGORY2] context: - name: [Nome contesto] description: [Descrizione contesto] ecosystem: - - name: [Nome ecosistema] + - name: E015 url: [Url verso ecosistema di cui fa parte questa definizione API] description: [Descrizione Ecosistema] contact: name: Technical Management Board di E015 url: http://www.e015.regione.lombardia.it/PE015/esplora-i-contenuti/i-servizi/muoversi-lombardia email: e015-tmb@regione.lombardia.it - version: 1.0.0 - x-api-id: 00000000-0000-0000-0000-000000000000 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 - x-api-id: 00000000-0000-0000-0000-000000000000 servers: - url: https://muoversi2015.e015.servizirl.it/planner/rest/soluzioniJson description: Server accessibile dall'ecosistema E015 - x-healtCheck: + x-healthCheck: # A regime nel catalogo l'url sara' sempre /status # un codice 2xx e' OK. Altrimenti e' in errore. url: >- From 73a68a5d9b62c4ff72b9790b8e81ba4eb4e531df Mon Sep 17 00:00:00 2001 From: Roberto Polli Date: Fri, 21 Dec 2018 10:40:30 +0100 Subject: [PATCH 07/10] Add security and securityScheme --- external-apis/muoversi2015.e015.servizirl.it.yaml | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/external-apis/muoversi2015.e015.servizirl.it.yaml b/external-apis/muoversi2015.e015.servizirl.it.yaml index 3424c37..1c909f9 100644 --- a/external-apis/muoversi2015.e015.servizirl.it.yaml +++ b/external-apis/muoversi2015.e015.servizirl.it.yaml @@ -54,7 +54,8 @@ servers: https://muoversi2015.e015.servizirl.it/planner/rest/soluzioniJson/e015Search/?param=milano&maxResult=1 interval: 300 # seconds timeout: 15 # seconds - +security: +- MutualTLS: [] paths: /e015Search: get: @@ -131,6 +132,17 @@ paths: type: string components: + securitySchemes: + MutualTLS: + description: >- + Nome del file del certificato X.509 associato al servizio, necessario per abilitare + il meccanismo di attestazione dell’appartenenza all’Ecosistema: + - CA_CA di Servizio.crt + - FOGLIA_e015.servizirl.it + NOTA: il supporto per mutualTLS e' previsto in OAS 3.1 https://github.com/OAI/OpenAPI-Specification/pull/1764 + quindi *temporaneamente* andremo ad indicare `type: http` per non rompere la validazione. + type: http + scheme: basic schemas: Search: properties: From 8b2d46e6de7e75dcc8f5742b1870f1c8b36a5feb Mon Sep 17 00:00:00 2001 From: Roberto Polli Date: Fri, 21 Dec 2018 11:26:18 +0100 Subject: [PATCH 08/10] Add x-lifecycle #17 --- external-apis/muoversi2015.e015.servizirl.it.yaml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/external-apis/muoversi2015.e015.servizirl.it.yaml b/external-apis/muoversi2015.e015.servizirl.it.yaml index 1c909f9..d06440e 100644 --- a/external-apis/muoversi2015.e015.servizirl.it.yaml +++ b/external-apis/muoversi2015.e015.servizirl.it.yaml @@ -28,6 +28,12 @@ info: ``` 'https://muoversi2015.e015.servizirl.it/planner/rest/soluzioniJson/e015Search?param=milano&maxResult=1' ``` + x-lifecycle: # {type: string, format: date } + published: 2018-01-01 # data di pubblicazione + deprecated: 2020-12-31 # data inizio dismissione + retired: 2021-03-31 # data termine dismissione + maturity: published # {type: string, enum: [proposal,developing,published,deprecated,retired] + x-catalog: tag: [orari, trasporto pubblico, arrivo, partenza intermodalità, autobus, tram, treno, traghetto, funicolare, metropolitana] category: [CATEGORY1,CATEGORY2] From 3ec61568b68152c3cdb647018d5ad911ce919c26 Mon Sep 17 00:00:00 2001 From: Roberto Polli Date: Fri, 21 Dec 2018 11:37:34 +0100 Subject: [PATCH 09/10] Fix: #19. Indicazioni su ambiente sandbox. --- external-apis/muoversi2015.e015.servizirl.it.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/external-apis/muoversi2015.e015.servizirl.it.yaml b/external-apis/muoversi2015.e015.servizirl.it.yaml index 1c909f9..18b802d 100644 --- a/external-apis/muoversi2015.e015.servizirl.it.yaml +++ b/external-apis/muoversi2015.e015.servizirl.it.yaml @@ -47,6 +47,7 @@ info: servers: - url: https://muoversi2015.e015.servizirl.it/planner/rest/soluzioniJson description: Server accessibile dall'ecosistema E015 + x-sandbox: false # Se questo parametro non è definito o e' a false, l'ambiente non e' di sandbox. x-healthCheck: # A regime nel catalogo l'url sara' sempre /status # un codice 2xx e' OK. Altrimenti e' in errore. From 1cb90e8c82e4f0821496ce237a41531789a8d60f Mon Sep 17 00:00:00 2001 From: Roberto Polli Date: Fri, 21 Dec 2018 18:25:56 +0100 Subject: [PATCH 10/10] Add catalog metadata --- external-apis/lombardia/metadata.yaml | 81 +++++++++++++++++++++++++++ 1 file changed, 81 insertions(+) create mode 100644 external-apis/lombardia/metadata.yaml diff --git a/external-apis/lombardia/metadata.yaml b/external-apis/lombardia/metadata.yaml new file mode 100644 index 0000000..fcfd21e --- /dev/null +++ b/external-apis/lombardia/metadata.yaml @@ -0,0 +1,81 @@ +# +# Metatada catalog items extending OAS3 schemas +# + +x_api_id: + type: string + pattern: [0-9a-f\-]+ + description: A unique id for the API + +x_lifecycle: + properties: + published: + type: string + format: date + deprecated: + type: string + format: date + retired: + type: string + format: date + maturity: + type: string + enum: [proposal,developing,published,deprecated,retired] + +x_catalog: + properties: + tag: + description: >- + A list of tags useful for catalog search purposes. + type: array + items: + type: string + category: + tag: + type: array + items: + type: string + context: + type: array + items: + $ref: '#/Context' + ecosystem: + type: array + items: + $ref: '#/Ecosystem' + + +Context: + description: >- + WRITEME @stefkohub + properties: + name: + type: string + description: + type: string + +Ecosystem: + description: >- + WRITEME @stefkohub + properties: + name: + type: string + description: + type: string + url: + type: string + +HealthCheck: + description: >- + HealthCheck informations for testing API status. + properties: + url: + type: string + format: url + description: absolute or relative url to the healthcheck path + interval: + type: number + description: expected seconds between two checks + timeout: + type: number + description: expected timeout interval after which a request should timeout \ No newline at end of file