API docs

[nonsleepr]

Solves #3.

To see how it looks like, Import URL https://raw.githubusercontent.com/nonsleepr/python-eufy-security/api-docs/openapi.yaml into https://editor.swagger.io/ (a bonus: you could actually poke around API there).

The way I see it deployed, is something like described here.

[phiali]

I think this might need to be Hub parameters instead of Hum?

[FuzzyMistborn]

Looks nice! Glad we finally are getting somewhere.

[nonsleepr]

So, how do you think we should host the UI? Just noting that it could be imported into editor.swagger.io (it can't import by crafting the URL right now)? Or shall we utilize Github Pages?

[bachya]

@nonsleepr I think GitHub Pages would be nice. 👍

[nonsleepr]

Can you set it up? Something like this: https://github.com/peter-evans/swagger-github-pages.

[bachya]

Might need @FuzzyMistborn to do it since he owns the repo.

[FuzzyMistborn]

Ok the github page is setup, but I can't get it to point to dev (never dealt with swagger or github pages before). If it needs to go to master you should just commit it and everything should be set up correctly.

[bachya]

Done. @FuzzyMistborn, going forward, let's make sure that PRs are squash-merged; it'll ensure we keep a clean commit history.

[FuzzyMistborn]

Yeah sorry, been a long week and I probably shouldn't have done that so late. Thanks!

[bachya]

No worries! I’ve been there. 😂👍🏻

[FuzzyMistborn]

Hmm....page appears to be rendering blank. Must be other things we need to change? I think everything is set up correctly on the backend.

[bachya]

I'm unclear on whether that URL matches the directory structure in master – @nonsleepr, can you assist here?

[nonsleepr]

Yeah, it expects to see index.html and the contents of dist in the same folder.

Possible ways to solve that:

• A. Move stuff from dist/ to the root (I dislike polluting the root directory though).
• B. Edit srcs and hrefs in index.html to ./dist/???`.
• C. Rename dist/ to docs/ and change GH-Pages settings to build from "master branch /docs folder".
• D. Create a branch called gh-pages and keep there only the index.html, openapi.yaml and the contents of dist/ folder; and change GH-Pages settings to build from gh-pages branch.

I would prefer the option D, it should be easy to automate as well.

[bachya]

I like option D, too.

[FuzzyMistborn]

Ah, i misread the setup docs. They said move index.html out of the dist folder....i think that's where I got confused.

I also like option D.

[bachya]

I'll take care of it. 👍

[bachya]

Okay, gh-pages now exists and has the files @nonsleepr mentioned.

[FuzzyMistborn]

Updated the settings. On mobile atm, can check later if it worked.

[nonsleepr]

It works!