Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Complete design documentation #8

Merged
merged 3 commits into from
Jul 11, 2020
Merged

Complete design documentation #8

merged 3 commits into from
Jul 11, 2020

Conversation

th0mas
Copy link
Contributor

@th0mas th0mas commented Jul 9, 2020 •
edited
Loading

  • Document External API
  • Document Internal (websocket) API
  • Explain key design decisions

@th0mas th0mas marked this pull request as ready for review July 9, 2020 15:55
@nelsonic nelsonic mentioned this pull request Jul 9, 2020
Merged
nelsonic
nelsonic reviewed Jul 11, 2020
View reviewed changes
openapi.yaml
@@ -0,0 +1,342 @@
openapi: 3.0.0
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@th0mas is this file created/consumed by insomnia? 💭

nelsonic
nelsonic approved these changes Jul 11, 2020
View reviewed changes
Copy link
Member

@nelsonic nelsonic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@th0mas docs look great! Thanks! 👍
A brief guide to using insomnia would be good (as previously noted). 💡

@nelsonic nelsonic merged commit 1e017bb into master Jul 11, 2020
@nelsonic nelsonic deleted the design branch July 11, 2020 16:40
@nelsonic nelsonic mentioned this pull request Jul 16, 2020
Closed
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nelsonic nelsonic nelsonic approved these changes

Assignees

@nelsonic nelsonic

Labels
awaiting-review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@th0mas @nelsonic