afonso/core-extra
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

fix bad links in generated docs for grpc to point to latest on master

Browse source
This commit is contained in:
Blake Harnden 2020-07-15 17:09:32 -07:00
parent 1c876819f1
commit 33d100acff
1 changed files with 8 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
docs/grpc.md
View file

@ -15,20 +15,23 @@ properly account for this issue or clear out your proxy when running if needed.
## Python Client ## Python Client
A python client wrapper is provided at A python client wrapper is provided at
[CoreGrpcClient](../daemon/core/api/grpc/client.py) to help provide some [CoreGrpcClient](https://github.com/coreemu/core/blob/master/daemon/core/api/grpc/client.py)
conveniences when using the API. to help provide some conveniences when using the API.
## Proto Files ## Proto Files
Proto files are used to define the API and protobuf messages that are used for Proto files are used to define the API and protobuf messages that are used for
interfaces with this API. interfaces with this API.
They can be found [here](../daemon/proto/core/api/grpc) to see the specifics of They can be found
[here](https://github.com/coreemu/core/tree/master/daemon/proto/core/api/grpc)
to see the specifics of
what is going on and response message values that would be returned. what is going on and response message values that would be returned.
## Examples ## Examples
Example usage of this API can be found [here](../daemon/examples/grpc). These Example usage of this API can be found
examples will create a session using the gRPC API when the core-daemon is running. [here](https://github.com/coreemu/core/tree/master/daemon/examples/grpc).
These examples will create a session using the gRPC API when the core-daemon is running.
You can then switch to and attach to these sessions using either of the CORE GUIs. You can then switch to and attach to these sessions using either of the CORE GUIs.