Skip to content

Commit 09857fe

Browse files
Update EdgeCloud_LcM.yaml v0.9.1
Region and Edge Cloud Zone description updated. Parameters with UUID format have an Id at the end. Parameters with String format do not, that is why we decided to change RegionId to Region.
1 parent 99cc877 commit 09857fe

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

code/API_definitions/EdgeCloud_LcM.yaml

+12-11
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,10 @@ info:
1515
* __Application Provider__ - The provider of the application that accesses an OP to deploy its application on the Edge Cloud. An Application Provider may be part of a larger organisation, like an enterprise, enterprise customer of an OP, or be an independent entity.
1616
* __Application__ - Contains the information about the application to be instantiated. Descriptor, binary image, charts or any other package assosiated with the application. The Application Provider request contains mandatory criteria (e.g. required CPU, memory,
1717
storage, bandwidth) defined in an Application.
18-
* __OP__ - Operator Platform. An Operator Platform (facilitates access to the Edge Cloud and other capabilities of an Operator or federation of Operators and Partners. Defined by [GSMA in OPG.02](https://www.gsma.com/futurenetworks/wp-content/uploads/2023/07/OPG.02-v5.0-Operator-Platform-Requirements-and-Architecture.pdf)
19-
* __Region__ - Human readable name of the geografical zone of the Edge Cloud. Defined by the OP.
2018
* __Edge Cloud__ - Cloud-like capabilities located at the network edge including, from the Application Provider's perspective, access to elastically allocated compute, data storage and network resources.
19+
* __Edge Cloud Zone__ - An Edge Cloud Zone is the lowest level of abstraction exposed to an Application Provider who wants to deploy an Application on Edge Cloud. Zones exist within a Region.
20+
* __OP__ - Operator Platform. An Operator Platform (facilitates access to the Edge Cloud and other capabilities of an Operator or federation of Operators and Partners. Defined by [GSMA in OPG.02](https://www.gsma.com/futurenetworks/wp-content/uploads/2023/07/OPG.02-v5.0-Operator-Platform-Requirements-and-Architecture.pdf)
21+
* __Region__ - An OP Region is equivalent to a Region on a public cloud. The higher construct in the hierarchy exposed to an Application Provider who wishes to deploy an Application on the Edge Cloud and broadly represents a geography. A Region typically contains one or multiple Zones. A Region exists within an Edge Cloud.
2122
# API Functionality
2223
__Application Management__
2324
* __submitApp__ - Submits an application details to an OP. Based on the details provided, OP shall do bookkeeping, resource validation and other pre-deployment operations.
@@ -145,12 +146,12 @@ paths:
145146
required: false
146147
schema:
147148
$ref: '#/components/schemas/EdgeCloudZone'
148-
- name: regionId
149+
- name: region
149150
description: Human readable name of the geografical region of the Edge Cloud. Defined by the OP.
150151
in: query
151152
required: false
152153
schema:
153-
$ref: '#/components/schemas/RegionId'
154+
$ref: '#/components/schemas/Region'
154155
responses:
155156
'200':
156157
description: Information of Aplication Instances
@@ -346,12 +347,12 @@ paths:
346347
description: List of the operator’s Edge Cloud Zones and their status, ordering the results by location and filtering by status (active/inactive/unknown)
347348
operationId: getEdgeCloudZones
348349
parameters:
349-
- name: regionId
350+
- name: region
350351
description: Human readable name of the geografical region of the Edge Cloud. Defined by the OP.
351352
in: query
352353
required: false
353354
schema:
354-
$ref: '#/components/schemas/RegionId'
355+
$ref: '#/components/schemas/Region'
355356
- name: status
356357
in: query
357358
required: false
@@ -405,8 +406,8 @@ components:
405406
$ref: '#/components/schemas/AppId'
406407
EdgeCloudZone:
407408
$ref: '#/components/schemas/EdgeCloudZone'
408-
regionId:
409-
$ref: '#/components/schemas/RegionId'
409+
region:
410+
$ref: '#/components/schemas/Region'
410411
required:
411412
- appId
412413

@@ -549,7 +550,7 @@ components:
549550
$ref: '#/components/schemas/AccessEndpoint'
550551
minItems: 1
551552
EdgeCloudZone:
552-
description: An identifier name for an Edge Cloud Zone in the operator domain
553+
description: Human readable name of the zone of the Edge Cloud. Defined by the OP.
553554
type: string
554555
AccessEndpoint:
555556
type: object
@@ -622,7 +623,7 @@ components:
622623
status:
623624
$ref: '#/components/schemas/Status'
624625
region:
625-
$ref: '#/components/schemas/RegionId'
626+
$ref: '#/components/schemas/Region'
626627

627628
minItems: 1
628629

@@ -662,7 +663,7 @@ components:
662663
- OS_LICENSE_TYPE_ON_DEMAND
663664
- OTHER
664665

665-
RegionId:
666+
Region:
666667
type: string
667668
description: Human readable name of the geografical region of the Edge Cloud. Defined by the OP.
668669

0 commit comments

Comments
 (0)