Leverage automation to document the REST-API#9
Open
shawnpringle wants to merge 4 commits intomainnet-cash:masterfrom
Open
Leverage automation to document the REST-API#9shawnpringle wants to merge 4 commits intomainnet-cash:masterfrom
shawnpringle wants to merge 4 commits intomainnet-cash:masterfrom
Conversation
added 4 commits
December 2, 2025 08:39
…ted with Widdershims. bash``` npm install -g widdershins widdershins ../mainnet-js/swagger/v1/api.yml -o ../mainnet-docs/docs/src/rest-api.md ```
879c4a5 to
a7a7c80
Compare
This file contains hidden or 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
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.
Simply running these commands
So now there is some documentation which specifies which commands are available to call. It would be nice if I had more detail about the structure of the JSONs to be returned though.
I also added a file about the utxo command to be merged with the API document later.