Portainer switch terminology to API token #152958
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR updates the Portainer integration to use the standard CONF_API_TOKEN constant instead of CONF_API_KEY, aligning with Home Assistant's consistent terminology for API authentication tokens.
Key Changes
- Updated all references from
CONF_API_KEYtoCONF_API_TOKENacross configuration flow, setup, and test files - Modified user-facing strings to use "Access token" terminology instead of "API key"
- Updated configuration descriptions to reflect the new terminology
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
homeassistant/components/portainer/__init__.py |
Updated import and configuration data access to use CONF_API_TOKEN |
homeassistant/components/portainer/config_flow.py |
Updated schema definition, validation, and unique ID handling to use CONF_API_TOKEN |
homeassistant/components/portainer/strings.json |
Changed user-facing strings from "API key" to "Access token" terminology |
tests/components/portainer/conftest.py |
Updated test configuration to use CONF_API_TOKEN |
tests/components/portainer/test_config_flow.py |
Updated test imports and mock data to use CONF_API_TOKEN |
frenck
requested changes
Sep 25, 2025
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
Good one, @frenck! Patched and including full test coverage. All set. :) |
NoRi2909
reviewed
Sep 26, 2025
Co-authored-by: Norbert Rittel <norbert@rittel.de>
Co-authored-by: Norbert Rittel <norbert@rittel.de>
|
Thanks @NoRi2909! :) |
NoRi2909
approved these changes
Sep 26, 2025
frenck
approved these changes
Sep 26, 2025
|
@frenck I've solved a merge conflict. Should be ready to be merged now. :) |
joostlek
approved these changes
Sep 27, 2025
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Breaking change
Proposed change
Keep the terminology of Portainer to be Access token, instead of API key.
Type of change
Additional information
Checklist
ruff format homeassistant tests)If user exposed functionality or configuration variables are added/changed:
If the code communicates with devices, web services, or third-party tools:
Updated and included derived files by running:
python3 -m script.hassfest.requirements_all.txt.Updated by running
python3 -m script.gen_requirements_all.To help with the load of incoming pull requests: