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

Moving from Swagger 2.0 to OpenAPI 3.0

parents 7daaee41 ec6d7b0b
parameters:
- $ref: '#/parameters/Path.AppInstanceId'
get:
$ref: ./ApplicationsSubscriptions.GET.yaml
post:
$ref: ./ApplicationsSubscriptions.POST.yaml
\ No newline at end of file
description: This method retrieves information about all the traffic rules associated with a mobile edge application instance.
operationId: ApplicationsTrafficRule_GET
produces:
- application/json
responses:
200:
description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
schema:
type: object
properties:
TrafficRule:
$ref: '#/definitions/TrafficRule'
examples:
application/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'
400:
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
403:
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
404:
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
\ No newline at end of file
description: This method retrieves information about all the traffic rules associated with a mobile edge application instance.
operationId: ApplicationsTrafficRules_PUT
produces:
- application/json
parameters:
- $ref: '#/parameters/Body.TrafficRule'
responses:
200:
description: Upon success, a response body containing data type describing the updated TrafficRule is returned.
schema:
type: object
properties:
TrafficRule:
$ref: '#/definitions/TrafficRule'
examples:
application/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'
400:
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
403:
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
404:
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
412:
description: Precondition Failed
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
\ No newline at end of file
parameters:
- $ref: '#/parameters/Path.AppInstanceId'
- $ref: '#/parameters/Path.TrafficRuleId'
get:
$ref: ./ApplicationsTrafficRule.GET.yaml
put:
$ref: ./ApplicationsTrafficRule.PUT.yaml
\ No newline at end of file
description: This method retrieves information about all the traffic rules associated with a mobile edge application instance.
operationId: ApplicationsTrafficRules_GET
produces:
- application/json
responses:
200:
description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
schema:
type: array
items:
type: object
properties:
TrafficRule:
$ref: '#/definitions/TrafficRule'
examples:
application/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'
400:
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
403:
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
404:
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
\ No newline at end of file
parameters:
- $ref: '#/parameters/Path.AppInstanceId'
get:
$ref: ./ApplicationsTrafficRules.GET.yaml
\ No newline at end of file
description: This method retrieves information about a list of meService resources. This method is typically used in "service availability query" procedure
operationId: Services_GET
produces:
- application/json
parameters:
- $ref: '#/parameters/Query.Ser_instance_id'
- $ref: '#/parameters/Query.Ser_name'
- $ref: '#/parameters/Query.Ser_category_id'
responses:
200:
description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
schema:
type: array
items:
type: object
properties:
ServiceInfo:
$ref: '#/definitions/ServiceInfo'
examples:
application/json:
- 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'
400:
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
403:
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
404:
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
\ No newline at end of file
description: This method is used to create a meService resource. This method is typically used in "service availability update and new service registration" procedure
operationId: Services_POST
produces:
- application/json
parameters:
- $ref: '#/parameters/Body.ServiceInfo'
responses:
201:
description: Upon success, the HTTP response shall include a Location HTTP header that contains the resource URI of the created resource.
headers:
location:
description: The resource URI of the created resource
type: string
format: uri
schema:
type: object
properties:
ServiceInfo:
$ref: '#/definitions/ServiceInfo'
examples:
application/json:
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'
400:
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
403:
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
404:
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
\ No newline at end of file
get:
$ref: ./Services.GET.yaml
post:
$ref: ./Services.POST.yaml
\ No newline at end of file
description: This method retrieves information about a meService resource. This method is typically used in "service availability query" procedure
operationId: ServicesServiceId_GET
produces:
- application/json
responses:
200:
description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
schema:
type: object
properties:
ServiceInfo:
$ref: '#/definitions/ServiceInfo'
examples:
application/json:
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'
400:
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
403:
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
404:
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
\ No newline at end of file
description: This method updates the information about a meService resource
operationId: ServicesServiceId_PUT
produces:
- application/json
parameters:
- $ref: '#/parameters/Body.ServiceInfo'
responses:
200:
description: Upon success, a response body containing data type describing the updated ServiceInfo is returned
schema:
type: object
properties:
ServiceInfo:
$ref: '#/definitions/ServiceInfo'
examples:
application/json:
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'
400:
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
403:
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
404:
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
412:
description: Precondition Failed
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
\ No newline at end of file
parameters:
- $ref: '#/parameters/Path.ServiceId'
get:
$ref: ./ServicesServiceId.GET.yaml
put:
$ref: ./ServicesServiceId.PUT.yaml
\ No newline at end of file
description: This method retrieves the information of the platform's timing capabilities which corresponds to the timing capabilities query
operationId: TimingCaps_GET
produces:
- application/json
responses:
200:
description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
schema:
type: object
properties:
TimingCaps:
$ref: '#/definitions/TimingCaps'
400:
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
403:
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
404:
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
\ No newline at end of file
get:
$ref: ./TimingCaps.GET.yaml
\ No newline at end of file
description: This method retrieves the information of the platform's current time which corresponds to the get platform time procedure
operationId: TimingCurrentTime_GET
produces:
- application/json
responses:
200:
description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
schema:
type: object
properties:
CurrentTime:
$ref: '#/definitions/CurrentTime'
400:
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
403:
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
404:
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
\ No newline at end of file
get:
$ref: ./TimingCurrentTime.GET.yaml
\ No newline at end of file
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 mobile edge platform in the "transport information query" procedure
operationId: Transports_GET
produces:
- application/json
responses:
200:
description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
schema:
type: array
items:
type: object
properties: