Commit 869ccfa7 authored by Elian Kraja's avatar Elian Kraja
Browse files

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

Update editor and validation tools

See merge request !16
parents 2a7ff233 c58571e5
Pipeline #11217 failed with stage
in 0 seconds
#!/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 validation returns $fres."
exit $fres
\ No newline at end of file
This diff is collapsed.
......@@ -30,6 +30,7 @@ paths:
get:
tags:
- appTrafficRules
summary: 'get traffic rules'
description: This method retrieves information about all the traffic rules associated with a MEC application instance.
operationId: ApplicationsTrafficRules_GET
parameters:
......@@ -132,7 +133,7 @@ paths:
get:
tags:
- appTrafficRules
summary: 'Get traffic rule'
description: This method retrieves information about all the traffic rules associated with a MEC application instance.
operationId: ApplicationsTrafficRule_GET
parameters:
......@@ -214,7 +215,7 @@ paths:
put:
tags:
- appTrafficRules
summary: 'Update traffic rule'
description: This method retrieves information about all the traffic rules associated with a MEC application instance.
operationId: ApplicationsTrafficRule_PUT
parameters:
......@@ -317,6 +318,7 @@ paths:
get:
tags:
- appDnsRules
summary: 'Get DNS rules'
description: This method retrieves information about all the DNS rules associated with a MEC application instance.
operationId: ApplicationsDnsRules_GET
parameters:
......@@ -404,6 +406,7 @@ paths:
get:
tags:
- appDnsRules
summary: 'Get DNS rule'
description: This method retrieves information about a DNS rule associated with a MEC application instance.
operationId: ApplicationsDnsRule_GET
parameters:
......@@ -473,6 +476,7 @@ paths:
put:
tags:
- appDnsRules
summary: 'Update DNS rule'
description: This method activates, de-activates or updates a traffic rule.
operationId: ApplicationsDnsRule_PUT
parameters:
......@@ -563,6 +567,7 @@ paths:
get:
tags:
- appSubscriptions
summary: 'Get subscriptions'
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
parameters:
......@@ -616,6 +621,7 @@ paths:
post:
tags:
- appSubscriptions
summary: 'Create subscription'
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
parameters:
......@@ -692,6 +698,7 @@ paths:
operationId: AppTerminationNotification_POST
tags:
- callbacks
summary: 'Create callback'
requestBody:
$ref: '#/components/requestBodies/AppTerminationNotification'
responses:
......@@ -702,7 +709,7 @@ paths:
get:
tags:
- appSubscriptions
summary: 'Get subscription'
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
parameters:
......@@ -763,7 +770,7 @@ paths:
delete:
tags:
- appSubscriptions
summary: 'delete subscription'
description: This method deletes a mecAppSuptApiSubscription. This method is typically used in "Unsubscribing from service availability event notifications" procedure.
operationId: ApplicationsSubscription_DELETE
parameters:
......@@ -811,7 +818,7 @@ paths:
post:
tags:
- appConfirmTermination
summary: 'Confirm termination'
description: This method is used to confirm the application level termination of an application instance.
operationId: ApplicationsConfirmTermination_POST
parameters:
......@@ -895,7 +902,7 @@ paths:
post:
tags:
- appConfirmReady
summary: 'Confirm ready'
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
parameters:
......@@ -979,7 +986,7 @@ paths:
get:
tags:
- timing
summary: 'Retrieve timing capabilities'
description: This method retrieves the information of the platform's timing capabilities which corresponds to the timing capabilities query
operationId: TimingCaps_GET
parameters: []
......@@ -1028,7 +1035,7 @@ paths:
get:
tags:
- timing
summary: 'Retrieve current time'
description: This method retrieves the information of the platform's current time which corresponds to the get platform time procedure
operationId: TimingCurrentTime_GET
parameters: []
......
This diff is collapsed.
......@@ -30,7 +30,7 @@ paths:
get:
tags:
- appSubscriptions
summary: "Get subscriptions"
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
parameters:
......@@ -84,7 +84,7 @@ paths:
post:
tags:
- appSubscriptions
summary: "Create subscription"
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
parameters:
......@@ -168,6 +168,7 @@ paths:
applications that are subscribed to the corresponding
service availability notifications about the service availability changes.'
operationId: ServiceAvailabilityNotification_POST
summary: "Create callback"
tags:
- callbacks
requestBody:
......@@ -180,7 +181,7 @@ paths:
get:
tags:
- appSubscriptions
summary: "Get subscription"
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
parameters:
......@@ -241,7 +242,7 @@ paths:
delete:
tags:
- appSubscriptions
summary: delete subscription
description: This method deletes a mecSrvMgmtSubscription. This method is typically used in "Unsubscribing from service availability event notifications" procedure.
operationId: ApplicationsSubscription_DELETE
parameters:
......@@ -289,6 +290,7 @@ paths:
get:
tags:
- appServices
summary: get services
description: This method retrieves information about a list of mecService resources. This method is typically used in "service availability query" procedure
operationId: AppServices_GET
parameters:
......@@ -460,6 +462,7 @@ paths:
post:
tags:
- appServices
summary: create service
description: This method is used to create a mecService resource. This method is typically used in "service availability update and new service registration" procedure
operationId: AppServices_POST
parameters:
......@@ -562,6 +565,7 @@ paths:
get:
tags:
- appServices
summary: get service
description: This method retrieves information about a mecService resource. This method is typically used in "service availability query" procedure
operationId: AppServicesServiceId_GET
parameters:
......@@ -650,6 +654,7 @@ paths:
put:
tags:
- appServices
summary: update service
description: This method updates the information about a mecService resource
operationId: AppServicesServiceId_PUT
parameters:
......@@ -757,6 +762,7 @@ paths:
delete:
tags:
- appServices
summary: delete service
description: 'This method deletes a mecService resource. This method is typically used in the service deregistration procedure. '
operationId: AppServicesServiceId_DELETE
parameters:
......@@ -804,7 +810,7 @@ paths:
get:
tags:
- services
summary: get services
description: This method retrieves information about a list of mecService resources. This method is typically used in "service availability query" procedure
operationId: Services_GET
parameters:
......@@ -971,7 +977,7 @@ paths:
get:
tags:
- services
summary: get service
description: This method retrieves information about a mecService resource. This method is typically used in "service availability query" procedure
operationId: ServicesServiceId_GET
parameters:
......@@ -1055,7 +1061,7 @@ paths:
get:
tags:
- transports
summary: Get transports
description: This method retrieves information about a list of available transports. This method is typically used by a service-producing application to discover transports provided by the MEC platform in the "transport information query" procedure
operationId: Transports_GET
parameters: []
......@@ -1109,6 +1115,7 @@ paths:
get:
tags:
- individualMECservice
summary: get mecServiceLiveness
description: This method retrieves information about an "Individual mecServiceLiveness" resource
operationId: get_individual_MEC_service
responses:
......@@ -1140,6 +1147,7 @@ paths:
patch:
tags:
- individualMECservice
summary: Update mecServiceLiveness
description: This method updates a resource on top of the existing resource state with partial changes described by the client.
operationId: patch_individual_MEC_service
requestBody:
......
......@@ -5,12 +5,12 @@ 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/011/02.01.01_60/gs_MEC011v020101p.pdf)
* [Navigate the MEC Application Support API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/gitlab/mec/gs011-app-enablement-api/raw/stf606-final/MecAppSupportApi.yaml).
* [Navigate the MEC Service Management API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/gitlab/mec/gs011-app-enablement-api/raw/stf606-final/MecServiceMgmtApi.yaml).
* [Edit the MEC Application Support API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/gitlab/mec/gs011-app-enablement-api/raw/stf606-final/MecAppSupportApi.yaml).
* [Edit the MEC Service Management API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/gitlab/mec/gs011-app-enablement-api/raw/stf606-final/MecServiceMgmtApi.yaml).
* [Navigate the MEC Application Support API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/gitlab/mec/gs011-app-enablement-api/raw/v2.2.1/MecAppSupportApi.yaml).
* [Navigate the MEC Service Management API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/gitlab/mec/gs011-app-enablement-api/raw/v2.2.1/MecServiceMgmtApi.yaml).
* [Edit the MEC Application Support API online](https://redocly.github.io/redoc/?url=https://forge.etsi.org/gitlab/mec/gs011-app-enablement-api/raw/v2.2.1/MecAppSupportApi.yaml).
* [Edit the MEC Service Management API online](https://redocly.github.io/redoc/?url=https://forge.etsi.org/gitlab/mec/gs011-app-enablement-api/raw/v2.2.1/MecServiceMgmtApi.yaml).
## License
Unless specified otherwise, the content of this repository and the files contained are released under the BSD-3-Clause license.
See the attached LICENSE file or visit https://forge.etsi.org/legal-matters.
\ No newline at end of file
See the attached LICENSE file or visit https://forge.etsi.org/legal-matters.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment