lightninglabs / lightning-api-ng

Automated API-documentation generation source code for Lightning Lab's FOSS software suite
6 stars 7 forks source link

main: skip missing swagger files instead of failing #1

Closed jamaljsr closed 2 years ago

jamaljsr commented 2 years ago

When I ran generate.sh on my machine, the script failed because the corresponding *.swagger.json files doesn't exist for looprpc/debug.proto, auctioneerrpc/auctioneer.proto, and auctioneerrpc/hashmail.proto. At first, I added these files to the EXCLUDE_PROTOS var, but this resulted in missing types in the merged JSON file. For example, the auctioneerrpc.NodeTier enum is referenced by a few messages in trader.proto, but was not in the output because auctioneer.proto was excluded.

I'm not sure if this is the best solution, but it passed my sanity check of just skimming the output for references.