From ec2b0785fb5472ad79353d79397a70583eb513b0 Mon Sep 17 00:00:00 2001 From: group_31_bot_3987b21aca711ada7a62244c5bebe985 Date: Fri, 27 Jun 2025 15:37:39 +0200 Subject: [PATCH] Autogenerated openapi version v030101 --- MEC040_fedEnablement.yaml | 219 ++++++++++++++++++++++---------------- 1 file changed, 125 insertions(+), 94 deletions(-) diff --git a/MEC040_fedEnablement.yaml b/MEC040_fedEnablement.yaml index 63170c9..0e93a5e 100644 --- a/MEC040_fedEnablement.yaml +++ b/MEC040_fedEnablement.yaml @@ -1,31 +1,30 @@ openapi: 3.1.0 +jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema info: contact: url: https://forge.etsi.org/rep/mec/gs040-fed-enablement-api - version: 3.1.1 title: ETSI GS MEC 040 - MEC Federation enablement APIs - description: The ETSI MEC ISG MEC040 Federation enablement API described using OpenAPI + description: 'The ETSI MEC ISG MEC040 Federation enablement API described using OpenAPI + + ' license: name: BSD-3-Clause - url: 'https://forge.etsi.org/legal-matters' -externalDocs: - description: ETSI GS MEC 040 Federation enablement API, v3.1.1 - url: https://www.etsi.org/deliver/etsi_gs/MEC/001_099/040/03.01.01_60/gs_mec040v030101p.pdf + url: https://forge.etsi.org/legal-matters + version: 3.1.1 servers: -- url: https://localhost/fed-enablement/v1 - +- url: https://localhost/fed_enablement/v1 paths: /fed_resources/system_info: get: summary: Retrieve a list of system_info resources (see clause 6 for data model) of federation members. description: The GET method retrieves the information of a list of system_info resources of federation members. This method is typically used in the sequence of "MEC system discovery" as described in clause 5.2.2.2. The method shall comply with the URI query parameters, request and response data structures, and response codes, as specified in Tables 7.3.3.1-1 and 7.3.3.1-2. - operationId: systeminfoGET + operationId: FedresourcesSysteminfoGET tags: - systemInfo parameters: - - $ref: '#/components/parameters/Query.systemId' - - $ref: '#/components/parameters/Query.systemName' - - $ref: '#/components/parameters/Query.systemProvider' + - $ref: '#/components/parameters/Query.Systemid' + - $ref: '#/components/parameters/Query.Systemname' + - $ref: '#/components/parameters/Query.Systemprovider' responses: '200': description: It is used to indicate that the query for retrieving system_info resource(s) is successful. Response body containing one or multiple system_info resources shall be returned. @@ -46,7 +45,7 @@ paths: post: summary: Create new system_info resource for a given MEC system. description: "The POST method creates the information of system_info resources to the MEC federator. This method is typically used in the sequence of \"Registration of MEC system to the federation\" as described in clause 5.2.2.1. The method shall comply with the URI query parameters, request and response data structures, and response codes, as specified in Tables\_7.3.3.4-1 and 7.3.3.4-2." - operationId: systeminfoPOST + operationId: FedresourcesSysteminfoPOST tags: - systemInfo requestBody: @@ -80,15 +79,14 @@ paths: $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' + parameters: [] /fed_resources/system_info/{systemId}: get: summary: Retrieve the system_info resource of the federation member with systemId as its system identifier. description: The GET method retrieves the system_info resource information. This method is typically used in the sequence of "MEC system discovery" as described in clause 5.2.2.2. The method shall comply with the URI query parameters, request and response data structures, and response codes, as specified in Tables 7.4.3.1-1 and 7.4.3.1-2. - operationId: systeminfoByIdGET + operationId: FedresourcesSysteminfoGETSystemid tags: - systemInfo - parameters: - - $ref: '#/components/parameters/Path.systemId' responses: '200': description: It is used to indicate that the query for retrieving system_info resource is successful. Response body containing one system_info resource shall be returned. @@ -107,14 +105,19 @@ paths: $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' + parameters: + - name: systemId + in: path + required: true + description: The unique identifier of the systemId. + schema: + type: string patch: summary: Update the system_info resource for a given MEC system. description: The PATCH method updates the information of system_info resources stored in the MEC federator through previous registration. This method is typically used in the sequence of "Update of MEC system to the federation" as described in clause 5.2.2.2. The method shall comply with the URI query parameters, request and response data structures, and response codes, as specified in Tables 7.4.3.3-1 and 7.4.3.3-2. - operationId: systeminfoByIdPATCH + operationId: FedresourcesSysteminfoPATCHSystemid tags: - systemInfo - parameters: - - $ref: '#/components/parameters/Path.systemId' requestBody: description: It contains attributes to be update. required: true @@ -143,14 +146,19 @@ paths: $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' + parameters: + - name: systemId + in: path + required: true + description: The unique identifier of the systemId. + schema: + type: string delete: summary: Delete the system_info resource for a given MEC system. description: The DELETE method deletes the information of system_info resources stored in the MEF. This method is typically used in the sequence of "Deregistration of MEC system to the federation" as described in clause 5.2.2.1.1. The method shall comply with the URI query parameters, request and response data structures, and response codes, as specified in Tables 7.4.3.5-1 and 7.4.3.5-2. - operationId: systeminfoByIdDELETE + operationId: FedresourcesSysteminfoDELETESystemid tags: - systemInfo - parameters: - - $ref: '#/components/parameters/Path.systemId' responses: '204': $ref: '#/components/responses/204' @@ -162,6 +170,13 @@ paths: $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' + parameters: + - name: systemId + in: path + required: true + description: The unique identifier of the systemId. + schema: + type: string components: schemas: ProblemDetails: @@ -181,19 +196,66 @@ components: detail: type: string description: A human-readable explanation specific to this occurrence of the problem - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String instance: type: string format: uri description: A URI reference that identifies the specific occurrence of the problem + Addresses: + description: Entry point information of the service as one or more pairs of IP address and port. See note. + type: object + minItems: 0 + properties: + host: + description: Host portion of the address. + type: string + port: + description: Port portion of the address. + type: integer + required: + - host + - port + LinkType: + type: object + required: + - href + properties: + href: + type: string + format: uri + description: The hyperlink reference. + EndPointInfo: + x-etsi-ref: 8.1.5.3 + type: object + properties: + uris: + description: Entry point information of the service as string, formatted according to URI syntax (see IETF RFC 3986 [8]). Shall be used for REST APIs. See note. + type: array + minItems: 0 + items: + type: string + fqdn: + description: Fully Qualified Domain Name of the service. See note. + type: array + minItems: 0 + items: + type: string + addresses: + type: array + items: + $ref: '#/components/schemas/Addresses' + alternative: + description: "Entry point information of the service in a format defined by an implementation, or in an external specification. See\_note." + type: object + description: "|-\n NOTE:\tExactly one of \"uris\", \"fqdn\", \"addresses\" or \"alternative\" shall be present." SystemInfo: - title: SystemInfo + x-etsi-ref: 6.2.2 type: object - description: This type represents an information provided by the MEC orchestrator as a part of the "Registration of MEC system to the federation" properties: systemId: - description: 'Identifier of the MEC system. For the uniqueness of the identifier across the federated MEC systems, UUID format [i.9] is recommended. Shall be absent in POST request, and present otherwise.' + description: 'Identifier of the MEC system. For the uniqueness of the identifier across the federated MEC systems, UUID format [i.9] is recommended. + + + Shall be absent in POST request, and present otherwise.' type: string systemName: description: The name of the MEC system. This is how the MEC system identifies other MEC systems @@ -206,30 +268,19 @@ components: - systemName - systemProvider SystemInfoUpdate: - title: SystemInfoUpdate + x-etsi-ref: 6.2.3 type: object - description: | - This type represents an information provided by MEC orchestrator as a part of the - "Update of MEC system(s) to the federation". - - NOTE: At least one attribute shall exist. properties: systemName: description: The name of the MEC system. This is how the MEC system identifies other MEC systems. type: string endpoint: - # description': Endpoint information (e.g. URI, FQDN, IP address) of MEC federator. + description: Endpoint information (e.g. URI, FQDN, IP address) of MEC federator. $ref: '#/components/schemas/EndPointInfo' - # x-etsi-mec-origin-type': EndPointInfo - # x-etsi-mec-cardinality': 0..1 - EndPointInfo: - title: EndPointInfo - type: string - description: Endpoint information (e.g. URI, FQDN, IP address) of MEC federator. + description: "|-\n NOTE:\tAt least one attribute shall exist." SystemUpdateNotificationSubscription: - title: SystemUpdateNotificationSubscription + x-etsi-ref: 6.3.2 type: object - description: This type represents a subscription to the notifications from the MEC federator related to information update of the MEC systems in the MEC federation. properties: subscriptionType: description: Shall be set to "SystemUpdateNotificationSubscription". @@ -238,8 +289,8 @@ components: description: URI selected by the MEC orchestrator to receive notifications on the subscribed MEC system information updates in the MEC federation. This shall be included in both the request and the response. type: string format: uri - links: - $ref: '#/components/schemas/links' + _links: + $ref: '#/components/schemas/_links' systemId: description: Identifier(s) to uniquely specify the target MEC system(s) for the subscription. If absent, the subscription should include all MEC systems in the MEC federation. type: array @@ -247,17 +298,14 @@ components: items: type: string expiryDeadline: - # description': The expiration time of the subscription determined by the MEC Federation Enablement Service. + description: The expiration time of the subscription determined by the MEC Federation Enablement Service. $ref: '#/components/schemas/TimeStamp' - # x-etsi-mec-origin-type': TimeStamp - # x-etsi-mec-cardinality': 0..1 required: - subscriptionType - callbackReference SystemUpdateNotification: - title: SystemUpdateNotification + x-etsi-ref: 6.4.2 type: object - description: This type represents the information that the MEC federator notifies the subscribed MEC orchestrator about the information update of the MEC systems in the MEC federation. properties: notificationType: description: Shall be set to "SystemUpdateNotification". @@ -268,16 +316,15 @@ components: minItems: 1 items: $ref: '#/components/schemas/SystemInfo' - links: - $ref: '#/components/schemas/links1' + _links: + $ref: '#/components/schemas/_links1' required: - notificationType - updatedSystemInfo - - links + - _links TimeStamp: - title: TimeStamp + x-etsi-ref: 6.5.2 type: object - description: The expiration time of the subscription determined by the MEC Federation Enablement Service. properties: seconds: description: The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC. @@ -290,42 +337,27 @@ components: required: - seconds - nanoSeconds - links: - title: links + _links: description: Object containing hyperlinks related to the resource. This shall only be included in the HTTP responses. type: object properties: self: - #description': Self-referring URI. The URI shall be unique within the MEC Federation Enablement API as it acts as an ID for the subscription (SubscriptionId). + description: Self-referring URI. The URI shall be unique within the MEC Federation Enablement API as it acts as an ID for the subscription (SubscriptionId). $ref: '#/components/schemas/LinkType' - # x-etsi-mec-origin-type': LinkType - # x-etsi-mec-cardinality': '1' required: - self - links1: - title: links1 + _links1: description: Object containing hyperlinks related to the resource. type: object properties: subscription: - # description': A link to the related subscription. + description: A link to the related subscription. $ref: '#/components/schemas/LinkType' - # x-etsi-mec-origin-type': LinkType - # x-etsi-mec-cardinality': '1' required: - subscription - LinkType: - title: LinkType - description: Self-referring URI. The URI shall be unique within the MEC Federation Enablement API as it acts as an ID for the subscription (SubscriptionId). - type: object - properties: - href: - description: URI referring to a resource. - format: uri - type: string - required: - - href responses: + '200': + description: OK '204': description: No Content '400': @@ -335,7 +367,7 @@ components: schema: $ref: '#/components/schemas/ProblemDetails' '401': - description: 'Unauthorized: used when the client did not submit credentials.' + description: 'Unauthorized: used when the request is not authenticated, e.g. when the client did not submit credentials.' content: application/problem+json: schema: @@ -352,42 +384,41 @@ components: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' + '412': + description: 'Precondition failed: used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' parameters: - Query.systemId: + Query.Systemid: description: Identifier of the MEC system. - name: systemId + name: systemid in: query required: false - x-exportParamName: Query.systemId + x-exportParamName: Query.Systemid schema: type: array items: type: string - Path.systemId: - description: Identifier of the MEC system. - name: systemId - in: path - required: true - x-exportParamName: Path.systemId - schema: - type: string - Query.systemName: + Query.Systemname: description: The name of the MEC system. - name: systemName + name: systemname in: query required: false - x-exportParamName: Query.systemName + x-exportParamName: Query.Systemname schema: type: array items: type: string - Query.systemProvider: + Query.Systemprovider: description: Provider of the MEC system. - name: systemProvider + name: systemprovider in: query required: false - x-exportParamName: Query.systemProvider + x-exportParamName: Query.Systemprovider schema: type: array items: - type: string \ No newline at end of file + type: string + -- GitLab