Commit 9d0d5921 authored by Walter Featherstone's avatar Walter Featherstone
Browse files

Merge branch 'stf606-final' into 'master'

Update OAS to version 3.1.0

See merge request !13
parents d5fd9a00 d6d42aec
Pipeline #10880 failed with stage
in 0 seconds
{
"openapi": "3.0.2",
"servers": [
{
"url": "http://127.0.0.1:8081/mec_app_support/v1"
},
{
"url": "https://127.0.0.1:8081/mec_app_support/v1"
}
],
"openapi": "3.1.0",
"info": {
"title": "MEC Application Support API",
"version": "2.1.1",
......@@ -47,1432 +39,1279 @@
"name": "callbacks"
}
],
"paths": {
"/applications/{appInstanceId}/traffic_rules": {
"parameters": [
{
"$ref": "#/components/parameters/Path.AppInstanceId"
}
],
"get": {
"description": "This method retrieves information about all the traffic rules associated with a MEC application instance.",
"operationId": "ApplicationsTrafficRules_GET",
"tags": [
"appTrafficRules"
],
"responses": {
"200": {
"$ref": "#/components/responses/ApplicationsTrafficRules.200"
},
"400": {
"$ref": "#/components/responses/Error.400"
},
"403": {
"$ref": "#/components/responses/Error.403"
},
"404": {
"$ref": "#/components/responses/Error.404"
}
}
}
},
"/applications/{appInstanceId}/traffic_rules/{trafficRuleId}": {
"parameters": [
"jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
"servers": [
{
"$ref": "#/components/parameters/Path.AppInstanceId"
"url": "http://127.0.0.1:8081/mec_app_support/v1",
"variables": {}
},
{
"$ref": "#/components/parameters/Path.TrafficRuleId"
"url": "https://127.0.0.1:8081/mec_app_support/v1",
"variables": {}
}
],
"paths": {
"/applications/{appInstanceId}/traffic_rules": {
"get": {
"description": "This method retrieves information about all the traffic rules associated with a MEC application instance.",
"operationId": "ApplicationsTrafficRule_GET",
"tags": [
"appTrafficRules"
],
"responses": {
"200": {
"$ref": "#/components/responses/ApplicationsTrafficRule.200"
},
"400": {
"$ref": "#/components/responses/Error.400"
},
"403": {
"$ref": "#/components/responses/Error.403"
},
"404": {
"$ref": "#/components/responses/Error.404"
"description": "This method retrieves information about all the traffic rules associated with a MEC application instance.",
"operationId": "ApplicationsTrafficRules_GET",
"parameters": [
{
"name": "appInstanceId",
"in": "path",
"description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
},
"put": {
"description": "This method retrieves information about all the traffic rules associated with a MEC application instance.",
"operationId": "ApplicationsTrafficRule_PUT",
"tags": [
"appTrafficRules"
],
"responses": {
"200": {
"$ref": "#/components/responses/ApplicationsTrafficRule.200"
},
"400": {
"$ref": "#/components/responses/Error.400"
},
"403": {
"$ref": "#/components/responses/Error.403"
},
"404": {
"$ref": "#/components/responses/Error.404"
},
"412": {
"$ref": "#/components/responses/Error.412"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/ApplicationsTrafficRule"
}
}
"description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
"headers": {},
"content": {
"application/json": {
"schema": {
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/TrafficRule"
},
"/applications/{appInstanceId}/dns_rules": {
"parameters": [
"description": "",
"examples": [
[
{
"$ref": "#/components/parameters/Path.AppInstanceId"
}
"trafficRuleId": "TrafficRule123",
"serName": "ExampleService",
"filterType": "FLOW",
"priority": 1,
"trafficFilter": [
{
"srcAddress": [
"192.168.2.0/24",
"192.168.3.0/24"
],
"get": {
"description": "This method retrieves information about all the DNS rules associated with a MEC application instance.",
"operationId": "ApplicationsDnsRules_GET",
"tags": [
"appDnsRules"
"dstAddress": [
"192.127.4.100/32"
],
"responses": {
"200": {
"$ref": "#/components/responses/ApplicationsDnsRules.200"
},
"400": {
"$ref": "#/components/responses/Error.400"
},
"403": {
"$ref": "#/components/responses/Error.403"
},
"404": {
"$ref": "#/components/responses/Error.404"
}
"dstPort": [
"80"
]
}
],
"action": "FORWARD_DECAPSULATED",
"dstInterface": {
"interfaceType": "IP",
"dstIpAddress": "20.1.1.1"
},
"state": "ACTIVE"
}
]
],
"contentMediaType": "application/json"
},
"/applications/{appInstanceId}/dns_rules/{dnsRuleId}": {
"parameters": [
"examples": {
"TrafficRules": {
"value": [
{
"$ref": "#/components/parameters/Path.AppInstanceId"
},
"trafficRuleId": "TrafficRule123",
"serName": "ExampleService",
"filterType": "FLOW",
"priority": 1,
"trafficFilter": [
{
"$ref": "#/components/parameters/Path.DnsRuleId"
}
"srcAddress": [
"192.168.2.0/24",
"192.168.3.0/24"
],
"get": {
"description": "This method retrieves information about a DNS rule associated with a MEC application instance.",
"operationId": "ApplicationsDnsRule_GET",
"tags": [
"appDnsRules"
"dstAddress": [
"192.127.4.100/32"
],
"responses": {
"200": {
"$ref": "#/components/responses/ApplicationsDnsRule.200"
},
"400": {
"$ref": "#/components/responses/Error.400"
},
"403": {
"$ref": "#/components/responses/Error.403"
},
"404": {
"$ref": "#/components/responses/Error.404"
}
"dstPort": [
"80"
]
}
},
"put": {
"description": "This method activates, de-activates or updates a traffic rule.",
"operationId": "ApplicationsDnsRule_PUT",
"tags": [
"appDnsRules"
],
"responses": {
"200": {
"$ref": "#/components/responses/ApplicationsDnsRule.200"
},
"400": {
"$ref": "#/components/responses/Error.400"
},
"403": {
"$ref": "#/components/responses/Error.403"
},
"404": {
"$ref": "#/components/responses/Error.404"
"action": "FORWARD_DECAPSULATED",
"dstInterface": {
"interfaceType": "IP",
"dstIpAddress": "20.1.1.1"
},
"412": {
"$ref": "#/components/responses/Error.412"
"state": "ACTIVE"
}
]
}
},
"requestBody": {
"$ref": "#/components/requestBodies/ApplicationsDnsRule"
}
}
},
"/applications/{appInstanceId}/subscriptions": {
"parameters": [
{
"$ref": "#/components/parameters/Path.AppInstanceId"
}
],
"get": {
"description": "The GET method may be used to request information about all subscriptions for this requestor. Upon success, the response contains entity body with all the subscriptions for the requestor.",
"operationId": "ApplicationsSubscriptions_GET",
"tags": [
"appSubscriptions"
],
"responses": {
"200": {
"$ref": "#/components/responses/ApplicationsSubscriptions.200"
},
"400": {
"$ref": "#/components/responses/Error.400"
},
"403": {
"$ref": "#/components/responses/Error.403"
"description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"404": {
"$ref": "#/components/responses/Error.404"
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
},
"post": {
"description": "The POST method may be used to create a new subscription. One example use case is to create a new subscription to the MEC service availability notifications. Upon success, the response contains entity body describing the created subscription.",
"operationId": "ApplicationsSubscriptions_POST",
"tags": [
"appSubscriptions"
],
"responses": {
"201": {
"$ref": "#/components/responses/ApplicationsSubscriptions.201"
},
"400": {
"$ref": "#/components/responses/Error.400"
},
"403": {
"$ref": "#/components/responses/Error.403"
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"$ref": "#/components/responses/Error.404"
"description": "Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/ApplicationsSubscriptions"
},
"callbacks": {
"appTerminationNotification": {
"$ref": "#/components/callbacks/AppTerminationNotification"
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
}
},
"/applications/{appInstanceId}/subscriptions/{subscriptionId}": {
"parameters": [
{
"$ref": "#/components/parameters/Path.AppInstanceId"
"deprecated": false
},
{
"$ref": "#/components/parameters/Path.SubscriptionId"
}
],
"parameters": []
},
"/applications/{appInstanceId}/traffic_rules/{trafficRuleId}": {
"get": {
"description": "The GET method requests information about a subscription for this requestor. Upon success, the response contains entity body with the subscription for the requestor.",
"operationId": "ApplicationsSubscription_GET",
"tags": [
"appSubscriptions"
"appTrafficRules"
],
"responses": {
"200": {
"$ref": "#/components/responses/ApplicationsSubscription.200"
},
"400": {
"$ref": "#/components/responses/Error.400"
},
"403": {
"$ref": "#/components/responses/Error.403"
},
"404": {
"$ref": "#/components/responses/Error.404"
}
"description": "This method retrieves information about all the traffic rules associated with a MEC application instance.",
"operationId": "ApplicationsTrafficRule_GET",
"parameters": [
{
"name": "appInstanceId",
"in": "path",
"description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
},
"delete": {
"description": "This method deletes a mecAppSuptApiSubscription. This method is typically used in \"Unsubscribing from service availability event notifications\" procedure.",
"operationId": "ApplicationsSubscription_DELETE",
"tags": [
"appSubscriptions"
{
"name": "trafficRuleId",
"in": "path",
"description": "Represents a traffic rule.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
"200": {
"description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TrafficRule"
},
"403": {
"$ref": "#/components/responses/Error.403"
"examples": {
"TrafficRule": {
"value": {
"trafficRuleId": "TrafficRule123",
"serName": "ExampleService",
"filterType": "FLOW",
"priority": 1,
"trafficFilter": [
{
"srcAddress": [
"192.168.2.0/24",
"192.168.3.0/24"
],
"dstAddress": [
"192.127.4.100/32"
],
"dstPort": [
"80"
]
}
],
"action": "FORWARD_DECAPSULATED",
"dstInterface": {
"interfaceType": "IP",
"dstIpAddress": "20.1.1.1"
},
"404": {
"$ref": "#/components/responses/Error.404"
"state": "ACTIVE"
}
}
}
}
}
},
"/applications/{appInstanceId}/confirm_termination": {
"parameters": [
{
"$ref": "#/components/parameters/Path.AppInstanceId"
"400": {
"description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
],
"post": {
"description": "This method is used to confirm the application level termination of an application instance.",
"operationId": "ApplicationsConfirmTermination_POST",
"tags": [
"appConfirmTermination"
],
"responses": {
"204": {
"description": "No Content"
},
"401": {
"$ref": "#/components/responses/Error.401"
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
},
"403": {
"$ref": "#/components/responses/Error.403"
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"$ref": "#/components/responses/Error.404"
},
"409": {
"$ref": "#/components/responses/Error.409"
},
"429": {
"$ref": "#/components/responses/Error.429"
"description": "Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/ApplicationsConfirmTermination"
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
}
},
"/applications/{appInstanceId}/confirm_ready": {
"deprecated": false
},
"put": {
"tags": [
"appTrafficRules"
],
"description": "This method retrieves information about all the traffic rules associated with a MEC application instance.",
"operationId": "ApplicationsTrafficRule_PUT",
"parameters": [
{
"$ref": "#/components/parameters/Path.AppInstanceId"
"name": "appInstanceId",
"in": "path",
"description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
],
"post": {
"description": "This method may be used by the MEC application instance to notify the MEC platform that it is up and running. ",
"operationId": "ApplicationsConfirmReady_POST",
"tags": [
"appConfirmReady"
],
"responses": {
"204": {
"description": "No Content"
},
"401": {
"$ref": "#/components/responses/Error.401"
},
"403": {
"$ref": "#/components/responses/Error.403"
},
"404": {
"$ref": "#/components/responses/Error.404"
},
"409": {
"$ref": "#/components/responses/Error.409"
},
"429": {
"$ref": "#/components/responses/Error.429"
{
"name": "trafficRuleId",
"in": "path",
"description": "Represents a traffic rule.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
},
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ApplicationsConfirmReady"
"description": "One or more updated attributes that are allowed to be changed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TrafficRule"
}
}
},
"/timing/timing_caps": {
"get": {
"description": "This method retrieves the information of the platform's timing capabilities which corresponds to the timing capabilities query",
"operationId": "TimingCaps_GET",