Skip to content

Commit 10e59a4

Browse files
authored
Fixed linter errors/ fixed edge cloud zone scheme
1 parent 493742d commit 10e59a4

File tree

1 file changed

+44
-26
lines changed

1 file changed

+44
-26
lines changed

code/API_definitions/Discovery/simple_edge_discovery.yaml

+44-26
Original file line numberDiff line numberDiff line change
@@ -12,23 +12,24 @@ info:
1212
Cloud Zone to a particular user device.
1313
1414
# Purpose
15-
Network operators may host multiple Multi-access Edge Cloud Zones in a given
16-
territory. Connecting your application to a server on the closest Edge Cloud
17-
Zone means packets travel the shortest distance between endpoints,
18-
typically resulting in the lowest round-trip latency. Note, the physical
19-
(GPS) location of a user device is not a reliable way to determine the
20-
closest Edge Cloud Zone, due to the way operator networks are routed - so the
21-
operator will calculate the Edge Cloud Zone with the _shortest network path_
22-
to the network-attached device identified in the API request.
15+
Network operators may host multiple Multi-access Edge Cloud Zones in a
16+
given territory. Connecting your application to a server on the closest
17+
Edge Cloud Zone means packets travel the shortest distance between
18+
endpoints, typically resulting in the lowest round-trip latency. Note, the
19+
physical (GPS) location of a user device is not a reliable way to determine
20+
the closest Edge Cloud Zone, due to the way operator networks are routed -
21+
so the operator will calculate the Edge Cloud Zone with the
22+
_shortest network path_to the network-attached device identified in the API
23+
request.
2324
2425
Once you have the name of the closest Edge Cloud Zone to the user device,
2526
you may:
2627
2728
* connect the application client on the user device to your application
2829
server instance on that Edge Cloud Zone. Note: the address of that server
2930
instance is not part of the API response, but should be known in advance.
30-
* or, if you have no instance on that Edge Cloud Zone, you may wish to deploy
31-
one there.
31+
* or, if you have no instance on that Edge Cloud Zone, you may wish to
32+
deploy one there.
3233
3334
# Usage
3435
@@ -91,8 +92,10 @@ info:
9192
9293
## Success
9394
94-
A JSON object is returned containing an array with a single member object. This contains identifiers for the closest Edge Cloud Zone. The HTTP
95-
status code will be`200 OK`. An example response:
95+
A JSON object is returned containing an array with a single member object.
96+
This contains identifiers for the closest Edge Cloud Zone. The HTTP status
97+
code will be`200 OK`. An example response:
98+
9699
```
97100
[
98101
{
@@ -145,7 +148,9 @@ info:
145148
# Authorization and authentication
146149
147150
CAMARA guidelines defines a set of authorization flows which can grant API
148-
clients access to the API functionality, as outlined in the document [CAMARA-API-access-and-user-consent.md](https://github.com/camaraproject/IdentityAndConsentManagement/blob/main/documentation/CAMARA-API-access-and-user-consent.md).
151+
clients access to the API functionality, as outlined in the document
152+
[CAMARA-API-access-and-user-consent.md]
153+
(https://github.com/camaraproject/IdentityAndConsentManagement/blob/main/documentation/CAMARA-API-access-and-user-consent.md).
149154
Which specific authorization flows are to be used will be determined during
150155
onboarding process, happening between the API Client and the Telco Operator
151156
exposing the API, taking into account the declared purpose for accessing
@@ -218,8 +223,10 @@ paths:
218223
type: string
219224
format: ipv4/ipv6
220225
oneOf:
221-
- pattern: '^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$'
222-
- pattern: '^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f][0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))$'
226+
- pattern: '^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]
227+
)\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$'
228+
- pattern: '^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f]
229+
[0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))$'
223230

224231
- name: Network-Access-Identifier
225232
in: header
@@ -237,8 +244,8 @@ paths:
237244
required: false
238245
description: |
239246
MSISDN in E.164 format (starting with country code) of
240-
the mobile subscription being used by the device. Optionally prefixed
241-
with '+'.
247+
the mobile subscription being used by the device. Optionally
248+
prefixed with '+'.
242249
schema:
243250
type: string
244251
pattern: '^\+?[0-9]{5,15}$'
@@ -319,23 +326,34 @@ components:
319326
that egde cloud zone).
320327
type: object
321328
properties:
329+
edgeCloudZoneId:
330+
$ref: "#/components/schemas/EdgeCloudZoneId"
331+
edgeCloudZoneName:
332+
$ref: "#/components/schemas/EdgeCloudZoneName"
322333
edgeCloudProvider:
323-
$ref: "#/components/schemas/EdgeCloudProvider"
324-
edgeResourceName:
325-
$ref: "#/components/schemas/EdgeResource"
334+
$ref: "#/components/schemas/EdgeCloudProvider"
326335

327-
EdgeCloudProvider:
336+
EdgeCloudZoneId:
328337
description: |
329-
The company name of the Edge Cloud Zone provider.
338+
Operator-issued UUID for the Edge Cloud Zone.
330339
type: string
340+
format: uuid
341+
additionalProperties: false
342+
331343

332-
EdgeResource:
344+
EdgeCloudZoneName:
333345
description: |
334-
Edge Resource Name - an identifier for an edge reource in the operator.
335-
domain.
346+
Edge Cloud Zone Name - the common name for the Edge Cloud Zone.
336347
type: string
337348
additionalProperties: false
338349

350+
EdgeCloudProvider:
351+
description: |
352+
The company name of the Edge Cloud Zone provider.
353+
type: string
354+
355+
356+
339357
ErrorResponse:
340358
description: Error code and human-readable description.
341359
type: object
@@ -559,4 +577,4 @@ components:
559577
"code": "TIMEOUT",
560578
"status": 504,
561579
"message": "The service is currently not available"
562-
}
580+
}

0 commit comments

Comments
 (0)