doc: add documentation for local operator console #122
Conversation
christoph-zededa
force-pushed
the
doc_loc
branch
from
514463b to
b32b3d9
Compare
|
|
||
| This document explains the Local Operator Console(LOC) from the API point of view. | ||
|
|
||
| This document is similarly structured as PROFILE.md, because the topic is very similar. |
There was a problem hiding this comment.
Should we also introduce LOC here? What it is, when it is needed, difference between LOC and LPS, etc. Or will there be a separate md file in the EVE repo that would be linked here?
There was a problem hiding this comment.
I added a short explanation and a table with the differences. If you know more differences, please let me know.
OPERATOR_CONSOLE.md
Outdated
| GET /api/v2/edgedevice/certs | ||
| ``` | ||
|
|
||
| Returns the controller certificates. |
There was a problem hiding this comment.
We should also document the payload for each endpoint. Name of the mime type (application/x-proto-binary), protobuf message name + link to its definition.
There was a problem hiding this comment.
I added the mime type and the protobuf message name including the filename where it is defined.
OPERATOR_CONSOLE.md
Outdated
| POST /api/v2/edgedevice/id/$UUID/compound-config | ||
| ``` | ||
|
|
||
| Returns edge device config as part of the compound config. It also includes: |
There was a problem hiding this comment.
This should mention that the device config is in the same format as from the controller (EdgeDevConfig) and also signed by the controller.
There was a problem hiding this comment.
I added the word "signed" and mention EdgeDevConfig and where it is defined.
OPERATOR_CONSOLE.md
Outdated
| POST /api/v2/edgedevice/id/$UUID/metrics | ||
| ``` | ||
|
|
||
| This is where the metrics are sent. Similar to the controller. |
There was a problem hiding this comment.
Similar to the controller -> Similar to the controller API
There was a problem hiding this comment.
fixed (twice).
christoph-zededa
force-pushed
the
doc_loc
branch
3 times, most recently
from
75663d1 to
eaeafdb
Compare
Signed-off-by: Christoph Ostarek <[email protected]>
christoph-zededa
force-pushed
the
doc_loc
branch
from
eaeafdb to
d9f7569
Compare
2 participants
add some LOC documentation