jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-15 21:36:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

OAuth discovery

Browse Source
This commit is contained in:
Simon Lamon 2025-05-28 21:44:09 +02:00 committed by GitHub
parent 9822f0fd5b
commit e12118d762
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/core/integration-quality-scale/rules/discovery.md
View File

@ -110,6 +110,18 @@ class MyConfigFlow(ConfigFlow, domain=DOMAIN):
)
```
### Note for OAuth2-Based Config Flows
For integrations that utilize OAuth2 and extend config_entry_oauth2_flow.AbstractOAuth2FlowHandler instead of ConfigFlow, it is not necessary to implement discovery-related steps such as async_step_zeroconf or async_step_discovery_confirm. The AbstractOAuth2FlowHandler base class includes built-in support for Home Assistant's discovery mechanisms and will automatically initiate the configuration flow when a compatible device or service is detected. Developers need only declare the relevant discovery identifiers in manifest.json and implement the async_oauth_create_entry method to complete the configuration.
Certainly! Here's a revised version that refers more generally to Home Assistant's discovery mechanisms:
### Note for OAuth2-Based Config Flows
For integrations that utilize OAuth2 and extend `config_entry_oauth2_flow.AbstractOAuth2FlowHandler` instead of `ConfigFlow`, it is not necessary to implement discovery-related steps such as `async_step_zeroconf` or `async_step_discovery_confirm`. The `AbstractOAuth2FlowHandler` base class includes built-in support for Home Assistant's discovery mechanisms and will automatically initiate the configuration flow when a compatible device or service is detected. Developers need only declare the relevant discovery identifiers in `manifest.json` and implement the `async_oauth_create_entry` method to complete the configuration.
## Additional resources
To learn more information about config flows, checkout the [config flow documentation](/docs/config_entries_config_flow_handler).
@ -123,4 +135,4 @@ Integrations where the devices can't be discovered are exempt from this rule.
## Related rules
<RelatedRules relatedRules={frontMatter.related_rules}></RelatedRules>
<RelatedRules relatedRules={frontMatter.related_rules}></RelatedRules>