Fix: #5. Add x-summary and x-project fields

ioggstream · ioggstream · commit ae9a8c6d8238 · 2018-08-14T15:10:44.000+02:00
diff --git a/COMPLIANCE.md b/COMPLIANCE.md
@@ -27,6 +27,7 @@ info:
   version: "0.0.1"
   title: |
     Just an API
+  x-summary: An one-liner headline to be used in catalogs.
   description: |
     A short description of the application.
     [CommonMark](http://spec.commonmark.org/) syntax
diff --git a/external-apis/api.daf.teamdigitale.it.yaml b/external-apis/api.daf.teamdigitale.it.yaml
@@ -22,21 +22,40 @@ components:
       description: Too Many Requests
       headers:
         Retry-After:
-          $ref: https://teamdigitale.github.io/openapi/headers/v3.yaml#/Retry-After
+          description: |-
+            Retry contacting the endpoint *at least* after seconds.
+            See https://tools.ietf.org/html/rfc7231#section-7.1.3
+          schema:
+            format: int32
+            type: integer
         X-RateLimit-Limit:
-          $ref: https://teamdigitale.github.io/openapi/headers/v3.yaml#/X-RateLimit-Limit
+          description: The number of allowed requests in the current period
+          schema:
+            format: int32
+            type: integer
         X-RateLimit-Remaining:
-          $ref: https://teamdigitale.github.io/openapi/headers/v3.yaml#/X-RateLimit-Remaining
+          description: The number of remaining requests in the current period
+          schema:
+            format: int32
+            type: integer
         X-RateLimit-Reset:
-          $ref: https://teamdigitale.github.io/openapi/headers/v3.yaml#/X-RateLimit-Reset
+          description: The number of seconds left in the current period
+          schema:
+            format: int32
+            type: integer
     503ServiceUnavailable:
       application/json:
         schema:
           $ref: '#/components/schemas/CkanError'
       description: Service Unavailable
       headers:
         Retry-After:
-          $ref: https://teamdigitale.github.io/openapi/headers/v3.yaml#/Retry-After
+          description: |-
+            Retry contacting the endpoint *at least* after seconds.
+            See https://tools.ietf.org/html/rfc7231#section-7.1.3
+          schema:
+            format: int32
+            type: integer
     CkanResponse:
       content:
         application/json:
@@ -105,8 +124,6 @@ info:
     email: alessandro@teamdigitale.governo.it
     name: Data Analytics Framework
     url: https://dataportal.daf.teamdigitale.it/
-  x-project: daf
-  x-summary: API per ricercare e visualizzare gli open data del Data & Analytics Framework in api.daf.teamdigitale.it.
   description: |
     #### Documentazione
     Il Data & Analytics Framework (DAF) è il progetto istituito tramite
@@ -162,6 +179,9 @@ info:
   x-api-id: 3ab5b162-132b-49fa-96c2-c81557823cda
   x-audience:
   - public
+  x-project: daf
+  x-summary: API per ricercare e visualizzare gli open data del Data & Analytics Framework
+    in api.daf.teamdigitale.it.
 openapi: 3.0.0
 paths:
   /organization_list:
diff --git a/external-apis/api.daf.teamdigitale.it.yaml.src b/external-apis/api.daf.teamdigitale.it.yaml.src
@@ -16,10 +16,10 @@ servers:
 info:
   version: '3'
   title: DAF CKAN API
-  description: |
+  x-project: daf
+  x-summary: >-
     API per ricercare e visualizzare gli open data del Data & Analytics Framework in api.daf.teamdigitale.it.
-
-
+  description: |
     #### Documentazione
     Il Data & Analytics Framework (DAF) è il progetto istituito tramite
     la Piattaforma Digitale Nazionale Dati - [art. 50-ter del Codice dell'Amministrazione Digitale](http://cad.readthedocs.io/it/v2017-12-13/_rst/capo5_sezione1_art50-ter.html)
diff --git a/external-apis/cercaareeprotette.e015.servizirl.it.yaml b/external-apis/cercaareeprotette.e015.servizirl.it.yaml
@@ -2,9 +2,9 @@
 openapi: 3.0.0
 info:
   title: Aree Protette
-  description: |-
+  x-summary: >-
     Il servizio fornisce informazioni sui Parchi, riserve e monumenti naturali della Lombardia.
-
+  description: |-
     #### Documentazione
     Il servizio fornisce informazioni sui Parchi, riserve naturali e monumenti naturali della Regione Lombardia
     censiti tramite il servizio Parchi e Riserve. Le informazioni restituite rispettano il tracciato standard del glossario E015 `venue`.
diff --git a/external-apis/dati.mit.gov.it.yaml b/external-apis/dati.mit.gov.it.yaml
@@ -147,8 +147,6 @@ info:
     name: Ministero Infrastrutture e Trasporti
     url: http://opencantieri.mit.gov.it/crediti
   description: |
-    API per ricercare e visualizzare gli open data del Ministero delle Infrastrutture e dei Trasporti.
-
     #### Documentazione Il portale dei dati aperti dati.mit.gov.it è realizzato e manutenuto dal Ministero delle infrastrutture e dei trasporti con il coordinamento della Direzione generale per i Sistemi Informativi e Statistici.
     Tramite queste API è possibile ricercare e visualizzare gli open data nazionali presenti sul portale.
 
@@ -175,6 +173,8 @@ info:
   x-api-id: 28a40681-4c28-45c9-9bda-7e55d1d6ec68
   x-audience:
   - public
+  x-summary: API per ricercare e visualizzare gli open data del Ministero delle Infrastrutture
+    e dei Trasporti.
 openapi: 3.0.0
 paths:
   /organization_list:
diff --git a/external-apis/dati.mit.gov.it.yaml.src b/external-apis/dati.mit.gov.it.yaml.src
@@ -20,10 +20,9 @@ openapi: 3.0.0
 servers:
   - url: 'http://dati.mit.gov.it/catalog/api/3/action'
 info:
-  description: >
+  x-summary: >-
     API per ricercare e visualizzare gli open data del Ministero delle Infrastrutture e dei Trasporti.
-
-
+  description: >
     #### Documentazione
     Il portale dei dati aperti dati.mit.gov.it è realizzato e manutenuto dal Ministero delle infrastrutture
     e dei trasporti con il coordinamento della Direzione generale per i Sistemi Informativi e Statistici.
diff --git a/external-apis/muoversi2015.e015.servizirl.it.yaml b/external-apis/muoversi2015.e015.servizirl.it.yaml
@@ -2,9 +2,8 @@
 openapi: 3.0.0
 info:
   title: Muoversi in Lombardia
+  x-summary: Il servizio fornisce una soluzione di viaggio intermodale utilizzando il trasporto pubblico in Lombardia.
   description: |-
-    Il servizio fornisce una soluzione di viaggio intermodale utilizzando il trasporto pubblico in Lombardia.
-
     #### Documentazione
     Il servizio mette a disposizione informazioni georeferenziate relative agli orari
     del Trasporto Pubblico Locale in Regione Lombardia, restituendo delle soluzioni
diff --git a/external-apis/siope.yaml.src b/external-apis/siope.yaml.src
@@ -69,9 +69,9 @@ openapi: 3.0.0
 info:
   version: 1.0.1
   title: 'SIOPE+ API'
-  description: |
+  x-summary: >-
     SIOPE+ - trasmissione degli ordini d'incasso e pagamento tra amministrazioni pubbliche e tesorieri.
-
+  description: |
     #### Documentazione
     SIOPE+ è l'infrastruttura che intermedia il colloquio tra le pubbliche amministrazioni e le banche tesoriere
     con l'obiettivo di migliorare la qualità dei dati per il monitoraggio della spesa pubblica,
diff --git a/external-apis/siopeplus.yaml b/external-apis/siopeplus.yaml
@@ -183,9 +183,8 @@ info:
     email: siopeplus@bancaditalia.it
     name: Banca d'Italia - SIOPEPLUS
     url: https://www.bancaditalia.it/compiti/tesoreria/plus-siope/index.html
+  x-summary: SIOPE+ - trasmissione degli ordini d'incasso e pagamento tra amministrazioni pubbliche e tesorieri.
   description: |
-    SIOPE+ - trasmissione degli ordini d'incasso e pagamento tra amministrazioni pubbliche e tesorieri.
-
     #### Documentazione
     SIOPE+ è l'infrastruttura che intermedia il colloquio tra le pubbliche amministrazioni e le banche tesoriere
     con l'obiettivo di migliorare la qualità dei dati per il monitoraggio della spesa pubblica,
