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

Moving from Swagger 2.0 to OpenAPI 3.0

parents 7daaee41 ec6d7b0b
name: appInstanceId
description: Represents a mobile edge application instance. Note that the appInstanceId is allocated by the mobile edge platform manager.
in: path
required: true
type: string
\ No newline at end of file
name: dnsRuleId
description: Represents a DNS rule.
in: path
required: true
type: string
\ No newline at end of file
name: serviceId
description: Represents a mobile edge service instance.
in: path
required: true
type: string
\ No newline at end of file
name: subscriptionId
description: Represents a subscription to the notifications from the mobile edge platform.
in: path
required: true
type: string
\ No newline at end of file
name: subscriptionType
description: Represents a subscription type to the notifications from the mobile edge platform.
in: path
required: true
type: string
enum:
- SerAvailabilityNotificationSubscription
- AppTerminationNotificationSubscription
\ No newline at end of file
name: trafficRuleId
description: Represents a traffic rule.
in: path
required: true
type: string
\ No newline at end of file
name: ser_category_id
description: A mobile edge application instance may use ser_category_id as an input parameter to query the availability of a list of mobile edge service instances in a serCategory. Either "ser_instance_id" or "ser_name" or "ser_category_id" or none of them shall be present.
in: query
required: false
type: string
\ No newline at end of file
name: ser_instance_id
description: A mobile edge application instance may use multiple ser_instance_ids as an input parameter to query the availability of a list of mobile edge service instances. Either "ser_instance_id" or "ser_name" or "ser_category_id" or none of them shall be present.
in: query
required: false
type: array
items:
type: string
\ No newline at end of file
name: ser_name
description: A mobile edge application instance may use multiple ser_names as an input parameter to query the availability of a list of mobile edge service instances. Either "ser_instance_id" or "ser_name" or "ser_category_id" or none of them shall be present.
in: query
required: false
type: array
items:
type: string
\ No newline at end of file
Body.AppTerminationNotificationSubscription:
$ref: ./Body.AppTerminationNotificationSubscription.yaml
Body.DnsRule:
$ref: ./Body.DnsRule.yaml
Body.SerAvailabilityNotificationSubscription:
$ref: ./Body.SerAvailabilityNotificationSubscription.yaml
Body.ServiceInfo:
$ref: ./Body.ServiceInfo.yaml
Body.TrafficRule:
$ref: ./Body.TrafficRule.yaml
Path.AppInstanceId:
$ref: ./Path.AppInstanceId.yaml
Path.DnsRuleId:
$ref: ./Path.DnsRuleId.yaml
Path.SubscriptionId:
$ref: ./Path.SubscriptionId.yaml
Path.SubscriptionType:
$ref: ./Path.SubscriptionType.yaml
Path.ServiceId:
$ref: ./Path.ServiceId.yaml
Path.TrafficRuleId:
$ref: ./Path.TrafficRuleId.yaml
Query.Ser_category_id:
$ref: ./Query.Ser_category_id.yaml
Query.Ser_instance_id:
$ref: ./Query.Ser_instance_id.yaml
Query.Ser_name:
$ref: ./Query.Ser_name.yaml
\ No newline at end of file
description: This method retrieves information about a DNS rule associated with a mobile edge application instance.
operationId: ApplicationsDnsRule_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:
DnsRule:
$ref: '#/definitions/DnsRule'
examples:
application/json:
DnsRule:
dnsRuleId: 'DnsRule1'
domainName: 'www.example.com'
ipAddressType: 'IP_V4'
ipAddress: '146.241.7.3'
ttl: 300
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 activates, de-activates or updates a traffic rule.
operationId: ApplicationsDnsRule_PUT
produces:
- application/json
parameters:
- $ref: '#/parameters/Body.DnsRule'
responses:
200:
description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
schema:
type: object
properties:
DnsRule:
$ref: '#/definitions/DnsRule'
examples:
application/json:
DnsRule:
dnsRuleId: 'DnsRule1'
domainName: 'www.example.com'
ipAddressType: 'IP_V4'
ipAddress: '146.241.7.3'
ttl: 300
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.DnsRuleId'
get:
$ref: ./ApplicationsDnsRule.GET.yaml
put:
$ref: ./ApplicationsDnsRule.PUT.yaml
\ No newline at end of file
description: This method retrieves information about all the DNS rules associated with a mobile edge application instance.
operationId: ApplicationsDnsRules_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:
DnsRule:
$ref: '#/definitions/DnsRule'
examples:
application/json:
- DnsRule:
dnsRuleId: 'DnsRule1'
domainName: 'www.example.com'
ipAddressType: 'IP_V4'
ipAddress: '146.241.7.3'
ttl: 300
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: ./ApplicationsDnsRules.GET.yaml
\ No newline at end of file
description: This method deletes a meMp1Subscription. This method is typically used in "Unsubscribing from service availability event notifications" procedure.
operationId: ApplicationsSubscription_DELETE
produces:
- application/json
responses:
204:
description: No Content
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: 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
produces:
- application/json
responses:
200:
description: Upon success, a response body containing the requested subscription is returned.
schema:
type: object
properties:
SerAvailabilityNotificationSubscription:
$ref: '#/definitions/SerAvailabilityNotificationSubscription'
# The alternative response
# AppTerminationNotificationSubscription:
# $ref: '#/definitions/AppTerminationNotificationSubscription'
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'
- $ref: '#/parameters/Path.SubscriptionType'
- $ref: '#/parameters/Path.SubscriptionId'
get:
$ref: ./ApplicationsSubscription.GET.yaml
delete:
$ref: ./ApplicationsSubscription.DELETE.yaml
\ No newline at end of file
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
produces:
- application/json
responses:
200:
description: Upon success, a response body containing the list of links to the requested subscriptions is returned.
schema:
type: object
properties:
Mp1SubscriptionLinkList:
$ref: '#/definitions/Mp1SubscriptionLinkList'
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: The POST method may be used to create a new subscription. One example use case is to create a new subscription to the mobile edge service availability notifications. Upon success, the response contains entity body describing the created subscription.
operationId: ApplicationsSubscriptions_POST
produces:
- application/json
parameters:
- $ref: '#/parameters/Body.AppTerminationNotificationSubscription'
# The alternative request
#- $ref: '#/parameters/Body.SerAvailabilityNotificationSubscription'
responses:
201:
description: Entity body in the request contains a subscription to the mobile edge service availability notifications that is to be created.
headers:
location:
description: The resource URI of the created resource
type: string
format: uri
schema:
type: object
properties:
AppTerminationNotificationSubscription:
$ref: '#/definitions/AppTerminationNotificationSubscription'
# The alternative response
# SerAvailabilityNotificationSubscription:
# $ref: '#/definitions/SerAvailabilityNotificationSubscription'
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
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