diff --git a/MecAppSupportApi.yaml b/MecAppSupportApi.yaml index ce952dca7c68c911fb2a40b712a32378890c6ee4..818ec132b2f228183fadac700f97792cbd87ba41 100644 --- a/MecAppSupportApi.yaml +++ b/MecAppSupportApi.yaml @@ -10,7 +10,7 @@ info: license: name: BSD-3-Clause url: https://forge.etsi.org/legal-matters - version: 3.1.1 + version: 3.2.1 servers: - url: https://localhost:8081/mec_app_support/v1 paths: @@ -82,7 +82,7 @@ paths: post: summary: Callback POST used to send a notification description: Subscription notification - operationId: notificationPOST637029 + operationId: notificationPOST763522 requestBody: description: Subscription notification required: true @@ -167,6 +167,73 @@ paths: description: The unique identifier of the subscriptionId. schema: type: string + post: + summary: POST /applications/{appInstanceId}/subscriptions/{subscriptionId} endpoint. + description: The POST method delivers a notification from the MEC Platform to the subscriber. + operationId: ApplicationsSubscriptionsPOSTAppinstanceidSubscriptionid + tags: + - applicationSupport + requestBody: + description: A notification for application instance termination. + required: true + content: + application/json: + schema: + type: object + properties: + AppTerminationNotification: + $ref: '#/components/schemas/AppTerminationNotification' + responses: + '204': + description: The notification was delivered successfully. The response body shall be empty. + content: + application/json: + schema: + type: object + properties: {} + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + callbacks: + notification: + '{$request.body#/callbackUri}': + post: + summary: Callback POST used to send a notification + description: Subscription notification + operationId: notificationPOST258454 + requestBody: + description: Subscription notification + required: true + content: + application/json: + schema: + type: object + properties: + subscriptionNotification: + $ref: '#/components/schemas/AppTerminationNotification' + responses: + '204': + description: No content + '404': + description: Not found + parameters: + - name: appInstanceId + in: path + required: true + description: The unique identifier of the appInstanceId. + schema: + type: string + - name: subscriptionId + in: path + required: true + description: The unique identifier of the subscriptionId. + schema: + type: string /timing/timing_caps: get: summary: Retrieve information about the mecTimingCaps resource. @@ -246,7 +313,7 @@ paths: type: string /applications/{appInstanceId}/traffic_rules/{trafficRuleId}: get: - summary: Retrieve information about a mecTrafficRule resource. + summary: GET /applications/{appInstanceId}/traffic_rules/{trafficRuleId} endpoint. description: This method retrieves information about a traffic rule associated with a MEC application instance. operationId: ApplicationsTrafficrulesGETAppinstanceidTrafficruleid tags: @@ -281,7 +348,7 @@ paths: schema: type: string put: - summary: Update the information about a mecTrafficRule resource. + summary: PUT /applications/{appInstanceId}/traffic_rules/{trafficRuleId} endpoint. description: PUT HTTP method shall comply with the URI query parameters, request and response data structures, and response codes, as specified in tables 7.2.8.3.2-1 and 7.2.8.3.2-2. operationId: ApplicationsTrafficrulesPUTAppinstanceidTrafficruleid tags: @@ -358,7 +425,7 @@ paths: type: string /applications/{appInstanceId}/dns_rules/{dnsRuleId}: get: - summary: Retrieve information about a mecDnsRule resource. + summary: GET /applications/{appInstanceId}/dns_rules/{dnsRuleId} endpoint. description: 'This method retrieves information about a DNS rule associated with a MEC application instance. ' operationId: ApplicationsDnsrulesGETAppinstanceidDnsruleid tags: @@ -393,7 +460,7 @@ paths: schema: type: string put: - summary: Update the information about a mecDnsRule resource. + summary: PUT /applications/{appInstanceId}/dns_rules/{dnsRuleId} endpoint. description: PUT HTTP method shall comply with the URI query parameters, request and response data structures, and response codes, as specified in tables 7.2.10.3.2-1 and 7.2.10.3.2-2. operationId: ApplicationsDnsrulesPUTAppinstanceidDnsruleid tags: @@ -524,7 +591,7 @@ paths: $ref: '#/components/schemas/AppInfo' responses: '201': - description: Indicates successful resource creation for registration of the MEC application instance to the MEC platform. The resource URI shall be returned in the HTTP Location header field. + description: Indicates successful resource creation for registration of the MEC application instance to the MEC platform. The resource URI shall be returned in the HTTP Location header field. appInstanceId shall be present in the newly created AppInfo resource. content: application/json: schema: @@ -840,7 +907,7 @@ components: type: object properties: href: - description: URI referring to a resource + description: URI referring to a resource. type: string format: uri required: @@ -858,7 +925,7 @@ components: - SEE_DESCRIPTION description: 'Definition of filter per FLOW or PACKET. - If FLOW, the filter matches upstream (e.g. UEEPC) packets and upstream (e.g. EPCUE) packets are handled in the same context.' + If FLOW, the filter matches upstream (e.g. UEEPC) packets and downstream (e.g. EPCUE) packets are handled in the same context.' priority: description: Priority of this traffic rule within the range 0 to 255. If traffic rules conflict, the one with higher priority take precedence. See note 1. type: integer @@ -872,21 +939,9 @@ components: type: string enum: - DUPLICATE_ENCAPSULATED - description: 'The action of the MEC host data plane when a packet matches the trafficFilter, the following actions are defined: - - DROP - - FORWARD_DECAPSULATED - - FORWARD_ENCAPSULATED - - PASSTHROUGH - - DUPLICATE_DECAPSULATED - - DUPLICATE_ENCAPSULATED' + description: "The action of the MEC host data plane when a packet matches the trafficFilter, the following actions are defined: \nDROP\nFORWARD_DECAPSULATED\nFORWARD_ENCAPSULATED\nPASSTHROUGH\nDUPLICATE_DECAPSULATED\nDUPLICATE_ENCAPSULATED" dstInterface: - description: Describes the destination interface information. If the action is FORWARD_DECAPSULATED, FORWARD_ENCAPSULATED or PASSTHROUGH one value shall be provided. If the action is DUPLICATE_DECAPSULATED or DUPLICATE_ENCAPSULATED, two values shall be provided. See note 2. If the action is DROP, no value shall be provided. + description: Describes the destination interface information. If the action is FORWARD_DECAPSULATED, FORWARD_ENCAPSULATED or PASSTHROUGH, one value shall be provided. If the action is DUPLICATE_DECAPSULATED or DUPLICATE_ENCAPSULATED, two values shall be provided. See note 2. If the action is DROP, no value shall be provided. $ref: '#/components/schemas/DestinationInterface' state: type: string @@ -961,11 +1016,11 @@ components: type: object properties: seconds: - description: The seconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC + description: The seconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC. type: integer format: uint32 nanoSeconds: - description: The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC + description: The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC. type: integer format: uint32 timeSourceStatus: @@ -1012,7 +1067,7 @@ components: items: $ref: '#/components/schemas/ServiceDependency' appServiceOptional: - description: "Describes services a MEC application may use if available. ServiceDependency is defined in ETSI GS\_MEC 010-2 [4]. It shall not be provided if an AppD is available." + description: Describes services a MEC application may use if available. ServiceDependency is defined in ETSI GS MEC 010-2 [4]. It shall not be provided if an AppD is available. type: array minItems: 0 items: @@ -1024,22 +1079,40 @@ components: items: $ref: '#/components/schemas/FeatureDependency' appFeatureOptional: - description: "Describes features a MEC application may use if available. FeatureDependency is defined in ETSI GS\_MEC 010-2 [4]. It shall not be provided if an AppD is available." + description: "Describes features a MEC application may use if available. FeatureDependency is defined in ETSI GS\_MEC\_0102\_[4]. It shall not be provided if an AppD is available." type: array minItems: 0 items: $ref: '#/components/schemas/FeatureDependency' - isInsByMec: - description: 'Indicate whether the application instance is instantiated by the MEC Management. + scheds: + description: "The availability schedule of the application server.\nScheduledCommunicationTime is defined in ETSI TS\_129 122 [i.13].\nSee note 3." + type: array + minItems: 0 + items: + $ref: TS29122_CpProvisioning.yaml#/components/schemas/ScheduledCommunicationTime + svcArea: + description: The list of geographical and topological areas that the application server serves. ServiceArea is defined in ETSI TS 129 558 [i.11]. See note 3. + $ref: TS29558_Eecs_EESRegistration.yaml#/components/schemas/ServiceArea + svcKpi: + description: Service characteristics provided by the application server. More information can be found in ETSI TS 123 558 [i.12] clause 8.2.5. EASServiceKPI is defined in ETSI TS 129 558 [i.11]. See note 3. + $ref: TS29558_Eees_EASRegistration.yaml#/components/schemas/EASServiceKPI + permLvl: + description: 'Level of service permissions supported by the application server. - Default to FALSE if absent.' + See note 3.' + type: array + minItems: 0 + items: + type: string + isInsByMec: + description: "Indicate whether the application instance is instantiated by the MEC Management. \nDefault to FALSE if absent." type: boolean appProfile: - description: Can be mapped to EAS profile as defined in ETSI TS 129 558 [19]. More information can be found in the informative Annex C. See note 1 and note 2. + description: Can be mapped to EAS profile as defined in ETSI TS 129 558 [i.11]. More information can be found in Annex C. See notes 1 and 2. $ref: '#/components/schemas/AppProfile' required: - appName - description: "|-\n NOTE 1:\tIf appProfile is present, appProvider shall be consistent with provId provided in EAS profile data type, i.e. the same.\nNOTE 2:\tIf appProfile is present, endpoint shall refer to the same end point as endPt provided in EAS profile data type." + description: "|-\n NOTE 1:\tIf appProfile is present, appProvider shall be consistent with provId provided in EAS profile data type, i.e. the same.\nNOTE 2:\tIf appProfile is present, endpoint shall refer to the same end point as endPt provided in EAS profile data type.\nNOTE 3:\tIf appProfile is present, this attribute shall be consistent with the one provided in EAS profile data type, i.e. the same." AppTerminationNotificationSubscription: x-etsi-ref: 7.1.3.2 type: object @@ -1101,7 +1174,7 @@ components: TERMINATING - The value shall match that sent in the corresponding AppTerminationNotification.' + The value shall match that sent in the corresponding AppTerminationNotification. ' required: - operationAction AppReadyConfirmation: @@ -1229,10 +1302,10 @@ components: - SEE_DESCRIPTION description: Type of the tunnel, e.g. GTP_U, GRE, etc. tunnelDstAddress: - description: Destination address of the tunnel + description: Destination address of the tunnel. type: string tunnelSrcAddress: - description: Source address of the tunnel + description: Source address of the tunnel. type: string required: - tunnelType @@ -1241,7 +1314,7 @@ components: type: object properties: href: - description: Reference of the catalogue. + description: Reference of the category. type: string format: uri id: @@ -1316,15 +1389,15 @@ components: seconds: description: '1' type: array - format: uint32 items: - $ref: '#/components/schemas/Uint32' + type: integer + format: uint32 nanoSeconds: description: '1' type: array - format: uint32 items: - $ref: '#/components/schemas/Uint32' + type: integer + format: uint32 required: - seconds - nanoSeconds @@ -1345,21 +1418,21 @@ components: minPollingInterval: description: '1' type: array - format: uint32 items: - $ref: '#/components/schemas/Uint32' + type: integer + format: uint32 maxPollingInterval: description: '1' type: array - format: uint32 items: - $ref: '#/components/schemas/Uint32' + type: integer + format: uint32 localPriority: description: '1' type: array - format: uint32 items: - $ref: '#/components/schemas/Uint32' + type: integer + format: uint32 authenticationOption: description: '1' type: array @@ -1368,9 +1441,9 @@ components: authenticationKeyNum: description: 0..1 type: array - format: uint32 items: - $ref: '#/components/schemas/Uint32' + type: integer + format: uint32 required: - ntpServerAddrType - ntpServerAddr @@ -1391,15 +1464,15 @@ components: ptpMasterLocalPriority: description: '1' type: array - format: uint32 items: - $ref: '#/components/schemas/Uint32' + type: integer + format: uint32 delayReqMaxRate: description: '1' type: array - format: uint32 items: - $ref: '#/components/schemas/Uint32' + type: integer + format: uint32 required: - ptpMasterIpAddress - ptpMasterLocalPriority