diff --git a/MecAppSupportApi.yaml b/MecAppSupportApi.yaml index ce952dca7c68c911fb2a40b712a32378890c6ee4..b4b2048fc7ef230c858d44128fa147377c5cf302 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: notificationPOST853591 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: notificationPOST831290 + 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: '#/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: '#/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: '#/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 diff --git a/MecServiceMgmtApi.yaml b/MecServiceMgmtApi.yaml index 73a20feacb08f1dbdf0f536b2a83aaaa51ea3cb3..16146da52bbf20dc929392f7bff1c1f03d77dcf9 100644 --- a/MecServiceMgmtApi.yaml +++ b/MecServiceMgmtApi.yaml @@ -10,24 +10,24 @@ 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_service_mgmt/v1 paths: /services: get: - summary: Retrieve information about a list of mecService resources of an application instance. + summary: Retrieve information about a list of mecService resources. description: This method retrieves information about a list of mecService resources. This method is typically used in "service availability query" procedure as described in clause 5.2.5. Figure 8.2.3.3.1-1 shows the example message flows using GET method. operationId: ServicesGET tags: - serviceManagement parameters: - - $ref: '#/components/parameters/Query.Ser_instance_id' - - $ref: '#/components/parameters/Query.Ser_name' - - $ref: '#/components/parameters/Query.Ser_category_id' - - $ref: '#/components/parameters/Query.Scope_of_locality' - - $ref: '#/components/parameters/Query.Consumed_local_only' - - $ref: '#/components/parameters/Query.Is_local' + - $ref: '#/components/parameters/Query.ser_instance_id' + - $ref: '#/components/parameters/Query.ser_name' + - $ref: '#/components/parameters/Query.ser_category_id' + - $ref: '#/components/parameters/Query.scope_of_locality' + - $ref: '#/components/parameters/Query.consumed_local_only' + - $ref: '#/components/parameters/Query.is_local' responses: '200': description: Upon success, a response message content containing an array of the mecServices is returned. @@ -47,7 +47,7 @@ paths: $ref: '#/components/responses/414' /services/{serviceId}: get: - summary: Retrieve information about a mecService resource of an application instance. + summary: Retrieve information about a mecService resource. description: This method retrieves information about a mecService resource. This method is typically used in "service availability query" procedure as described in clause 5.2.5. operationId: ServicesGETServiceid tags: @@ -106,12 +106,12 @@ paths: tags: - serviceManagement parameters: - - $ref: '#/components/parameters/Query.Ser_instance_id' - - $ref: '#/components/parameters/Query.Ser_name' - - $ref: '#/components/parameters/Query.Ser_category_id' - - $ref: '#/components/parameters/Query.Scope_of_locality' - - $ref: '#/components/parameters/Query.Consumed_local_only' - - $ref: '#/components/parameters/Query.Is_local' + - $ref: '#/components/parameters/Query.ser_instance_id' + - $ref: '#/components/parameters/Query.ser_name' + - $ref: '#/components/parameters/Query.ser_category_id' + - $ref: '#/components/parameters/Query.scope_of_locality' + - $ref: '#/components/parameters/Query.consumed_local_only' + - $ref: '#/components/parameters/Query.is_local' - name: appInstanceId in: path required: true @@ -351,7 +351,7 @@ paths: post: summary: Callback POST used to send a notification description: Subscription notification - operationId: notificationPOST739165 + operationId: notificationPOST795320 requestBody: description: Subscription notification required: true @@ -436,71 +436,108 @@ paths: description: The unique identifier of the subscriptionId. schema: type: string - /resource_uri_allocated_by_MEC_platform: - get: - summary: Retrieve information about the liveness of a MEC service instance produced by an application instance - description: 'This method retrieves information about an "Individual mecServiceLiveness" resource. ' - operationId: ResourceuriallocatedbymecplatformGET - tags: - - serviceManagement - responses: - '200': - description: It is used to indicate nonspecific success. The response message content contains a representation of the resource. - content: - application/json: - schema: - type: object - properties: - ServiceLivenessInfo: - $ref: '#/components/schemas/ServiceLivenessInfo' - '400': - $ref: '#/components/responses/400' - '404': - $ref: '#/components/responses/404' - '403': - $ref: '#/components/responses/403' - parameters: [] - patch: - summary: Send a "heartbeat" message related to a MEC service instance. - description: The MEC application instance that provides MEC service shall send a PATCH request to the resource URI representing the liveness of the service instance. - operationId: ResourceuriallocatedbymecplatformPATCH + 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: - serviceManagement requestBody: - description: It contains an update of the liveness state. + description: A notification for service availability update. required: true content: application/json: schema: type: object properties: - ServiceLivenessUpdate: - $ref: '#/components/schemas/ServiceLivenessUpdate' + ServiceAvailabilityNotification: + $ref: '#/components/schemas/ServiceAvailabilityNotification' responses: - '200': - description: Upon success, a response message content is returned containing the updated liveness interval value of the service Instance. - content: - application/json: - schema: - type: object - properties: - ServiceLivenessInfo: - $ref: '#/components/schemas/ServiceLivenessInfo' '204': - description: Successful response sent when there is no need to provide a new liveness interval value to the service Instance. + description: The notification was delivered successfully. The response body shall be empty. content: application/json: schema: type: object properties: {} - '400': - $ref: '#/components/responses/400' - '404': - $ref: '#/components/responses/404' + '401': + $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' - '412': - $ref: '#/components/responses/412' + '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: notificationPOST415194 + requestBody: + description: Subscription notification + required: true + content: + application/json: + schema: + type: object + properties: + subscriptionNotification: + $ref: '#/components/schemas/ServiceAvailabilityNotification' + 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 + /resource_uri_allocated_by_MEC_platform: + get: + summary: Retrieve information about the liveness of a MEC service instance produced by an application instance + description: This method shall be supported as specified in clause 8.2.2.3.3.1 of 3GPP TS 29.222 [21]. + operationId: ResourceuriallocatedbymecplatformGET + tags: + - serviceManagement + parameters: [] + patch: + summary: Send a "heartbeat" message related to a MEC service instance. + description: 'This method shall be supported as specified in clause 8.3.2.3.3.3 of 3GPP TS 29.222 [21]. ' + operationId: ResourceuriallocatedbymecplatformPATCH + tags: + - serviceManagement + parameters: [] + post: + summary: POST /resource_uri_allocated_by_MEC_platform endpoint. + description: 'This method shall be supported as specified in clause 8.3.3 of 3GPP TS 29.222 [21]. ' + operationId: ResourceuriallocatedbymecplatformPOST + tags: + - serviceManagement + parameters: [] + put: + summary: PUT /resource_uri_allocated_by_MEC_platform endpoint. + description: 'This method shall be supported as specified in clause 8.3.2.3.3.2 of 3GPP TS 29.222 [21]. ' + operationId: ResourceuriallocatedbymecplatformPUT + tags: + - serviceManagement + parameters: [] + delete: + summary: DELETE /resource_uri_allocated_by_MEC_platform endpoint. + description: 'This method shall be supported as specified in clause 8.3.2.3.3.1 of 3GPP TS 29.222 [21]. ' + operationId: ResourceuriallocatedbymecplatformDELETE + tags: + - serviceManagement parameters: [] components: schemas: @@ -581,7 +618,7 @@ components: type: object properties: href: - description: URI referring to a resource + description: URI referring to a resource. type: string format: uri required: @@ -591,19 +628,19 @@ components: type: object properties: serInstanceId: - description: 0..1 + description: Identifier of the service instance assigned by the MEPM/MEC platform. For the uniqueness of the identifier across the MEC system, UUID format [i.7] is recommended. Shall be absent in POST requests, and present otherwise. $ref: '#/components/schemas/SerInstanceId' serName: - description: '1' + description: The name of the service. This is how the service producing MEC application identifies the service instance it produces. $ref: '#/components/schemas/SerName' serCategory: - description: 0..1 + description: 'A Category reference. (The category resource is used to group product offerings, service and resource candidates in logical containers. Categories may contain other categories and/or product offerings, resource or service candidates.) (see note 1) For the serCategory, the example values include: 1. "RNI". 2. "Location". 3. "Bandwidth Management".' $ref: '#/components/schemas/CategoryRef' version: - description: '1' + description: The version of the service. type: string state: - description: '1' + description: Contains the service state. $ref: '#/components/schemas/ServiceState' transportId: description: Identifier of the platform-provided transport to be used by the service. Valid identifiers may be obtained using the "Transport information query" procedure. May be present in POST requests to signal the use of a platform-provided transport for the service, and shall be absent otherwise. See note 2. @@ -628,13 +665,7 @@ components: Default to TRUE if absent. See note 4.' type: boolean livenessInterval: - description: 'Interval (in seconds) between two consecutive "heartbeat" messages (see clause 8.2.10.3.3). - - If the service-producing application supports sending "heartbeat" messages, it shall include this attribute in the registration request. In this case, the application shall either set the value of this attribute to zero or shall use this attribute to propose a non-zero positive value for the liveness interval. - - If the application has provided this attribute in the request and the MEC platform requires "heartbeat" messages, the MEC platform shall return this attribute value in the HTTP responses. The MEC platform may use the value proposed in the request or may choose a different value. - - If the MEC platform does not require "heartbeat" messages for this service instance it shall omit the attribute in responses.' + description: "Interval (in seconds) between two consecutive \"heartbeat\" messages (see clause 8.2.10.3.3). \nIf the service-producing application supports sending \"heartbeat\" messages, it shall include this attribute in the registration request. In this case, the application shall either set the value of this attribute to zero or shall use this attribute to propose a non-zero positive value for the liveness interval. \nIf the application has provided this attribute in the request and the MEC platform requires \"heartbeat\" messages, the MEC platform shall return this attribute value in the HTTP responses. The MEC platform may use the value proposed in the request or may choose a different value.\nIf the MEC platform does not require \"heartbeat\" messages for this service instance it shall omit the attribute in responses." type: integer _links: $ref: '#/components/schemas/_links1' @@ -750,7 +781,7 @@ components: type: object properties: href: - description: Reference of the catalogue. + description: Reference of the category. type: string format: uri id: @@ -796,15 +827,33 @@ components: type: object properties: oAuth2Info: + description: Parameters related to use of OAuth 2.0. Shall be present in case OAuth 2.0 (see IETF RFC 6749 [13]) is supported to secure the provision of the service over the transport, as specified in clause 6.16 of ETSI GS MEC 009 [5]. $ref: '#/components/schemas/OAuth2Info' (extensions): description: 'Extensions for alternative transport mechanisms. These extensions depend on the actual transport, and are out of scope of the present document. - For instance, such extensions may be used to signal the necessary parameters for the client to use TLSbased authorization defined for alternative transports (see ETSI GS MEC 009 [5] for more information).' + For instance, such extensions may be used to signal the necessary parameters for the client to use TLSbased authorization defined for alternative transports (see ETSI GS MEC 009 [5] for more information). + + The name of the extensions attributes can be chosen as defined by the actual transport.' type: array minItems: 0 items: $ref: '#/components/schemas/Not_specified' + OAuth2Info: + x-etsi-ref: 8.1.5.5 + type: object + properties: + grantTypes: + type: string + enum: + - SEE_DESCRIPTION + description: "List of supported OAuth 2.0 grant types.\nEach entry shall be one of the following permitted values:\nOAUTH2_AUTHORIZATION_CODE (Authorization code grant type)\nOAUTH2_IMPLICIT_GRANT\n\t(Implicit grant type)\nOAUTH2_RESOURCE_OWNER\n\t(Resource owner password credentials grant type)\nOAUTH2_CLIENT_CREDENTIALS\n\t(Client credentials grant type)\nOnly the value \"OAUTH2_CLIENT_CREDENTIALS\" is supported in the present document. " + tokenEndpoint: + description: "The token endpoint. \nIt shall be present unless the grant type is OAUTH2_IMPLICIT_GRANT." + type: string + format: uri + required: + - grantTypes Subscriptions: description: The MEC application instance's subscriptions. type: object @@ -845,7 +894,7 @@ components: required: - self TimeStamp: - description: The time when the last "heartbeat" message was received by MEC platform. + description: 'The time when the last "heartbeat" message was received by MEC platform. ' type: object properties: seconds: @@ -910,22 +959,20 @@ components: type: object properties: link: - description: Link to the resource representing the individual service. Shall be present unless "changeType"="REMOVED". + description: Link to the resource representing the individual service. Shall be present unless "changeType" = "REMOVED". $ref: '#/components/schemas/LinkType' serName: - description: Name of the service. + description: Name of the service $ref: '#/components/schemas/SerName' serInstanceId: - description: Identifier of the service. + description: Identifier of the service $ref: '#/components/schemas/SerInstanceId' state: description: State of the service after the modification. $ref: '#/components/schemas/ServiceState' changeType: - type: string - enum: - - SEE_DESCRIPTION - description: "Type of the change. \nValid values:\nADDED:\nThe service was newly added.\nREMOVED:\nThe service was removed.\nSTATE_CHANGED:\nOnly the state of the service was changed. \nATTRIBUTES_CHANGED:\nAt least one attribute of the service other than state was changed. The change may or may not include changing the state." + description: Type of the change. + $ref: '#/components/schemas/ServiceChange' required: - serName - serInstanceId @@ -953,21 +1000,6 @@ components: required: - host - port - OAuth2Info: - description: Parameters related to use of OAuth 2.0. Shall be present in case OAuth 2.0 (see IETF RFC 6749 [13]) is supported to secure the provision of the service over the transport. - type: object - properties: - grantTypes: - type: string - enum: - - SEE_DESCRIPTION - description: "List of supported OAuth 2.0 grant types.\nEach entry shall be one of the following permitted values:\nOAUTH2_AUTHORIZATION_CODE (Authorization code grant type)\nOAUTH2_IMPLICIT_GRANT\n\t(Implicit grant type)\nOAUTH2_RESOURCE_OWNER\n\t(Resource owner password credentials grant type)\nOAUTH2_CLIENT_CREDENTIALS\n\t(Client credentials grant type)\nOnly the value \"OAUTH2_CLIENT_CREDENTIALS\" is supported in the present document. " - tokenEndpoint: - description: The token endpoint. Shall be present unless the grant type is OAUTH2_IMPLICIT_GRANT. - type: string - format: uri - required: - - grantTypes responses: '200': description: OK @@ -1022,60 +1054,188 @@ components: schema: $ref: '#/components/schemas/ProblemDetails' parameters: - Query.Ser_instance_id: + Query.ser_instance_id: description: 'A MEC application instance may use multiple ser_instance_ids as an input parameter to query the availability of a list of MEC service instances. ser_instance_id corresponds to serInstanceId defined in table 8.1.2.2-1. See note.' name: ser_instance_id in: query required: false - x-exportParamName: Query.Ser_instance_id + x-exportParamName: Query.ser_instance_id schema: type: array items: type: string - Query.Ser_name: + Query.ser_name: description: "A MEC application instance may use multiple ser_names as an input parameter to query the availability of a list of MEC service instances. ser_name corresponds to serName defined in table\_8.1.2.2-1.\nSee note." name: ser_name in: query required: false - x-exportParamName: Query.Ser_name + x-exportParamName: Query.ser_name schema: type: array items: type: string - Query.Ser_category_id: + Query.ser_category_id: description: 'A MEC application instance may use ser_category_id as an input parameter to query the availability of a list of MEC service instances in a serCategory. ser_category_id corresponds to serCategory defined in table 8.1.2.2-1. See note.' name: ser_category_id in: query required: false - x-exportParamName: Query.Ser_category_id + x-exportParamName: Query.ser_category_id schema: type: string - Query.Scope_of_locality: + Query.scope_of_locality: description: A MEC application instance may use scope_of_locality as an input parameter to query the availability of a list of MEC service instances with a certain scope of locality, as defined in LocalityType in table 8.1.6.5-1. scope_of_locality corresponds to scopeOfLocality defined in table 8.1.2.2-1. name: scope_of_locality in: query required: false - x-exportParamName: Query.Scope_of_locality + x-exportParamName: Query.scope_of_locality schema: $ref: '#/components/schemas/LocalityType' - Query.Consumed_local_only: + Query.consumed_local_only: description: A MEC application instance may use consumed_local_only as an input parameter to query the availability of a list of MEC service instances that can be consumed only locally. consumed_local_only corresponds to consumedLocalOnly defined in table 8.1.2.2-1. name: consumed_local_only in: query required: false - x-exportParamName: Query.Consumed_local_only + x-exportParamName: Query.consumed_local_only schema: - type: boolean - Query.Is_local: - description: A MEC application instance may use is_local as an input parameter to query the availability of a list of MEC service instances in the local MEC host or in local and remote MEC hosts. is_local corresponds to isLocal defined in table 8.1.2.2-1. + type: Boolean + Query.is_local: + description: "A MEC application instance may use is_local as an input parameter to query the availability of a list of MEC service instances in the local MEC host or in local and remote MEC hosts. is_local corresponds to isLocal defined in table\_8.1.2.21." name: is_local in: query required: false - x-exportParamName: Query.Is_local + x-exportParamName: Query.is_local + schema: + type: Boolean + Query.serializer: + description: As defined in clause 8.1.2.2. + name: serializer + in: query + required: true + x-exportParamName: Query.serializer + schema: + $ref: '#/components/schemas/SerializerType' + Query.state: + description: As defined in clause 8.1.2.2. + name: state + in: query + required: true + x-exportParamName: Query.state + schema: + $ref: '#/components/schemas/ServiceState' + Query.scopeOfLocality: + description: As defined in clause 8.1.2.2. + name: scopeOfLocality + in: query + required: false + x-exportParamName: Query.scopeOfLocality + schema: + $ref: '#/components/schemas/LocalityType' + Query.consumedLocalOnly: + description: As defined in clause 8.1.2.2. + name: consumedLocalOnly + in: query + required: false + x-exportParamName: Query.consumedLocalOnly + schema: + type: Boolean + Query.isLocal: + description: As defined in clause 8.1.2.2. + name: isLocal + in: query + required: false + x-exportParamName: Query.isLocal + schema: + type: Boolean + Query.category: + description: As defined in clause 8.1.5.2. + name: category + in: query + required: true + x-exportParamName: Query.category + schema: + $ref: '#/components/schemas/CategoryRef' + Query.name: + description: As defined in clause 8.1.2.3. + name: name + in: query + required: true + x-exportParamName: Query.name + schema: + type: string + Query.description: + description: As defined in clause 8.1.2.3. + name: description + in: query + required: false + x-exportParamName: Query.description + schema: + type: string + Query.type: + description: As defined in clause 8.1.2.3. + name: type + in: query + required: true + x-exportParamName: Query.type + schema: + $ref: '#/components/schemas/TransportType' + Query.protocol: + description: As defined in clause 8.1.2.3. + name: protocol + in: query + required: true + x-exportParamName: Query.protocol + schema: + type: string + Query.version: + description: As defined in clause 8.1.2.3. + name: version + in: query + required: true + x-exportParamName: Query.version + schema: + type: string + Query.security: + description: As defined in clause 8.1.2.3. + name: security + in: query + required: true + x-exportParamName: Query.security + schema: + $ref: '#/components/schemas/SecurityInfo' + Query.implSpecificInfo: + description: As defined in clause 8.1.2.3. + name: implSpecificInfo + in: query + required: false + x-exportParamName: Query.implSpecificInfo + schema: + $ref: '#/components/schemas/Not' + Query.serializer1: + description: As defined in clause 8.1.2.2. + name: serializer1 + in: query + required: false + x-exportParamName: Query.serializer1 + schema: + $ref: '#/components/schemas/SerializerType' + Query.state1: + description: As defined in clause 8.1.2.2. + name: state1 + in: query + required: false + x-exportParamName: Query.state1 + schema: + $ref: '#/components/schemas/ServiceState' + Query.category1: + description: As defined in clause 8.1.5.2. + name: category1 + in: query + required: false + x-exportParamName: Query.category1 schema: - type: boolean + $ref: '#/components/schemas/CategoryRef'