Skip to content

Commit 99cc877

Browse files
Update EdgeCloud_LcM.yaml version 0.9.1
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.
1 parent d15b717 commit 99cc877

File tree

1 file changed

+41
-37
lines changed

1 file changed

+41
-37
lines changed

code/API_definitions/EdgeCloud_LcM.yaml

+41-37
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ info:
77
# Introduction
88
APIs defined in this version of the specification can be categorized into the following areas:
99
* __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.
1212
# Relevant terms and definitions
1313
This section provides definitions of terminologies commonly referred to throughout the API descriptions.
1414

@@ -25,12 +25,12 @@ info:
2525
* __getApp__ - Retrieves the information of a given application.
2626

2727
__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.
2929
* __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.
3131

3232
__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)
3434
# Further info and support
3535
(FAQs will be added in a later version of the documentation)
3636

@@ -40,7 +40,7 @@ info:
4040
license:
4141
name: Apache 2.0
4242
url: https://www.apache.org/licenses/LICENSE-2.0.html
43-
version: 0.2.0
43+
version: 0.9.1
4444
externalDocs:
4545
description: Product documentation at Camara
4646
url: https://github.com/camaraproject/
@@ -65,15 +65,15 @@ tags:
6565
- name: Application Instance
6666
description: Application Instance Management
6767
- name: Edge Cloud
68-
description: Edge Cloud Nodes Available
68+
description: Edge Cloud Zones Available
6969

7070
paths:
71-
/appInstance:
71+
/app-instance:
7272
post:
7373
tags:
7474
- Application Instance
7575
summary: Instantiation of an Application
76-
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.
7777
operationId: appInstantiation
7878
requestBody:
7979
description: Details regarding where the application should be instantiated
@@ -119,7 +119,7 @@ paths:
119119
$ref: '#/components/responses/501'
120120
'503':
121121
$ref: '#/components/responses/503'
122-
/appInstance/{appId}:
122+
/app-instance/{appId}:
123123
get:
124124
tags:
125125
- Application Instance
@@ -139,14 +139,14 @@ paths:
139139
required: false
140140
schema:
141141
$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
144144
in: query
145145
required: false
146146
schema:
147-
$ref: '#/components/schemas/EdgeCloudNodeName'
147+
$ref: '#/components/schemas/EdgeCloudZone'
148148
- 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.
150150
in: query
151151
required: false
152152
schema:
@@ -176,17 +176,21 @@ paths:
176176
$ref: '#/components/responses/500'
177177
'503':
178178
$ref: '#/components/responses/503'
179-
180-
/appInstance/{appInstanceId}:
181179
delete:
182180
tags:
183181
- Application Instance
184182
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
186184
operationId: deleteAppInstance
187185
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.
189188
in: path
189+
required: true
190+
schema:
191+
$ref: '#/components/schemas/AppId'
192+
- name: appInstanceId
193+
in: query
190194
description: Identificator of the specific application instance that will be terminated
191195
required: true
192196
schema:
@@ -334,16 +338,16 @@ paths:
334338
'503':
335339
$ref: '#/components/responses/503'
336340

337-
/edge-cloud-nodes:
341+
/edge-cloud-zones:
338342
get:
339343
tags:
340344
- 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
344348
parameters:
345349
- 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.
347351
in: query
348352
required: false
349353
schema:
@@ -355,13 +359,13 @@ paths:
355359
$ref: '#/components/schemas/Status'
356360
responses:
357361
'200':
358-
description: Available Edge Cloud Nodes
362+
description: Available Edge Cloud Zones
359363
content:
360364
application/json:
361365
schema:
362366
type: array
363367
items:
364-
$ref: '#/components/schemas/EdgeCloudNodeDetails'
368+
$ref: '#/components/schemas/EdgeCloudZoneDetails'
365369
minItems: 1
366370
'401':
367371
$ref: '#/components/responses/401'
@@ -399,8 +403,8 @@ components:
399403
properties:
400404
appId:
401405
$ref: '#/components/schemas/AppId'
402-
edgeCloudNodeName:
403-
$ref: '#/components/schemas/EdgeCloudNodeName'
406+
EdgeCloudZone:
407+
$ref: '#/components/schemas/EdgeCloudZone'
404408
regionId:
405409
$ref: '#/components/schemas/RegionId'
406410
required:
@@ -516,8 +520,8 @@ components:
516520
properties:
517521
appInstanceId:
518522
$ref: '#/components/schemas/AppInstanceId'
519-
edgeCloudNodeName:
520-
$ref: '#/components/schemas/EdgeCloudNodeName'
523+
EdgeCloudZone:
524+
$ref: '#/components/schemas/EdgeCloudZone'
521525
status:
522526
description: Status of the application instance (default is 'unknown')
523527
type: string
@@ -544,8 +548,8 @@ components:
544548
accessPoints:
545549
$ref: '#/components/schemas/AccessEndpoint'
546550
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
549553
type: string
550554
AccessEndpoint:
551555
type: object
@@ -608,13 +612,13 @@ components:
608612
- code
609613
- message
610614

611-
EdgeCloudNodeDetails:
615+
EdgeCloudZoneDetails:
612616
type: object
613617
required:
614618
- geolocation
615619
properties:
616-
edgeCloudNodeName:
617-
$ref: '#/components/schemas/EdgeCloudNodeName'
620+
EdgeCloudZone:
621+
$ref: '#/components/schemas/EdgeCloudZone'
618622
status:
619623
$ref: '#/components/schemas/Status'
620624
region:
@@ -660,10 +664,10 @@ components:
660664

661665
RegionId:
662666
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.
664668

665669
Status:
666-
description: Status of the Edge Cloud Node (default is 'unknown')
670+
description: Status of the Edge Cloud Zone (default is 'unknown')
667671
type: string
668672
enum:
669673
- active
@@ -679,7 +683,7 @@ components:
679683
Uri:
680684
type: string
681685
example: https://charts.bitnami.com/bitnami/helm/example-chart:0.1.0
682-
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
683687

684688
responses:
685689
'400':

0 commit comments

Comments
 (0)