Add RPC API endpoint table #354
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Nana-EC
added
documentation
Codecov Report
@@ Coverage Diff @@
## main #354 +/- ##
=======================================
Coverage 62.35% 62.35%
=======================================
Files 9 9
Lines 866 866
Branches 142 142
=======================================
Hits 540 540
Misses 288 288
Partials 38 38 Continue to review full report at Codecov.
|
Nana-EC
requested review from
Ivo-Yankov,
ar-conmit,
lukelee-sl,
natanasow and
shemnon
lukelee-sl
reviewed
Jul 20, 2022
README.md
Outdated
| @@ -126,16 +126,27 @@ docker compose up -d | |||
| > **_NOTE:_** If you encounter `unauthorized` when pulling iamge, then ensure you're loggeed in with `docker login ghcr.io` or use a [personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) to authorize your login. | |||
There was a problem hiding this comment.
Noticed a couple of typos, iamge-> image and loggeed->logged
lukelee-sl
previously approved these changes
Jul 20, 2022
Signed-off-by: Nana-EC <[email protected]>
Signed-off-by: Nana-EC <[email protected]>
Signed-off-by: Nana-EC <[email protected]>
Nana-EC
force-pushed
the
137-endpoint-readme
branch
from
55ae309 to
b3d56c5
Compare
|
Kudos, SonarCloud Quality Gate passed!
|
Nana-EC
requested review from
ar-conmit and
lukelee-sl
and removed request for
lukelee-sl
lukelee-sl
approved these changes
Jul 20, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Nana-EC [email protected]
Description:
The Relay currently doesn't have a quick reference of support endpoints and request steps.
An Open RPC spec will be added for greater detail but a simple table with basic information may be useful
Add an
rpc-api.mdto highlightRelated issue(s):
Fixes #137
Notes for reviewer:
Checklist