diff --git a/Mp1.json b/Mp1.json index 4e532954b9510b6370d01ab5c4b2c5023a2bdf27..ff4605f8c090ef89467c0b2911bf6a63d9897417 100644 Binary files a/Mp1.json and b/Mp1.json differ diff --git a/Mp1.yaml b/Mp1.yaml index 341ec7d64189ab1835d332aa68251c18981580fa..5ec6e2c06f7ab42a4e5a6d465e657f01af42a44d 100644 --- a/Mp1.yaml +++ b/Mp1.yaml @@ -137,6 +137,38 @@ paths: 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' '/applications/{appInstanceId}/dns_rules/{dnsRuleId}': parameters: - $ref: '#/parameters/Path.AppInstanceId' @@ -154,6 +186,38 @@ paths: 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' put: description: 'This method activates, de-activates or updates a traffic rule.' operationId: ApplicationsDnsRule.PUT @@ -169,6 +233,45 @@ paths: 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' '/applications/{appInstanceId}/subscriptions': parameters: - $ref: '#/parameters/Path.AppInstanceId' @@ -185,6 +288,29 @@ paths: 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' post: 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 @@ -193,13 +319,36 @@ paths: parameters: - $ref: '#/parameters/Body.AppTerminationNotificationSubscription' responses: - '200': + '201': description: Entity body in the request contains a subscription to the mobile edge service availability notifications that is to be created. schema: type: object properties: AppTerminationNotificationSubscription: $ref: '#/definitions/AppTerminationNotificationSubscription.Response' + '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' '/applications/{appInstanceId}/subscriptions/{subscriptionType}/{subscriptionId}': parameters: - $ref: '#/parameters/Path.AppInstanceId' @@ -218,6 +367,29 @@ paths: properties: SerAvailabilityNotificationSubscription: $ref: '#/definitions/SerAvailabilityNotificationSubscription.Response' + '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' delete: description: This method deletes a meMp1Subscription. This method is typically used in "Unsubscribing from service availability event notifications" procedure. operationId: ApplicationsSubscription.DELETE @@ -226,6 +398,22 @@ paths: 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' '/applications/{appInstanceId}/traffic_rules': parameters: - $ref: '#/parameters/Path.AppInstanceId' @@ -244,6 +432,49 @@ paths: 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' '/applications/{appInstanceId}/traffic_rules/{trafficRuleId}': parameters: - $ref: '#/parameters/Path.AppInstanceId' @@ -261,6 +492,49 @@ paths: 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' put: description: This method retrieves information about all the traffic rules associated with a mobile edge application instance. operationId: ApplicationsTrafficRules.PUT @@ -276,6 +550,56 @@ paths: 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' /services: get: description: This method retrieves information about a list of meService resources. This method is typically used in "service availability query" procedure @@ -296,6 +620,60 @@ paths: 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: JSON + protocol: HTTP + version: '2.0' + endpoint: + uris: + - /meMp1/service/EntryPoint + addresses: + - host: 192.0.2.0 + port: '8080' + security.mp1: + oAuth2Info: + grantTypes: OAUTH2_CLIENT_CREDENTIALS + tokenEndpoint: /meMp1/security.mp1/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' put: 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 @@ -311,6 +689,60 @@ paths: 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: JSON + protocol: HTTP + version: '2.0' + endpoint: + uris: + - /meMp1/service/EntryPoint + addresses: + - host: 192.0.2.0 + port: '8080' + security.mp1: + oAuth2Info: + grantTypes: OAUTH2_CLIENT_CREDENTIALS + tokenEndpoint: /meMp1/security.mp1/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' '/services/{serviceId}': parameters: - $ref: '#/parameters/Path.ServiceId' @@ -353,11 +785,34 @@ paths: addresses: - host: 192.0.2.0 port: '8080' - security: + security.mp1: oAuth2Info: grantTypes: OAUTH2_CLIENT_CREDENTIALS - tokenEndpoint: /meMp1/mp1.security/TokenEndPoint + tokenEndpoint: /meMp1/security.mp1/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' put: description: This method updates the information about a meService resource operationId: ServicesServiceId.PUT @@ -399,11 +854,41 @@ paths: addresses: - host: 192.0.2.0 port: '8080' - security: + security.mp1: oAuth2Info: grantTypes: OAUTH2_CLIENT_CREDENTIALS - tokenEndpoint: /meMp1/mp1.security/TokenEndPoint + tokenEndpoint: /meMp1/security.mp1/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' /timing/current_time: get: description: This method retrieves the information of the platform's current time which corresponds to the get platform time procedure @@ -418,6 +903,29 @@ paths: 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' /timing/timing_caps: get: description: This method retrieves the information of the platform's timing capabilities which corresponds to the timing capabilities query @@ -432,6 +940,29 @@ paths: 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' /transports: get: 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 @@ -448,6 +979,29 @@ paths: properties: TransportInfo: $ref: '#/definitions/TransportInfo' + '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' definitions: AppTerminationNotification.MaxGracefulTimeout: description: Maximum timeout value in seconds for graceful termination or graceful stop of an application instance. @@ -743,6 +1297,37 @@ definitions: properties: _links: $ref: '#/definitions/Mp1SubscriptionLinkList.Links' + ProblemDetails: + type: object + properties: + type: + $ref: '#/definitions/Problem.type' + title: + $ref: '#/definitions/Problem.title' + status: + $ref: '#/definitions/Problem.status' + detail: + $ref: '#/definitions/Problem.detail' + instance: + $ref: '#/definitions/Problem.instance' + Problem.detail: + type: string + description: A human-readable explanation specific to this occurrence of the problem + Problem.instance: + type: string + format: uri + description: A URI reference that identifies the specific occurrence of the problem + Problem.status: + type: integer + format: uint32 + description: The HTTP status code for this occurrence of the problem + Problem.title: + type: string + description: 'A short, human-readable summary of the problem type' + Problem.type: + type: string + format: uri + description: A URI reference according to IETF RFC 3986 that identifies the problem type SecurityInfo.OAuth2Info.GrantTypes: description: List of supported OAuth 2.0 grant types type: string @@ -1013,9 +1598,9 @@ definitions: items: $ref: '#/definitions/TimingCaps.PtpMasters' TrafficFilter.Address: - description: Identify the traffic rule. + description: Identify the traffic ip address. type: string - example: TrafficRule1 + example: 192.168.1.1 TrafficFilter.DSCP: description: Used to match all IPv4 packets that have the same Differentiated Services Code Point (DSCP) type: integer @@ -1203,7 +1788,7 @@ definitions: - protocol - version - endpoint - - security + - security.mp1 properties: id: $ref: '#/definitions/TransportInfo.Id' @@ -1219,7 +1804,7 @@ definitions: $ref: '#/definitions/TransportInfo.Version' endpoint: $ref: '#/definitions/EndPointInfo' - security: + security.mp1: $ref: '#/definitions/SecurityInfo' implSpecificInfo: $ref: '#/definitions/TransportInfo.ImplSpecificInfo' diff --git a/definitions/Problem.detail.yaml b/definitions/Problem.detail.yaml new file mode 100644 index 0000000000000000000000000000000000000000..01b9d2df560982ab6a36d3dafa4284689bb058de --- /dev/null +++ b/definitions/Problem.detail.yaml @@ -0,0 +1,3 @@ +type: string +description: >- + A human-readable explanation specific to this occurrence of the problem diff --git a/definitions/Problem.instance.yaml b/definitions/Problem.instance.yaml new file mode 100644 index 0000000000000000000000000000000000000000..d2c35fc41851db1a479b718c019ffe01b3c06606 --- /dev/null +++ b/definitions/Problem.instance.yaml @@ -0,0 +1,4 @@ +type: string +format: uri +description: >- + A URI reference that identifies the specific occurrence of the problem diff --git a/definitions/Problem.status.yaml b/definitions/Problem.status.yaml new file mode 100644 index 0000000000000000000000000000000000000000..3d99685610f162c2874b333966ffb283f99ee00e --- /dev/null +++ b/definitions/Problem.status.yaml @@ -0,0 +1,4 @@ +type: integer +format: uint32 +description: >- + The HTTP status code for this occurrence of the problem diff --git a/definitions/Problem.title.yaml b/definitions/Problem.title.yaml new file mode 100644 index 0000000000000000000000000000000000000000..b7894c4c9ecaa08413cbc4ccb593cc6d9d12662d --- /dev/null +++ b/definitions/Problem.title.yaml @@ -0,0 +1,3 @@ +type: string +description: >- + A short, human-readable summary of the problem type diff --git a/definitions/Problem.type.yaml b/definitions/Problem.type.yaml new file mode 100644 index 0000000000000000000000000000000000000000..2b2edb61102beb8c3ce36a87c8347fbc2049da06 --- /dev/null +++ b/definitions/Problem.type.yaml @@ -0,0 +1,4 @@ +type: string +format: uri +description: >- + A URI reference according to IETF RFC 3986 that identifies the problem type diff --git a/definitions/ProblemDetails.yaml b/definitions/ProblemDetails.yaml new file mode 100644 index 0000000000000000000000000000000000000000..5d159377b1d2f7521a920ac9b1419b635e9ae191 --- /dev/null +++ b/definitions/ProblemDetails.yaml @@ -0,0 +1,12 @@ +type: object +properties: + type: + $ref: '#/definitions/Problem.type' + title: + $ref: '#/definitions/Problem.title' + status: + $ref: '#/definitions/Problem.status' + detail: + $ref: '#/definitions/Problem.detail' + instance: + $ref: '#/definitions/Problem.instance' diff --git a/definitions/TransportInfo.yaml b/definitions/TransportInfo.yaml index a34a6c1c5a0ba861da15dce9d14a95114572a3b0..7ef20b73da0d45c1a6733a155a442bfb41b01ebd 100644 --- a/definitions/TransportInfo.yaml +++ b/definitions/TransportInfo.yaml @@ -7,7 +7,7 @@ required: - protocol - version - endpoint -- security +- security.mp1 properties: id: $ref: '#/definitions/TransportInfo.Id' @@ -23,7 +23,7 @@ properties: $ref: '#/definitions/TransportInfo.Version' endpoint: $ref: '#/definitions/EndPointInfo' - security: + security.mp1: $ref: '#/definitions/SecurityInfo' implSpecificInfo: $ref: '#/definitions/TransportInfo.ImplSpecificInfo' \ No newline at end of file diff --git a/definitions/index.yaml b/definitions/index.yaml index e1cdda1405d6b28acde669ac864f69395bddf101..496cb046939b6cca41703203f98a25cdcbbca47f 100644 --- a/definitions/index.yaml +++ b/definitions/index.yaml @@ -72,6 +72,18 @@ 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: diff --git a/examples/ServiceInfo.json b/examples/ServiceInfo.json index c2cbeae4e14b40e2602db556443ff611660958aa..4de6a68bac303a3820f16dd3f7132ef1c7fbe06a 100644 --- a/examples/ServiceInfo.json +++ b/examples/ServiceInfo.json @@ -29,10 +29,10 @@ } ] }, - "security": { + "security.mp1": { "oAuth2Info": { "grantTypes": "OAUTH2_CLIENT_CREDENTIALS", - "tokenEndpoint": "/meMp1/mp1.security/TokenEndPoint" + "tokenEndpoint": "/meMp1/security.mp1/TokenEndPoint" } } }, diff --git a/examples/ServiceInfo.yaml b/examples/ServiceInfo.yaml index 06f91025140892717b46e4ae8e97166be72d93fa..0386a4f7bd0cc0fd0a28f589e82141f2251237e4 100644 --- a/examples/ServiceInfo.yaml +++ b/examples/ServiceInfo.yaml @@ -22,8 +22,8 @@ ServiceInfo: addresses: - host: '192.0.2.0' port: '8080' - security: + security.mp1: oAuth2Info: grantTypes: OAUTH2_CLIENT_CREDENTIALS - tokenEndpoint: /meMp1/mp1.security/TokenEndPoint + tokenEndpoint: /meMp1/security.mp1/TokenEndPoint serializer: JSON diff --git a/paths/ApplicationsDnsRule.GET.yaml b/paths/ApplicationsDnsRule.GET.yaml index 3d6ada9b0487528b7ef9b6d423dcc0b592b5462a..e0cbfa861d4b203dbb4978dbe10c166549810b73 100644 --- a/paths/ApplicationsDnsRule.GET.yaml +++ b/paths/ApplicationsDnsRule.GET.yaml @@ -13,4 +13,33 @@ responses: $ref: '#/definitions/DnsRule' examples: application/json: - $ref: '../examples/DnsRule.json' \ 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 + 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 diff --git a/paths/ApplicationsDnsRule.PUT.yaml b/paths/ApplicationsDnsRule.PUT.yaml index c2c3dbda89ade10332774f0966b8fdd192567b96..868d9df877ff8db1f3a08d0d7c2cf8fbce017d25 100644 --- a/paths/ApplicationsDnsRule.PUT.yaml +++ b/paths/ApplicationsDnsRule.PUT.yaml @@ -12,8 +12,43 @@ responses: type: object properties: DnsRule: - $ref: '#/definitions/DnsRule' - + $ref: '#/definitions/DnsRule' examples: application/json: - $ref: '../examples/DnsRule.json' \ 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 + 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 diff --git a/paths/ApplicationsDnsRules.GET.yaml b/paths/ApplicationsDnsRules.GET.yaml index 6948daeefcefa7ffcbd2cc5ae566abe72b6d1e6f..1d24a0c683082eb2b789523eec990c81d308e879 100644 --- a/paths/ApplicationsDnsRules.GET.yaml +++ b/paths/ApplicationsDnsRules.GET.yaml @@ -12,4 +12,36 @@ responses: type: object properties: DnsRule: - $ref: '#/definitions/DnsRule' \ No newline at end of file + $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 diff --git a/paths/ApplicationsSubscription.DELETE.yaml b/paths/ApplicationsSubscription.DELETE.yaml index 64489bd06ee6ef59e2cd93a9ba37cb40b4e2e694..ca094f6da81619306625a6a205bdc66ea598016e 100644 --- a/paths/ApplicationsSubscription.DELETE.yaml +++ b/paths/ApplicationsSubscription.DELETE.yaml @@ -5,4 +5,20 @@ produces: responses: 204: - description: No Content \ No newline at end of file + 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 diff --git a/paths/ApplicationsSubscription.GET.yaml b/paths/ApplicationsSubscription.GET.yaml index 05305b4111c1b93cfd8756c220b69a810184b9b6..1043fa3786d1033a66a2e9f8beb66cbbd09f8d39 100644 --- a/paths/ApplicationsSubscription.GET.yaml +++ b/paths/ApplicationsSubscription.GET.yaml @@ -13,4 +13,27 @@ responses: $ref: '#/definitions/SerAvailabilityNotificationSubscription.Response' # The alternative response # AppTerminationNotificationSubscription: -# $ref: '#/definitions/AppTerminationNotificationSubscription.Response' \ No newline at end of file +# $ref: '#/definitions/AppTerminationNotificationSubscription.Response' + 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 diff --git a/paths/ApplicationsSubscriptions.GET.yaml b/paths/ApplicationsSubscriptions.GET.yaml index 4f2e3f0f90c7a0202724047bdb200e90c46f770e..bb6717194ececbcf86a3c3a7c5bb867b1723bffb 100644 --- a/paths/ApplicationsSubscriptions.GET.yaml +++ b/paths/ApplicationsSubscriptions.GET.yaml @@ -10,4 +10,27 @@ responses: type: object properties: Mp1SubscriptionLinkList: - $ref: '#/definitions/Mp1SubscriptionLinkList' \ No newline at end of file + $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 diff --git a/paths/ApplicationsSubscriptions.POST.yaml b/paths/ApplicationsSubscriptions.POST.yaml index 5d9e8eed60c9bdd219c4d2a73ce516d86d2cdd7c..1468cafca5dab298f8bfd841150920205a3c1ea1 100644 --- a/paths/ApplicationsSubscriptions.POST.yaml +++ b/paths/ApplicationsSubscriptions.POST.yaml @@ -8,7 +8,7 @@ parameters: #- $ref: '#/parameters/Body.SerAvailabilityNotificationSubscription' responses: - 200: + 201: description: Entity body in the request contains a subscription to the mobile edge service availability notifications that is to be created. schema: type: object @@ -17,4 +17,27 @@ responses: $ref: '#/definitions/AppTerminationNotificationSubscription.Response' # The alternative response # SerAvailabilityNotificationSubscription: -# $ref: '#/definitions/SerAvailabilityNotificationSubscription' \ No newline at end of file +# $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 diff --git a/paths/ApplicationsTrafficRule.GET.yaml b/paths/ApplicationsTrafficRule.GET.yaml index ae232c156c7c75d2bb98d9c6c08e9feb3eeac9fa..cddc21d3ce5379546ab85d595c61b0fceb55830f 100644 --- a/paths/ApplicationsTrafficRule.GET.yaml +++ b/paths/ApplicationsTrafficRule.GET.yaml @@ -13,4 +13,40 @@ responses: $ref: '#/definitions/TrafficRule' examples: application/json: - $ref: '../examples/TrafficRule.json' \ 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 + 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 diff --git a/paths/ApplicationsTrafficRule.PUT.yaml b/paths/ApplicationsTrafficRule.PUT.yaml index dbef6ff2ec0bb5aff10631d6e945a3da8cf19ba6..0e030d759289e735141a2546ee9fb25d8f906490 100644 --- a/paths/ApplicationsTrafficRule.PUT.yaml +++ b/paths/ApplicationsTrafficRule.PUT.yaml @@ -15,4 +15,47 @@ responses: $ref: '#/definitions/TrafficRule' examples: application/json: - $ref: '../examples/TrafficRule.json' \ 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 + 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 diff --git a/paths/ApplicationsTrafficRules.GET.yaml b/paths/ApplicationsTrafficRules.GET.yaml index 4b8432bf28e4c1b2c62815b55b4598bf70788b06..4ab75dce0ff393a7ac836056f27352e8fcb7435c 100644 --- a/paths/ApplicationsTrafficRules.GET.yaml +++ b/paths/ApplicationsTrafficRules.GET.yaml @@ -12,4 +12,43 @@ responses: type: object properties: TrafficRule: - $ref: '#/definitions/TrafficRule' \ No newline at end of file + $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 diff --git a/paths/Services.GET.yaml b/paths/Services.GET.yaml index d0c64da4de479e4d4d0d10ce24f4e61a44ca8508..a2453752f686abcb273a506f9c3a087b5ae379e6 100644 --- a/paths/Services.GET.yaml +++ b/paths/Services.GET.yaml @@ -16,4 +16,58 @@ responses: type: object properties: ServiceInfo: - $ref: '#/definitions/ServiceInfo' \ No newline at end of file + $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: JSON + protocol: HTTP + version: '2.0' + endpoint: + uris: + - /meMp1/service/EntryPoint + addresses: + - host: '192.0.2.0' + port: '8080' + security.mp1: + oAuth2Info: + grantTypes: OAUTH2_CLIENT_CREDENTIALS + tokenEndpoint: /meMp1/security.mp1/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 diff --git a/paths/Services.POST.yaml b/paths/Services.POST.yaml index d986ccaaa1e3a0943ff79c7f22e9a6438c33362f..784eb6d179675d56875ee32b3d3aff905fe32164 100644 --- a/paths/Services.POST.yaml +++ b/paths/Services.POST.yaml @@ -12,4 +12,58 @@ responses: type: object properties: ServiceInfo: - $ref: '#/definitions/ServiceInfo' \ No newline at end of file + $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: JSON + protocol: HTTP + version: '2.0' + endpoint: + uris: + - /meMp1/service/EntryPoint + addresses: + - host: '192.0.2.0' + port: '8080' + security.mp1: + oAuth2Info: + grantTypes: OAUTH2_CLIENT_CREDENTIALS + tokenEndpoint: /meMp1/security.mp1/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 diff --git a/paths/ServicesServiceId.GET.yaml b/paths/ServicesServiceId.GET.yaml index 57a60d8a53ed8078e924074814c9a897043b1cf6..fea37a7c7d7821f2472d22dd6913c048fbb2a411 100644 --- a/paths/ServicesServiceId.GET.yaml +++ b/paths/ServicesServiceId.GET.yaml @@ -11,7 +11,57 @@ responses: properties: ServiceInfo: $ref: '#/definitions/ServiceInfo' - examples: application/json: - $ref: '../examples/ServiceInfo.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: JSON + protocol: HTTP + version: '2.0' + endpoint: + uris: + - /meMp1/service/EntryPoint + addresses: + - host: '192.0.2.0' + port: '8080' + security.mp1: + oAuth2Info: + grantTypes: OAUTH2_CLIENT_CREDENTIALS + tokenEndpoint: /meMp1/security.mp1/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 diff --git a/paths/ServicesServiceId.PUT.yaml b/paths/ServicesServiceId.PUT.yaml index 0b354acb356f1457e02e918ed7a428f535075068..c1ec0a899b63fb79ee5ecfb5ee20ab53be5ed7fb 100644 --- a/paths/ServicesServiceId.PUT.yaml +++ b/paths/ServicesServiceId.PUT.yaml @@ -13,7 +13,64 @@ responses: properties: ServiceInfo: $ref: '#/definitions/ServiceInfo' - examples: application/json: - $ref: '../examples/ServiceInfo.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: JSON + protocol: HTTP + version: '2.0' + endpoint: + uris: + - /meMp1/service/EntryPoint + addresses: + - host: '192.0.2.0' + port: '8080' + security.mp1: + oAuth2Info: + grantTypes: OAUTH2_CLIENT_CREDENTIALS + tokenEndpoint: /meMp1/security.mp1/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 diff --git a/paths/TimingCaps.GET.yaml b/paths/TimingCaps.GET.yaml index 545700d9dc0c225817cc7b045be02baef5dfb6f9..259593b10b35661289fc40decd546e97f6ad1f84 100644 --- a/paths/TimingCaps.GET.yaml +++ b/paths/TimingCaps.GET.yaml @@ -10,4 +10,27 @@ responses: type: object properties: TimingCaps: - $ref: '#/definitions/TimingCaps' \ No newline at end of file + $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 diff --git a/paths/TimingCurrentTime.GET.yaml b/paths/TimingCurrentTime.GET.yaml index 4f4ea424821f6b5a41e30e14b51e837f6345869f..fb5402684290ac3032bffaf9685b0050b8b82539 100644 --- a/paths/TimingCurrentTime.GET.yaml +++ b/paths/TimingCurrentTime.GET.yaml @@ -10,4 +10,27 @@ responses: type: object properties: CurrentTime: - $ref: '#/definitions/CurrentTime' \ No newline at end of file + $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 diff --git a/paths/Transports.GET.yaml b/paths/Transports.GET.yaml index 89afb01890e72152925d01668cffe53ec2dc9d56..05dbed3fc6cbaa488b4c403c0ceed279b4fb710f 100644 --- a/paths/Transports.GET.yaml +++ b/paths/Transports.GET.yaml @@ -12,4 +12,27 @@ responses: type: object properties: TransportInfo: - $ref: '#/definitions/TransportInfo' \ No newline at end of file + $ref: '#/definitions/TransportInfo' + 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