Merge branch 'stf606-draft' into 'stf606-final'

Update editor and validation tools

See merge request !9

.jenkins.sh

-#!/bin/bash
-
-specfiles=$(ls | egrep "^[^.]*.(json|yaml)")
-
-fres=0
-for i in $specfiles ; do
-    echo "-- Validating and linting OpenAPI file $i..."
-    swagger-cli validate $i
-    res=$?
-    speccy lint "$i"
-    res2=$?
-    fres=$(($fres||$res||$res2))
-    echo "--- Validator returned $res, linter returned $res2."
-done
-
-echo "-- Final validator returns $fres."
-exit $fres
-

MEC029_FAI.json

@@ -25,16 +25,20 @@
   ],
   "tags": [
     {
-      "name": "Queries"
+      "name": "Queries",
+      "description": "APIs for Device and fa_info"
     },
     {
-      "name": "Subscription"
+      "name": "Subscription",
+      "description": "Subscription API"
     },
     {
-      "name": "Cable line info"
+      "name": "Cable line info",
+      "description": "Cable line info API"
     },
     {
-      "name": "Optical network info"
+      "name": "Optical network info",
+      "description": "Optican network Info API"
     }
   ],
   "paths": {
@@ -535,6 +539,9 @@
                 "responses": {
                   "204": {
                     "$ref": "#/components/responses/204"
+                  },
+                  "400": {
+                    "$ref": "#/components/responses/400"
                   }
                 }
               }
@@ -1070,15 +1077,17 @@
           "ifIndex",
           "serviceFlowInfo"
         ],
-        "ifIndex": {
-          "description": "It represents the interface index of the MAC Domain of the Service Flow.",
-          "type": "string"
-        },
-        "serviceFlowInfo": {
-          "description": "It represents the information of a Service Flow.",
-          "type": "array",
-          "items": {
-            "$ref": "#/components/schemas/CableLineInfo.serviceFlowStats.serviceFlowInfo"
+        "properties": {
+          "ifIndex": {
+            "description": "It represents the interface index of the MAC Domain of the Service Flow.",
+            "type": "string"
+          },
+          "serviceFlowInfo": {
+            "description": "It represents the information of a Service Flow.",
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/CableLineInfo.serviceFlowStats.serviceFlowInfo"
+            }
           }
         }
       },
@@ -1613,7 +1622,7 @@
           "downloadURI": {
             "description": "The URI for the device to perform the download on.",
             "format": "uri",
-            "type": "uri",
+            "type": "string",
             "x-etsi-mec-cardinality": "0..1",
             "x-etsi-mec-origin-type": "URI"
           },
@@ -1654,7 +1663,7 @@
           "self": {
             "description": "Self referring URI. This shall be included in the response from the FAIS. The URI shall be unique within the FAI API as it acts as an ID for the subscription.",
             "format": "uri",
-            "type": "uri",
+            "type": "string",
             "x-etsi-mec-cardinality": "1",
             "x-etsi-mec-origin-type": "URI"
           }
@@ -1999,7 +2008,8 @@
         "properties": {
           "subscriptionType": {
             "description": "Set by FAIS to indicate to the service consumer the Websocket URI to be used for delivering notifications.",
-            "type": "uri"
+            "type": "string",
+            "format": "uri"
           },
           "requestWebsocketUri": {
             "description": "Set to true by the service consumer to indicate that Websocket delivery is requested.",
@@ -2160,7 +2170,7 @@
           "href": {
             "description": "The URI referring to the subscription.",
             "format": "uri",
-            "type": "uri",
+            "type": "string",
             "x-etsi-mec-cardinality": "1",
             "x-etsi-mec-origin-type": "URI"
           },

MEC029_FAI.yaml

@@ -17,9 +17,13 @@ servers:
   - url: "https://localhost/fai/v1"
 tags:
   - name: Queries
+    description: "APIs for Device and fa_info"
   - name: Subscription
+    description: "Subscription API"
   - name: "Cable line info"
+    description: "Cable line info API"
   - name: "Optical network info"
+    description: "Optican network Info API"
 paths:
   /queries/fa_info:
     get:
@@ -345,6 +349,8 @@ paths:
               responses:
                 "204":
                   $ref: "#/components/responses/204"
+                "400":
+                  $ref: "#/components/responses/400"
 
   /subscriptions/{subscriptionId}:
     parameters:
@@ -754,14 +760,15 @@ components:
       required:
         - ifIndex
         - serviceFlowInfo
-      ifIndex:
-          description: It represents the interface index of the MAC Domain of the Service Flow.
-          type: string
-      serviceFlowInfo:
-          description: It represents the information of a Service Flow.
-          type: array
-          items:
-              $ref: "#/components/schemas/CableLineInfo.serviceFlowStats.serviceFlowInfo"
+      properties:
+        ifIndex:
+            description: It represents the interface index of the MAC Domain of the Service Flow.
+            type: string
+        serviceFlowInfo:
+            description: It represents the information of a Service Flow.
+            type: array
+            items:
+                $ref: "#/components/schemas/CableLineInfo.serviceFlowStats.serviceFlowInfo"
 
     CableLineInfo:
       type: object
@@ -1244,7 +1251,7 @@ components:
         downloadURI:
           description: The URI for the device to perform the download on.
           format: uri
-          type: uri
+          type: string
           x-etsi-mec-cardinality: 0..1
           x-etsi-mec-origin-type: URI
         eOMTime:
@@ -1287,7 +1294,7 @@ components:
         self:
           description: Self referring URI. This shall be included in the response from the FAIS. The URI shall be unique within the FAI API as it acts as an ID for the subscription.
           format: uri
-          type: uri
+          type: string
           x-etsi-mec-cardinality: "1"
           x-etsi-mec-origin-type: URI
       required:
@@ -1598,7 +1605,8 @@ components:
       properties:
         subscriptionType:
           description: Set by FAIS to indicate to the service consumer the Websocket URI to be used for delivering notifications.
-          type: uri
+          type: string
+          format: uri
         requestWebsocketUri:
           description: Set to true by the service consumer to indicate that Websocket delivery is requested.
           type: boolean        
@@ -1737,7 +1745,7 @@ components:
         href:
           description: The URI referring to the subscription.
           format: uri
-          type: uri
+          type: string
           x-etsi-mec-cardinality: "1"
           x-etsi-mec-origin-type: URI
         subscriptionType:

README.md

@@ -6,8 +6,7 @@ This repository contains OpenAPIs descriptions for the interfaces specified in E
 ## Online resources
 
 * [Specification document](https://www.etsi.org/deliver/etsi_gs/MEC/001_099/029/02.02.01_60/gs_MEC029v020201p.pdf)
-* [Navigate the Fixed Access Information API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs029-fai-api/raw/stf606-final/MEC029_FAI.yaml)
-* [Edit the Fixed Access Information API online ](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/rep/mec/gs029-fai-api/raw/stf606-final/MEC029_FAI.yaml)
+* [Navigate the Fixed Access Information API in the browser](https://redocly.github.io/redoc/?url=https://forge.etsi.org/rep/mec/gs029-fai-api/-/raw/v2.2.1/MEC029_FAI.yaml)
 
 
 ## License