[WIP] 14 metadata muoversi lombardia

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

external-apis/lombardia/schemas.yaml

@@ -0,0 +1,3 @@
+#
+# This file contains openapi schemas from Regione Lombardia glossaries (dictionaries).
+#

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: |-
@@ -26,16 +28,41 @@ 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]
+    context:
+      - name: [Nome contesto]
+        description: [Descrizione contesto]
+    ecosystem:
+      - 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: [email protected]
-  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-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.
+    url: >-
+      https://muoversi2015.e015.servizirl.it/planner/rest/soluzioniJson/e015Search/?param=milano&maxResult=1
+    interval: 300    # seconds
+    timeout: 15  # seconds
+security:
+- MutualTLS: []
 paths:
   /e015Search:
     get:
@@ -112,6 +139,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: