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

Moving from Swagger 2.0 to OpenAPI 3.0

parents 7daaee41 ec6d7b0b
description: This type represents the general information of a mobile edge service.
type: object
required:
- id
- name
- type
- protocol
- version
- endpoint
- security
properties:
id:
$ref: '#/definitions/TransportInfo.Id'
name:
$ref: '#/definitions/TransportInfo.Name'
description:
$ref: '#/definitions/TransportInfo.Description'
type:
$ref: '#/definitions/TransportTypes'
protocol:
$ref: '#/definitions/TransportInfo.Protocol'
version:
$ref: '#/definitions/TransportInfo.Version'
endpoint:
$ref: '#/definitions/EndPointInfo'
security:
$ref: '#/definitions/SecurityInfo'
implSpecificInfo:
$ref: '#/definitions/TransportInfo.ImplSpecificInfo'
\ No newline at end of file
description: The enumeration TransportTypes represents types of transports
type: string
enum:
- REST_HTTP
- MB_TOPIC_BASED
- MB_ROUTING
- MB_PUBSUB
- RPC
- RPC_STREAMING
- WEBSOCKET
example: 'REST_HTTP'
\ No newline at end of file
description: Destination address of the tunnel
type: string
example: '?'
\ No newline at end of file
description: Source address of the tunnel
type: string
example: '?'
\ No newline at end of file
description: This type represents the tunnel information.
type: string
enum:
- GTP_U
- GRE
example: 'GTP_U'
\ No newline at end of file
description: This type represents the tunnel information.
type: object
required:
- tunnelType
properties:
tunnelType:
$ref: '#/definitions/TunnelInfo.TunnelType'
tunnelDstAddress:
$ref: '#/definitions/TunnelInfo.TunnelDstAddress'
tunnelSrcAddress:
$ref: '#/definitions/TunnelInfo.TunnelSrcAddress'
\ No newline at end of file
AppTerminationNotification.MaxGracefulTimeout:
$ref: ./AppTerminationNotification.MaxGracefulTimeout.yaml
AppTerminationNotification.NotificationType:
$ref: ./AppTerminationNotification.NotificationType.yaml
AppTerminationNotification:
$ref: ./AppTerminationNotification.yaml
AppTerminationNotificationSubscription.AppInstanceId:
$ref: ./AppTerminationNotificationSubscription.AppInstanceId.yaml
AppTerminationNotificationSubscription.CallbackReference:
$ref: ./AppTerminationNotificationSubscription.CallbackReference.yaml
AppTerminationNotificationSubscription:
$ref: ./AppTerminationNotificationSubscription.yaml
AppTerminationNotificationSubscription.SubscriptionType:
$ref: ./AppTerminationNotificationSubscription.SubscriptionType.yaml
CategoryRef.Href:
$ref: ./CategoryRef.Href.yaml
CategoryRef.Id:
$ref: ./CategoryRef.Id.yaml
CategoryRef.Name:
$ref: ./CategoryRef.Name.yaml
CategoryRef.Version:
$ref: ./CategoryRef.Version.yaml
CategoryRef:
$ref: ./CategoryRef.yaml
CurrentTime:
$ref: ./CurrentTime.yaml
DestinationInterface.InterfaceType:
$ref: ./DestinationInterface.InterfaceType.yaml
DestinationInterface.IpAddress:
$ref: ./DestinationInterface.IpAddress.yaml
DestinationInterface.MacAddress:
$ref: ./DestinationInterface.MacAddress.yaml
DestinationInterface:
$ref: ./DestinationInterface.yaml
DnsRule.DomainName:
$ref: ./DnsRule.DomainName.yaml
DnsRule.Id:
$ref: ./DnsRule.Id.yaml
DnsRule.IpAddress:
$ref: ./DnsRule.IpAddress.yaml
DnsRule.IpAddressType:
$ref: ./DnsRule.IpAddressType.yaml
DnsRule.State:
$ref: ./DnsRule.State.yaml
DnsRule.Ttl:
$ref: ./DnsRule.Ttl.yaml
DnsRule:
$ref: ./DnsRule.yaml
EndPointInfo.Address.Host:
$ref: ./EndPointInfo.Address.Host.yaml
EndPointInfo.Address.Port:
$ref: ./EndPointInfo.Address.Port.yaml
EndPointInfo.Address:
$ref: ./EndPointInfo.Address.yaml
EndPointInfo.Addresses:
$ref: ./EndPointInfo.Addresses.yaml
EndPointInfo.Alternative:
$ref: ./EndPointInfo.Alternative.yaml
EndPointInfo.Uri:
$ref: ./EndPointInfo.Uri.yaml
EndPointInfo.Uris:
$ref: ./EndPointInfo.Uris.yaml
EndPointInfo:
$ref: ./EndPointInfo.yaml
LinkType:
$ref: ./LinkType.yaml
Mp1SubscriptionLinkList.Links:
$ref: ./Mp1SubscriptionLinkList.Links.yaml
Mp1SubscriptionLinkList.Subscription:
$ref: ./Mp1SubscriptionLinkList.Subscription.yaml
Mp1SubscriptionLinkList:
$ref: ./Mp1SubscriptionLinkList.yaml
ProblemDetails:
$ref: ./ProblemDetails.yaml
Problem.detail:
$ref: ./Problem.detail.yaml
Problem.instance:
$ref: ./Problem.instance.yaml
Problem.status:
$ref: ./Problem.status.yaml
Problem.title:
$ref: ./Problem.title.yaml
Problem.type:
$ref: ./Problem.type.yaml
SecurityInfo.OAuth2Info.GrantTypes:
$ref: ./SecurityInfo.OAuth2Info.GrantTypes.yaml
SecurityInfo.OAuth2Info.TokenEndpoint:
$ref: ./SecurityInfo.OAuth2Info.TokenEndpoint.yaml
SecurityInfo.OAuth2Info:
$ref: ./SecurityInfo.OAuth2Info.yaml
SecurityInfo:
$ref: ./SecurityInfo.yaml
Self:
$ref: ./Self.yaml
SerAvailabilityNotificationSubscription.CallbackReference:
$ref: ./SerAvailabilityNotificationSubscription.CallbackReference.yaml
SerAvailabilityNotificationSubscription:
$ref: ./SerAvailabilityNotificationSubscription.yaml
SerAvailabilityNotificationSubscription.SubscriptionType:
$ref: ./SerAvailabilityNotificationSubscription.SubscriptionType.yaml
SerializerTypes:
$ref: ./SerializerTypes.yaml
ServiceInfo.SerInstanceId:
$ref: ./ServiceInfo.SerInstanceId.yaml
ServiceInfo.SerName:
$ref: ./ServiceInfo.SerName.yaml
ServiceInfo.State:
$ref: ./ServiceInfo.State.yaml
ServiceInfo.TransportId:
$ref: ./ServiceInfo.TransportId.yaml
ServiceInfo.Version:
$ref: ./ServiceInfo.Version.yaml
ServiceInfo:
$ref: ./ServiceInfo.yaml
Subscription:
$ref: ./Subscription.yaml
TimingCaps.NtpServers.AuthenticationKeyNum:
$ref: ./TimingCaps.NtpServers.AuthenticationKeyNum.yaml
TimingCaps.NtpServers.AuthenticationOption:
$ref: ./TimingCaps.NtpServers.AuthenticationOption.yaml
TimingCaps.NtpServers.DelayReqMaxRate:
$ref: ./TimingCaps.NtpServers.DelayReqMaxRate.yaml
TimingCaps.NtpServers.LocalPriority:
$ref: ./TimingCaps.NtpServers.LocalPriority.yaml
TimingCaps.NtpServers.MaxPollingInterval:
$ref: ./TimingCaps.NtpServers.MaxPollingInterval.yaml
TimingCaps.NtpServers.MinPollingInterval:
$ref: ./TimingCaps.NtpServers.MinPollingInterval.yaml
TimingCaps.NtpServers.NtpServerAddr:
$ref: ./TimingCaps.NtpServers.NtpServerAddr.yaml
TimingCaps.NtpServers.NtpServerAddrType:
$ref: ./TimingCaps.NtpServers.NtpServerAddrType.yaml
TimingCaps.NtpServers.PtpMasterIpAddress:
$ref: ./TimingCaps.NtpServers.PtpMasterIpAddress.yaml
TimingCaps.NtpServers.PtpMasterLocalPriority:
$ref: ./TimingCaps.NtpServers.PtpMasterLocalPriority.yaml
TimingCaps.NtpServers:
$ref: ./TimingCaps.NtpServers.yaml
TimingCaps.PtpMasters:
$ref: ./TimingCaps.PtpMasters.yaml
TimingCaps.TimeStamp:
$ref: ./TimingCaps.TimeStamp.yaml
TimingCaps:
$ref: ./TimingCaps.yaml
TrafficFilter.Address:
$ref: ./TrafficFilter.Address.yaml
TrafficFilter.DSCP:
$ref: ./TrafficFilter.DSCP.yaml
TrafficFilter.Port:
$ref: ./TrafficFilter.Port.yaml
TrafficFilter.Protocol:
$ref: ./TrafficFilter.Protocol.yaml
TrafficFilter.QCI:
$ref: ./TrafficFilter.QCI.yaml
TrafficFilter.TC:
$ref: ./TrafficFilter.TC.yaml
TrafficFilter.Token:
$ref: ./TrafficFilter.Token.yaml
TrafficFilter.TunnelAddress:
$ref: ./TrafficFilter.TunnelAddress.yaml
TrafficFilter.TunnelPort:
$ref: ./TrafficFilter.TunnelPort.yaml
TrafficFilter:
$ref: ./TrafficFilter.yaml
TrafficRule.Action:
$ref: ./TrafficRule.Action.yaml
TrafficRule.FilterType:
$ref: ./TrafficRule.FilterType.yaml
TrafficRule.Id:
$ref: ./TrafficRule.Id.yaml
TrafficRule.Priority:
$ref: ./TrafficRule.Priority.yaml
TrafficRule.State:
$ref: ./TrafficRule.State.yaml
TrafficRule:
$ref: ./TrafficRule.yaml
TransportInfo.Description:
$ref: ./TransportInfo.Description.yaml
TransportInfo.Id:
$ref: ./TransportInfo.Id.yaml
TransportInfo.ImplSpecificInfo:
$ref: ./TransportInfo.ImplSpecificInfo.yaml
TransportInfo.Name:
$ref: ./TransportInfo.Name.yaml
TransportInfo.Protocol:
$ref: ./TransportInfo.Protocol.yaml
TransportInfo.Version:
$ref: ./TransportInfo.Version.yaml
TransportInfo:
$ref: ./TransportInfo.yaml
TransportTypes:
$ref: ./TransportTypes.yaml
TunnelInfo.TunnelDstAddress:
$ref: ./TunnelInfo.TunnelDstAddress.yaml
TunnelInfo.TunnelSrcAddress:
$ref: ./TunnelInfo.TunnelSrcAddress.yaml
TunnelInfo.TunnelType:
$ref: ./TunnelInfo.TunnelType.yaml
TunnelInfo:
$ref: ./TunnelInfo.yaml
{
"DnsRule": {
"dnsRuleId": "DnsRule1",
"domainName": "www.example.com",
"ipAddressType": "IP_V4",
"ipAddress": "146.241.7.3",
"ttl": 300,
"state": "ACTIVE"
}
}
\ No newline at end of file
DnsRule:
dnsRuleId: 'DnsRule1'
domainName: 'www.example.com'
ipAddressType: 'IP_V4'
ipAddress: '146.241.7.3'
ttl: 300
state: 'ACTIVE'
{
"ServiceInfo": {
"serInstanceId": "ServiceInstance123",
"serName": "ExampleService",
"serCategory": {
"href": "catItem1",
"id": "id12345",
"name": "RNI",
"version": "version1"
},
"version": "ServiceVersion1",
"state": "ACTIVE",
"transportId": "Rest1",
"transportInfo": {
"id": "TransId12345",
"name": "REST",
"description": "REST API",
"type": "REST_HTTP",
"protocol": "HTTP",
"version": "2.0",
"endpoint": {
"uris": [
"/meMp1/service/EntryPoint"
],
"addresses": [
{
"host": "192.0.2.0",
"port": 8080
}
]
},
"security": {
"oAuth2Info": {
"grantTypes": "OAUTH2_CLIENT_CREDENTIALS",
"tokenEndpoint": "/meMp1/security/TokenEndPoint"
}
}
},
"serializer": "JSON"
}
}
\ No newline at end of file
ServiceInfo:
serInstanceId: 'ServiceInstance123'
serName: 'ExampleService'
serCategory:
href: 'catItem1'
id: 'id12345'
name: 'RNI'
version: 'version1'
version: 'ServiceVersion1'
state: 'ACTIVE'
transportId: 'Rest1'
transportInfo:
id: 'TransId12345'
name: 'REST'
description: 'REST API'
type: 'REST_HTTP'
protocol: HTTP
version: '2.0'
endpoint:
uris:
- '/meMp1/service/EntryPoint'
addresses:
- host: '192.0.2.0'
port: 8080
security:
oAuth2Info:
grantTypes: 'OAUTH2_CLIENT_CREDENTIALS'
tokenEndpoint: '/meMp1/security/TokenEndPoint'
serializer: 'JSON'
{
"TrafficRule": {
"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"
},
"state": "ACTIVE"
}
}
\ No newline at end of file
TrafficRule:
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'
state: 'ACTIVE'
\ No newline at end of file
description: ETSI GS MEC011 Application Enablement API, V1.1.1
url: "http://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/01.01.01_60/gs_mec011v010101p.pdf"
\ No newline at end of file
title: 'Mp1 API'
version: '1.1.1'
description: 'The ETSI MEC ISG MEC011 Application Enablement API described using OpenAPI'
license:
name: ETSI Forge copyright notice
url: 'https://forge.etsi.org/etsi-forge-copyright-notice.txt'
\ No newline at end of file
name: AppTerminationNotificationSubscription
description: Entity body in the request contains a subscription to the mobile edge application termination notifications that is to be created.
in: body
required: true
schema:
$ref: '#/definitions/AppTerminationNotificationSubscription'
\ No newline at end of file
name: DnsRule
description: The updated state is included in the entity body of the request.
in: body
required: true
schema:
$ref: '#/definitions/DnsRule'
\ No newline at end of file
name: SerAvailabilityNotificationSubscription
description: Entity body in the request contains a subscription to the mobile edge service availability notifications that is to be created.
in: body
required: true
schema:
$ref: '#/definitions/SerAvailabilityNotificationSubscription'
\ No newline at end of file
name: ServiceInfo
description: New ServiceInfo with updated "state" is included as entity body of the request
in: body
required: true
schema:
$ref: '#/definitions/ServiceInfo'
\ No newline at end of file
name: TrafficRule
description: One or more updated attributes that are allowed to be changed
in: body
required: true
schema:
$ref: '#/definitions/TrafficRule'
\ No newline at end of file
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