You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Adopted Edge Cloud Zone name.
Adjusting errors detected in Linter for paths name for /app-instance and duplicated method which has been fixed including Delete method in /app-instance/{appId}. Method /app-instace/{appInstanceId} deleted.
Copy file name to clipboardexpand all lines: code/API_definitions/EdgeCloud_LcM.yaml
+41-37
Original file line number
Diff line number
Diff line change
@@ -7,8 +7,8 @@ info:
7
7
# Introduction
8
8
APIs defined in this version of the specification can be categorized into the following areas:
9
9
* __Application__ - The Application Provider submit application metadata to the Operator Platform.
10
-
* __Application Instance__ - An Operator Platform instantiate an Application on an Edge Cloud Node when the Application Provider resquest it.
11
-
* __Edge Cloud information__ - Retrieves all the Edge nodes available according to some defined parameters.
10
+
* __Application Instance__ - An Operator Platform instantiate an Application on an Edge Cloud Zone when the Application Provider resquest it.
11
+
* __Edge Cloud information__ - Retrieves all the Edge Cloud Zones available according to some defined parameters.
12
12
# Relevant terms and definitions
13
13
This section provides definitions of terminologies commonly referred to throughout the API descriptions.
14
14
@@ -25,12 +25,12 @@ info:
25
25
* __getApp__ - Retrieves the information of a given application.
26
26
27
27
__Application Instance Management__
28
-
* __appInstantiation__ Request the OP to instatiate an instance of an application in a given Edge Cloud Node, if this parameter is not set, the OP will instantiate the applications in all the Edge Cloud Nodes available.
28
+
* __appInstantiation__ Request the OP to instatiate an instance of an application in a given Edge Cloud Zone, if this parameter is not set, the OP will instantiate the applications in all the Edge Cloud Zones available.
29
29
* __getAppInstance__ Retrieves the list with information of the instances related to a given application.
30
-
* __deleteAppInstance__ - Removes a given application instance from an Edge Cloud Node.
30
+
* __deleteAppInstance__ - Removes a given application instance from an Edge Cloud Zone.
31
31
32
32
__Edge Cloud information__
33
-
* __getEdgeCloudNodes__ List of the operator’s Edge Cloud Nodes and their status, ordering the results by location and filtering by status (active/inactive/unknown)
33
+
* __getEdgeCloudZones__ List of the operator’s Edge Cloud Zones and their status, ordering the results by location and filtering by status (active/inactive/unknown)
34
34
# Further info and support
35
35
(FAQs will be added in a later version of the documentation)
description: Ask the OP to instantiate an application to one or several Edge Cloud Nodes with an Application as an input and an Application Instance as the output.
76
+
description: Ask the OP to instantiate an application to one or several Edge Cloud Zones with an Application as an input and an Application Instance as the output.
77
77
operationId: appInstantiation
78
78
requestBody:
79
79
description: Details regarding where the application should be instantiated
@@ -119,7 +119,7 @@ paths:
119
119
$ref: '#/components/responses/501'
120
120
'503':
121
121
$ref: '#/components/responses/503'
122
-
/appInstance/{appId}:
122
+
/app-instance/{appId}:
123
123
get:
124
124
tags:
125
125
- Application Instance
@@ -139,14 +139,14 @@ paths:
139
139
required: false
140
140
schema:
141
141
$ref: '#/components/schemas/AppInstanceId'
142
-
- name: edgeCloudName
143
-
description: Edge Cloud Node Name - an identifier for an edge cloud node in the operator domain
142
+
- name: EdgeCloudZone
143
+
description: An identifier name for an Edge Cloud Zone in the operator domain
144
144
in: query
145
145
required: false
146
146
schema:
147
-
$ref: '#/components/schemas/EdgeCloudNodeName'
147
+
$ref: '#/components/schemas/EdgeCloudZone'
148
148
- name: regionId
149
-
description: Human readable name of the geografical zone of the Edge Cloud Node. Defined by the OP.
149
+
description: Human readable name of the geografical region of the Edge Cloud. Defined by the OP.
150
150
in: query
151
151
required: false
152
152
schema:
@@ -176,17 +176,21 @@ paths:
176
176
$ref: '#/components/responses/500'
177
177
'503':
178
178
$ref: '#/components/responses/503'
179
-
180
-
/appInstance/{appInstanceId}:
181
179
delete:
182
180
tags:
183
181
- Application Instance
184
182
summary: Terminate an Application Instance
185
-
description: Terminate a running instance of an application within an Edge Cloud Node
183
+
description: Terminate a running instance of an application within an Edge Cloud Zone
186
184
operationId: deleteAppInstance
187
185
parameters:
188
-
- name: appInstanceId
186
+
- name: appId
187
+
description: A globally unique identifier associated with the application. OP generates this identifier when the application is submitted over NBI.
189
188
in: path
189
+
required: true
190
+
schema:
191
+
$ref: '#/components/schemas/AppId'
192
+
- name: appInstanceId
193
+
in: query
190
194
description: Identificator of the specific application instance that will be terminated
191
195
required: true
192
196
schema:
@@ -334,16 +338,16 @@ paths:
334
338
'503':
335
339
$ref: '#/components/responses/503'
336
340
337
-
/edge-cloud-nodes:
341
+
/edge-cloud-zones:
338
342
get:
339
343
tags:
340
344
- Edge Cloud
341
-
summary: Retrieve a list of the operator’s Edge Clouds and their status
342
-
description: List of the operator’s Edge Clouds and their status, ordering the results by location and filtering by status (active/inactive/unknown)
343
-
operationId: getEdgeCloudNodes
345
+
summary: Retrieve a list of the operator’s Edge Cloud Zones and their status
346
+
description: List of the operator’s Edge Cloud Zones and their status, ordering the results by location and filtering by status (active/inactive/unknown)
347
+
operationId: getEdgeCloudZones
344
348
parameters:
345
349
- name: regionId
346
-
description: Human readable name of the geografical zone of the Edge Cloud. Defined by the OP.
350
+
description: Human readable name of the geografical region of the Edge Cloud. Defined by the OP.
347
351
in: query
348
352
required: false
349
353
schema:
@@ -355,13 +359,13 @@ paths:
355
359
$ref: '#/components/schemas/Status'
356
360
responses:
357
361
'200':
358
-
description: Available Edge Cloud Nodes
362
+
description: Available Edge Cloud Zones
359
363
content:
360
364
application/json:
361
365
schema:
362
366
type: array
363
367
items:
364
-
$ref: '#/components/schemas/EdgeCloudNodeDetails'
368
+
$ref: '#/components/schemas/EdgeCloudZoneDetails'
365
369
minItems: 1
366
370
'401':
367
371
$ref: '#/components/responses/401'
@@ -399,8 +403,8 @@ components:
399
403
properties:
400
404
appId:
401
405
$ref: '#/components/schemas/AppId'
402
-
edgeCloudNodeName:
403
-
$ref: '#/components/schemas/EdgeCloudNodeName'
406
+
EdgeCloudZone:
407
+
$ref: '#/components/schemas/EdgeCloudZone'
404
408
regionId:
405
409
$ref: '#/components/schemas/RegionId'
406
410
required:
@@ -516,8 +520,8 @@ components:
516
520
properties:
517
521
appInstanceId:
518
522
$ref: '#/components/schemas/AppInstanceId'
519
-
edgeCloudNodeName:
520
-
$ref: '#/components/schemas/EdgeCloudNodeName'
523
+
EdgeCloudZone:
524
+
$ref: '#/components/schemas/EdgeCloudZone'
521
525
status:
522
526
description: Status of the application instance (default is 'unknown')
523
527
type: string
@@ -544,8 +548,8 @@ components:
544
548
accessPoints:
545
549
$ref: '#/components/schemas/AccessEndpoint'
546
550
minItems: 1
547
-
EdgeCloudNodeName:
548
-
description: Edge Cloud Node Name - an identifier for an edge cloud node in the operator domain
551
+
EdgeCloudZone:
552
+
description: An identifier name for an Edge Cloud Zone in the operator domain
549
553
type: string
550
554
AccessEndpoint:
551
555
type: object
@@ -608,13 +612,13 @@ components:
608
612
- code
609
613
- message
610
614
611
-
EdgeCloudNodeDetails:
615
+
EdgeCloudZoneDetails:
612
616
type: object
613
617
required:
614
618
- geolocation
615
619
properties:
616
-
edgeCloudNodeName:
617
-
$ref: '#/components/schemas/EdgeCloudNodeName'
620
+
EdgeCloudZone:
621
+
$ref: '#/components/schemas/EdgeCloudZone'
618
622
status:
619
623
$ref: '#/components/schemas/Status'
620
624
region:
@@ -660,10 +664,10 @@ components:
660
664
661
665
RegionId:
662
666
type: string
663
-
description: Human readable name of the geografical zone of the Edge Cloud Node. Defined by the OP.
667
+
description: Human readable name of the geografical region of the Edge Cloud. Defined by the OP.
664
668
665
669
Status:
666
-
description: Status of the Edge Cloud Node (default is 'unknown')
670
+
description: Status of the Edge Cloud Zone (default is 'unknown')
description: A Uniform Resource Identifier (URI) as per RFC 3986, identifies the endpoint within an Edge Cloud Node where the user equipment may connect to the selected application instance
686
+
description: A Uniform Resource Identifier (URI) as per RFC 3986, identifies the endpoint within an Edge Cloud Zone where the user equipment may connect to the selected application instance
0 commit comments