Add documentation for the api and expand README - Githubissues

NexusMutual / cover-router

Computes optimal capacity allocation per Nexus Mutual staking pool on cover purchase

MIT License

1 stars 1 forks source link

Add documentation for the api and expand README #76

Closed MilGard91 closed 5 months ago

MilGard91 commented 7 months ago

Context

Issue: #72

Changes proposed in this pull request

Add openapi documentation for the routes
Expand README with missing information

Test plan

N/A

Checklist

[x] Rebased the base branch
[x] Attached corresponding Github issue
[x] Prefixed the name with the type of change (i.e. feat, chore, test)
[x] Performed a self-review of my own code
[x] Followed the style guidelines of this project
[x] Made corresponding changes to the documentation
[x] Didn't generate new warnings
[x] Didn't generate failures on existing tests
[ ] Added tests that prove my fix is effective or that my feature works

Review

When reviewing a PR, please indicate intention in comments using the following emojis:

:cake: = Nice to have but not essential.
:bulb: = Suggestion or a comment based on personal opinion
:hammer: = I believe this should be changed.
:thinking: = I don’t understand something, do you mind giving me more context?
:rocket: = Feedback