From ddc0355a977eb797b22dfb665a11451adcb7b07e Mon Sep 17 00:00:00 2001 From: piscione Date: Wed, 6 Apr 2022 20:27:39 +0200 Subject: [PATCH 1/4] Minor issues fixed. --- MEC029_FAI.json | 7 +++---- MEC029_FAI.yaml | 7 +++---- 2 files changed, 6 insertions(+), 8 deletions(-) diff --git a/MEC029_FAI.json b/MEC029_FAI.json index 03226c0..22a46bb 100644 --- a/MEC029_FAI.json +++ b/MEC029_FAI.json @@ -1140,9 +1140,6 @@ }, "CmConnNotification.cmIf": { "description": "", - "items": { - "type": "object" - }, "properties": { "cmId": { "description": "The Cable Modem identifier.", @@ -2100,7 +2097,9 @@ }, "customerPremisesInfo": { "description": "The physical location of a customer site.", - "$ref": "#/components/schemas/CpInfo", + "items": { + "$ref": "#/components/schemas/CpInfo" + }, "minItems": 1, "type": "array", "x-etsi-mec-cardinality": "1..N", diff --git a/MEC029_FAI.yaml b/MEC029_FAI.yaml index be05b01..c91ba28 100644 --- a/MEC029_FAI.yaml +++ b/MEC029_FAI.yaml @@ -819,8 +819,6 @@ components: CmConnNotification.cmIf: description: "" - items: - type: object properties: cmId: description: The Cable Modem identifier. @@ -1683,7 +1681,8 @@ components: $ref: "#/components/schemas/TimeStamp" customerPremisesInfo: description: The physical location of a customer site. - $ref: "#/components/schemas/CpInfo" + items: + $ref: "#/components/schemas/CpInfo" minItems: 1 type: array x-etsi-mec-cardinality: 1..N @@ -2050,4 +2049,4 @@ components: content: application/json: schema: - $ref: "#/components/schemas/ProblemDetails" \ No newline at end of file + $ref: "#/components/schemas/ProblemDetails" -- GitLab From 2e50359f3605e5e3b4a111459d39b4c878e05c0a Mon Sep 17 00:00:00 2001 From: piscione Date: Mon, 11 Apr 2022 19:19:27 +0200 Subject: [PATCH 2/4] Fixes based on linter error. --- MEC029_FAI.json | 44 +++++++++++++++++++++++++++----------------- MEC029_FAI.yaml | 32 ++++++++++++++++++++------------ 2 files changed, 47 insertions(+), 29 deletions(-) diff --git a/MEC029_FAI.json b/MEC029_FAI.json index 22a46bb..c6d3848 100644 --- a/MEC029_FAI.json +++ b/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" }, diff --git a/MEC029_FAI.yaml b/MEC029_FAI.yaml index c91ba28..8bca309 100644 --- a/MEC029_FAI.yaml +++ b/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: -- GitLab From 75e893c8c61e21a3c621da7650dce351d6a0a832 Mon Sep 17 00:00:00 2001 From: hammad zafar Date: Wed, 13 Apr 2022 14:27:48 +0500 Subject: [PATCH 3/4] update README --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 90b1dd3..231651c 100644 --- a/README.md +++ b/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 -- GitLab From 8c8e952b4fa7c50e99133829ee7b1262c8a4ce70 Mon Sep 17 00:00:00 2001 From: Laurent Velez Date: Wed, 13 Apr 2022 12:42:13 +0000 Subject: [PATCH 4/4] Delete .jenkins.sh as it uses a pipeline instead --- .jenkins.sh | 18 ------------------ 1 file changed, 18 deletions(-) delete mode 100644 .jenkins.sh diff --git a/.jenkins.sh b/.jenkins.sh deleted file mode 100644 index 74d0370..0000000 --- a/.jenkins.sh +++ /dev/null @@ -1,18 +0,0 @@ -#!/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 - -- GitLab