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.

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

Document supervisor's new /auth/list endpoint #2085

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

mdegat01
Copy link
Contributor

Proposed change

Document new endpoint created for home-assistant/supervisor#4912

Type of change

  • Document existing features within Home Assistant
  • Document new or changing features which there is an existing pull request elsewhere
  • Spelling or grammatical corrections, or rewording for improved clarity
  • Changes to the backend of this documentation
  • Removed stale or deprecated documentation

Additional information

@mdegat01
Copy link
Contributor Author

I didn't document the response model intentionally though I can if we want. My thinking was this:

  1. The only intended use case of this API is user trying to recover their credentials on the host shell. They don't really need to know the response model to understand what they're seeing, it'll be clear
  2. Supervisor doesn't dictate the response model. We're just calling Home Assistant's WS API for listing users and returning what we get. So it could change without Supervisor's knowledge and that's ok (see point 1)

@mdegat01
Copy link
Contributor Author

After further review, changed my mind on the above. We wanted to filter out the system generated users and info to streamline it a bit. Since supervisor is now massaging the data model, documenting it here makes sense.

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.

None yet

2 participants