Skip to content

Separate action field YAML examples #27218

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

Draft
wants to merge 2 commits into
base: dev
Choose a base branch
from
Draft

Separate action field YAML examples #27218

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aa2f4df
Comma separate field examples if it is a list
davet2001 Sep 27, 2025
50bb0ff
Remove prettier ignore and json.stringify all examples
davet2001 Sep 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/panels/developer-tools/action/developer-tools-action.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ class HaPanelDevAction extends LitElement {
<td>
${this.hass.localize(
`component.${domain}.services.${serviceName}.fields.${field.key}.example`
) || field.example}
) || JSON.stringify(field.example)}
Comment on lines 299 to +301
Copy link
Member

@MindFreeze MindFreeze Sep 29, 2025

Choose a reason for hiding this comment

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

Mixing JSON with YAML seems confusing. I propose just YAML formatting complex objects like this, where dump is imported from "js-yaml"

Suggested change
${this.hass.localize(
`component.${domain}.services.${serviceName}.fields.${field.key}.example`
) || field.example}
) || JSON.stringify(field.example)}
${this.hass.localize(
`component.${domain}.services.${serviceName}.fields.${field.key}.example`
) ||
(typeof field.example === "object"
? html`<pre>${dump(field.example)}</pre>`
: field.example)}

Copy link
Contributor Author

@davet2001 davet2001 Sep 30, 2025

Choose a reason for hiding this comment

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

@MindFreeze agreed, although in some instances json is way more helpful (e.g. if feeding the data into the REST API - which is what I was doing when I stumbled across this issue).

Would having two example columns (one for JSON, one for yaml) be out of the question?

I noticed the Microsoft started doing similar a while ago where they have a help page with API examples in multiple languages.

Copy link
Member

@bramkragten bramkragten Oct 1, 2025

Choose a reason for hiding this comment

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

I don't think this page is meant for using/documenting the REST API, we generally use YAML for everything, and that is what we should display here. I would not add yet another column.

</td>
</tr>`
)}
Expand Down
Loading