Skip to content
This repository has been archived by the owner on Jan 19, 2023. It is now read-only.

multi: support multiple RPC files #16

Merged
merged 10 commits into from
May 11, 2020
Merged

multi: support multiple RPC files #16

merged 10 commits into from
May 11, 2020

Conversation

guggero
Copy link
Member

@guggero guggero commented Apr 7, 2020

Updates the API docs with the following features:

  • Make compatible with lnd and loop, generic enough to also easily include other projects in the future
  • Include all *.proto files for gRPC
  • Add service name in front of RPC, sort alphabetically
  • Show both gRPC and REST on the same page
  • Mention which protos are considered experimental and what that means
  • Link to the proto files for easy access
  • Mention commit the documentation was generated from
  • Link to message type definition in protos
  • List Enumerations (was a contributor PR that I included)
  • Dockerize everything, removing the need to install a big list of tools/libraries just to generate the documentation

Also includes the commits of #8 and #10 because they seem to never have been looked at before.

README.md Show resolved Hide resolved
update_and_render.sh Outdated Show resolved Hide resolved
update_and_render.sh Outdated Show resolved Hide resolved
@guggero guggero changed the title [WIP]: multi: support multiple RPC files multi: support multiple RPC files May 1, 2020
@guggero
Copy link
Member Author

guggero commented May 1, 2020

I think this can be merged now? The official documentation is now generated and uploaded from this script.

Copy link
Member

@Roasbeef Roasbeef left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🌭

One small thing to correct w.r.t how we sync the loop docs, will push a commit to fix that after this is merged.

Dockerfile Outdated
@@ -0,0 +1,39 @@
FROM golang:1.13-buster
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤩

@Roasbeef Roasbeef merged commit d2ae962 into lightninglabs:master May 11, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants