Skip to content

Leverage automation to document the REST-API#9

Open
shawnpringle wants to merge 4 commits intomainnet-cash:masterfrom
shawnpringle:master
Open

Leverage automation to document the REST-API#9
shawnpringle wants to merge 4 commits intomainnet-cash:masterfrom
shawnpringle:master

Conversation

@shawnpringle
Copy link
Copy Markdown

Simply running these commands

cd ..;
mkdir middle
cd middle
npm install -g widdershins
widdershins ../mainnet-js/swagger/v1/api.yml -o ../mainnet-docs/docs/src/rest-api.md

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.

Shawn David Pringle, B.Sc. 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
```
@mainnet-pat mainnet-pat force-pushed the master branch 4 times, most recently from 879c4a5 to a7a7c80 Compare January 27, 2026 11:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant