immutability-io / vault-ethereum

A plugin that turns Vault into an Ethereum wallet.
243 stars 65 forks source link

Got that swagger #38

Closed zambien closed 5 years ago

zambien commented 5 years ago

Add Swagger documentation for all APIs

Description

This PR adds swagger documentation for all of the APIs.

Motivation and Context

This may ease use of the APIs. It was a good learning exercise for me to understand what the plugin is doing. I'm not entirely convinced Swagger is a great fit but thought to PR in case there is some value.

How Has This Been Tested?

I tested this using the swagger UI and the setup in the immutability project (for vault and the plugin). I used testnet with a few throwaway hashes.

Types of changes

Checklist:

zambien commented 5 years ago

Removed all the comments and such for generation as we discussed. Just using swagger.json now which we can update as changes are made going forward.