Skip to content

GitLab

Commit c6f4aa4f authored by piscione's avatar piscione Committed by Elian Kraja
Browse files

Updated MEC029 OAS3.1 specification from V2.1.1 to V2.2.1

parent 55dee63e
Hide whitespace changes
Inline Side-by-side
Showing with 2592 additions and 2641 deletions
MEC029_FAI.json
View file @ c6f4aa4f
{
"openapi": "3.1.0",
"info": {
"title": "ETSI GS MEC 029 Fixed Access Information API",
"version": "2.1.1",
"description": "ETSI GS MEC 029 Fixed Access Information API described using OpenAPI.",
"license": {
"name": "BSD-3-Clause",
"url": "https://forge.etsi.org/legal-matters"
},
"contact": {
"name": "ETSI Forge",
"email": "cti_support@etsi.org",
"url": "https://forge.etsi.org/rep/mec/gs029-fai-api"
}
"openapi": "3.1.0",
"info": {
"title": "ETSI GS MEC 029 Fixed Access Information API",
"version": "2.2.1",
"description": "ETSI GS MEC 029 Fixed Access Information API described using OpenAPI.",
"license": {
"name": "BSD-3-Clause",
"url": "https://forge.etsi.org/legal-matters"
},
"externalDocs": {
"description": "ETSI GS MEC 029 Fixed Access Information API, v2.1.1",
"url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/029/02.01.01_60/gs_mec029v020101p.pdf"
"contact": {
"name": "ETSI Forge",
"email": "cti_support@etsi.org",
"url": "https://forge.etsi.org/rep/mec/gs029-fai-api"
}
},
"externalDocs": {
"description": "ETSI GS MEC 029 Fixed Access Information API, v2.2.1",
"url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/029/02.02.01_60/gs_mec029v020201p.pdf"
},
"servers": [
{
"url": "https://localhost/fai/v1"
}
],
"tags": [
{
"name": "Queries"
},
"servers": [
{
"url": "https://localhost/fai/v1"
}
],
"tags": [
{
"name": "Queries"
},
{
"name": "Subscription"
}
],
"paths": {
"/queries/fa_info": {
"get": {
"tags": [
"Queries"
],
"summary": "Retrieve information on the available fixed access networks.",
"description": "Retrieve information on the available fixed access networks.",
"operationId": "fa_infoGET",
"parameters": [
{
"in": "query",
"name": "customerPremisesInfo",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CpInfo"
}
},
"required": false,
"description": "Comma separated list of customer premises information"
},
{
"in": "query",
"name": "lastMileTech",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"required": false,
"description": "Comma separated list of last mile technologies."
},
{
"in": "query",
"name": "interfaceType",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Comma separated list of interface types."
},
{
"in": "query",
"name": "dsbw",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"required": false,
"description": "Comma separated list of the bandwidth (in Mbps) from the network towards the customer site."
},
{
"in": "query",
"name": "usbw",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"required": false,
"description": "Comma separated list of the bandwidth (in Mbps) from the customer site towards the network."
},
{
"in": "query",
"name": "latency",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"required": false,
"description": "Comma separated list of the maximum baseline latency (in ms) between customer site and service edge node."
}
],
"responses": {
"200": {
"description": "A response body containing the FAI is returned. ",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FaInfo"
}
}
{
"name": "Subscription"
},
{
"name": "Cable line info"
},
{
"name": "Optical network info"
}
],
"paths": {
"/queries/fa_info": {
"get": {
"tags": [
"Queries"
],
"summary": "Retrieve information on the available fixed access networks.",
"description": "Retrieve information on the available fixed access networks.",
"operationId": "fa_infoGET",
"parameters": [
{
"in": "query",
"name": "customerPremisesInfo",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CpInfo"
}
},
"400": {
"$ref": "#/components/responses/400"
"required": false,
"description": "Comma separated list of customer premises information"
},
{
"in": "query",
"name": "lastMileTech",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"401": {
"$ref": "#/components/responses/401"
"required": false,
"description": "Comma separated list of last mile technologies."
},
{
"in": "query",
"name": "interfaceType",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"403": {
"$ref": "#/components/responses/403"
"description": "Comma separated list of interface types."
},
{
"in": "query",
"name": "dsbw",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"404": {
"$ref": "#/components/responses/404"
"required": false,
"description": "Comma separated list of the bandwidth (in Mbps) from the network towards the customer site."
},
{
"in": "query",
"name": "usbw",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"406": {
"$ref": "#/components/responses/406"
"required": false,
"description": "Comma separated list of the bandwidth (in Mbps) from the customer site towards the network."
},
{
"in": "query",
"name": "latency",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"429": {
"$ref": "#/components/responses/429"
}
"required": false,
"description": "Comma separated list of the maximum baseline latency (in ms) between customer site and service edge node."
}
}
},
"/queries/device_info": {
"get": {
"tags": [
"Queries"
],
"summary": "retrieve information on the devices that are connected to a fixed access network.",
"description": "retrieve information on the devices that are connected to a fixed access network.",
"operationId": "device_infoGET",
"parameters": [
{
"in": "query",
"name": "gwId",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"required": false,
"description": "Comma separated list of gateway identifier"
},
{
"in": "query",
"name": "deviceId",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"required": false,
"description": "Comma separated list of device identifier."
},
{
"in": "query",
"name": "deviceStatus",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Comma separated list of device status."
}
],
"responses": {
"200": {
"description": "A response body containing the device information is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceInfo"
],
"responses": {
"200": {
"description": "A response body containing the FAI is returned. ",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FaInfo"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
}
}
},
"/queries/cable_line_info": {
"get": {
"tags": [
"Cable line info"
],
"summary": "It Queries information about the cable line of a fixed access network.",
"description": "It Queries information about the cable line of a fixed access network.",
"operationId": "cable_line_infoGET",
"parameters": [
{
"in": "query",
"name": "customerPremisesInfo",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CpInfo"
}
},
"required": false,
"description": "Comma separated list of customer premises information"
},
{
"in": "query",
"name": "cmId",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"required": false,
"description": "Comma separated list of Cable Modem identifiers."
}
],
"responses": {
"200": {
"description": "A response body containing the cable line information is returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CableLineInfo"
}
}
}
},
"/queries/device_info": {
"get": {
"tags": [
"Queries"
],
"summary": "retrieve information on the devices that are connected to a fixed access network.",
"description": "retrieve information on the devices that are connected to a fixed access network.",
"operationId": "device_infoGET",
"parameters": [
{
"in": "query",
"name": "gwId",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
"required": false,
"description": "Comma separated list of gateway identifier"
},
{
"in": "query",
"name": "deviceId",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"406": {
"$ref": "#/components/responses/406"
"required": false,
"description": "Comma separated list of device identifier."
},
{
"in": "query",
"name": "deviceStatus",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"429": {
"$ref": "#/components/responses/429"
}
"description": "Comma separated list of device status."
}
}
},
"/queries/optical_network_info": {
"get": {
"tags": [
"Optical network info"
],
"summary": "used to query information about the optical network.",
"description": "used to query information about the optical network.",
"operationId": "optical_network_infoGET",
"parameters": [
{
"in": "query",
"name": "customerPremisesInfo",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CpInfo"
}
},
"required": false,
"description": "Comma separated list of customer premises information"
},
{
"in": "query",
"name": "ponYS_ID",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"required": false,
"description": "Comma separated list of optical system identifiers."
},
{
"in": "query",
"name": "onuId",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"required": false,
"description": "Comma separated list of optical network unit identifiers."
}
],
"responses": {
"200": {
"description": "A response body containing the optical network information is returned.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PonInfo"
}
],
"responses": {
"200": {
"description": "Upon success, a response body containing the information of zero or more devices is returned.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceInfo"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
}
}
},
"/subscriptions": {
"get": {
"tags": [
"Subscription"
],
"summary": "request information about the subscriptions for this requestor.",
"description": "request information about the subscriptions for this requestor.",
"operationId": "subGET",
"parameters": [
{
"in": "query",
"name": "subscription_type",
"schema": {
"type": "string"
},
"required": false,
"description": "Query parameter to filter on a specific subscription type. Permitted values: ONU_ALARM. DEVICE_ABNORMAL_ALERT. CM_CONNECTIVITY_STATE. ANI_ALARM."
}
],
"responses": {
"200": {
"description": "A response body containing the list of links to requestor subscriptions is returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionLinkList"
}
}
}
},
"/queries/cable_line_info": {
"get": {
"tags": [
"Cable line info"
],
"summary": "It Queries information about the cable line of a fixed access network.",
"description": "It Queries information about the cable line of a fixed access network.",
"operationId": "cable_line_infoGET",
"parameters": [
{
"in": "query",
"name": "customerPremisesInfo",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CpInfo"
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {