Simple edge discovery: spelling and linting #223
Conversation
nicolacdnll
added
the
documentation
nicolacdnll
requested review from
gunjald,
Kevsy,
crissancas,
FabrizioMoggio,
gainsley and
javierlozallu
as code owners
🦙 MegaLinter status: ❌ ERROR
See detailed report in MegaLinter reports MegaLinter is graciously provided by |
| @@ -1,50 +1,60 @@ | |||
| # Edge Discovery APIs | |||
|
|
|||
| ## Simple Discovery API | |||
| This API allows a client application to discover the closest MEC platform to the UE hosting the client application. 'Closest' means 'shorteset network path' as that will give the shortest propogation distance, which is a major factor in latency. | |||
|
|
|||
| This API allows a client application to discover the closest MEC platform to the UE hosting the client application. 'Closest' means 'shortest network path' as that will give the shortest propagation distance, which is a major factor in latency. | |||
There was a problem hiding this comment.
Should it be "platforms"? Plural as the API returns the array of platforms.
There was a problem hiding this comment.
Should it be "platforms"? Plural as the API returns the array of platforms.
No, Simple Edge Discovery returns only the closest platform. For convenience this is returned as an array with one member, to allow easier portability of parsing code to the other Edge Cloud API that will return multiple platforms.
| 17. "I can ask the operator to inform about the application instance details e.g., communication endpoints, resource consumed etc" | ||
| #### Provisioning intents | ||
|
|
||
| 1. "I can retrieve a list of the operator’s MECs and their status, ordering the results by location and filtering by status (active/inactive/unknown)" |
There was a problem hiding this comment.
We have terms with alternate words e.g. here it says MECs but the API says MEC Platforms
| 21. "I can discover the optimal application service endpoint for a specific terminal, taking into account mobility events, connectivity, shortest network path, cost, network load, MEC platform load etc." | ||
| #### Runtime intents | ||
|
|
||
| 19. "I can discover the closest MEC platform to a particular terminal (closest in terms of shortest network path)" |
There was a problem hiding this comment.
Here we have MEC platform while at line 33 it is MECs
| @@ -7,7 +7,7 @@ info: | |||
| --- | |||
| # Summary | |||
|
|
|||
| The Simple Edge Discovery API returns the name of the closest operator MEC platform to a particular user device. | |||
| The Simple Edge Discovery API returns the name of the closest operator MEC platform to a particular user device. | |||
There was a problem hiding this comment.
Should it be "platforms"? Singular to Plural?
There was a problem hiding this comment.
@gunjald I'm not changing the content or meaning of the API.
I'm just applying linting and spelling. These issues you comment need a dedicated PR.
There was a problem hiding this comment.
Ok. Then we can leave this comment for now and will address it later as separate PR
nicolacdnll
force-pushed
the
simple-edge-discovery/spelling-linting
branch
from
a9c8d85 to
b971eda
Compare
nicolacdnll
changed the title
|
Approved - thanks @nicolacdnll for the good work! - and I will port the new format into #194 (The Simple Edge Discovery PR with substantial content changes). Also noted that the README will need to change in a separate PR. |
What type of PR is this?
Add one of the following kinds:
What this PR does / why we need it:
Abide with the Megalinter workflow and spelling. Changes to the API itself need a dedicated PR.
Current linting is complaining about these two lines that are a regex and I'm not sure how to hard wrap. In any case, we can use equivalent regex that are also shorter. But that's for another PR.
Which issue(s) this PR fixes:
None