Commit 7e21cc6e authored by Walter Featherstone's avatar Walter Featherstone
Browse files

Moving from Swagger 2.0 to OpenAPI 3.0

parents 7daaee41 ec6d7b0b
This diff is collapsed.
################################################################################
# Open API specification version #
################################################################################
swagger: '2.0'
################################################################################
# Document Information #
################################################################################
info:
$ref: './info/index.yaml'
################################################################################
# External Documents #
################################################################################
externalDocs:
$ref: './externalDocs/index.yaml'
host: 127.0.0.1:8081
basePath: /exampleAPI/mp1/v1/
schemes:
- http
- https
consumes:
- application/json
produces:
- application/json
################################################################################
# Parameters #
################################################################################
parameters:
$ref: ./parameters/index.yaml
################################################################################
# paths #
################################################################################
paths:
$ref: './paths/index.yaml'
################################################################################
# Definitions #
################################################################################
definitions:
$ref: './definitions/index.yaml'
\ No newline at end of file
This diff is collapsed.
# Multi-access Edge Computing (MEC); MEC Platform Application Enablement API
# Multi-access Edge Computing Platform Application Enablement API
This repository contains OpenAPIs descriptions for the interfaces specified in ETSI GS MEC 011.
## Online resources
* [Specification document](https://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/01.01.01_60/gs_mec011v010101p.pdf)
* [Navigate the API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/gitlab/mec/gs011-app-enablement-api/raw/master/Mp1.yaml).
* [Edit the API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/gitlab/mec/gs011-app-enablement-api/raw/master/Mp1.yaml).
* [Navigate the API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/gitlab/mec/gs011-app-enablement-api/raw/develop/Mp1.yaml).
* [Edit the API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/gitlab/mec/gs011-app-enablement-api/raw/develop/Mp1.yaml).
......
description: Maximum timeout value in seconds for graceful termination or graceful stop of an application instance.
type: string
format: uint32
example: '10'
\ No newline at end of file
description: Shall be set to AppTerminationNotification.
type: string
example: 'AppTerminationNotification'
\ No newline at end of file
description: This type represents the information that the mobile edge platform notifies the subscribed application instance about the corresponding application instance termination/stop.
type: object
required:
- notificationType
- maxGracefulTimeout
- _links
properties:
notificationType:
$ref: '#/definitions/AppTerminationNotification.NotificationType'
maxGracefulTimeout:
$ref: '#/definitions/AppTerminationNotification.MaxGracefulTimeout'
_links:
$ref: '#/definitions/Subscription'
\ No newline at end of file
description: It is used as the filtering criterion for the subscribed events.
type: string
example: 'ID1'
\ No newline at end of file
description: URI selected by the mobile edge application instance to receive notifications on the subscribed mobile edge application instance management information. This shall be included in both the request and the response.
type: string
format: uri
\ No newline at end of file
description: Shall be set to AppTerminationNotificationSubscription.
type: string
example: 'AppTerminationNotificationSubscription'
\ No newline at end of file
description: This type represents the information that the mobile edge platform notifies the subscribed application instance about the corresponding application instance termination/stop.
type: object
required:
- subscriptionType
- callbackReference
- _links
- appInstanceId
properties:
subscriptionType:
$ref: '#/definitions/AppTerminationNotificationSubscription.SubscriptionType'
callbackReference:
$ref: '#/definitions/AppTerminationNotificationSubscription.CallbackReference'
_links:
$ref: '#/definitions/Self'
appInstanceId:
$ref: '#/definitions/AppTerminationNotificationSubscription.AppInstanceId'
\ No newline at end of file
description: Reference of the catalogue
type: string
example: 'catItem1'
\ No newline at end of file
description: Unique identifier of the category
type: string
example: 'id12345'
\ No newline at end of file
description: Name of the category
type: string
example: 'RNI'
\ No newline at end of file
description: Category version
type: string
example: 'version1'
\ No newline at end of file
description: This type represents the category reference
type: object
required:
- href
- id
- name
- version
properties:
href:
$ref: '#/definitions/CategoryRef.Href'
id:
$ref: '#/definitions/CategoryRef.Id'
name:
$ref: '#/definitions/CategoryRef.Name'
version:
$ref: '#/definitions/CategoryRef.Version'
\ No newline at end of file
description: This type represents the information provided by the mobile edge platform in response to the Get Platform Time Request message.
type: object
required:
- nanoSeconds
- seconds
- timeSourceStatus
properties:
seconds:
type: integer
format: uint32
description: >-
The seconds part of the time. Time is defined as Unix-time since
January 1, 1970, 00:00:00 UTC
example: 1577836800
nanoSeconds:
type: integer
format: uint32
description: >-
The nanoseconds part of the time. Time is defined as Unix-time since
January 1, 1970, 00:00:00 UTC
example: 0
timeSourceStatus:
type: string
enum:
- TRACEABLE
- NONTRACEABLE
description: Platform Time Source status. 1 = TRACEABLE - time source is locked to the UTC time source. 2 = NONTRACEABLE - time source is not locked to the UTC time source
example: 'TRACEABLE'
\ No newline at end of file
description: Type of the interface
type: string
enum:
- TUNNEL
- MAC
- IP
example: 'TUNNEL'
\ No newline at end of file
description: IP address of the remote destination
type: string
example: '192.0.2.0'
\ No newline at end of file
This diff is collapsed.
Markdown is supported
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