fix: show thermostat sample for /thermostats/list #766
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
mikewuu
changed the title
razor-x
reviewed
Jul 29, 2025
codegen/lib/layout/api-endpoint.ts
Outdated
Comment on lines
300
to
307
| include: [ | ||
| ...(metadata?.include_groups ?? []), | ||
| ...(parentMetadata?.include_groups ?? []), | ||
| ], | ||
| exclude: [ | ||
| ...(metadata?.exclude_groups ?? []), | ||
| ...(parentMetadata?.exclude_groups ?? []), | ||
| ], |
Member
There was a problem hiding this comment.
I think this might be the key, however not quite as this has removed the samples from every endpoint which is not what we wanted.
The issue is the array merge. The logic needs to be something like
let metadata = null
if endpointMetadata?.include_groups || endpointMetadata?.exclude_groups
metadata = endpointMetadata
if parentMetadata?.include_groups || parentMetadata?.exclude_groups
metadata = parentMetadata
// ...
include: metadata?.include_groups,
exclude: metadata?.exclude_groups,
Contributor
Author
There was a problem hiding this comment.
@razor-x preferring parent metadata ended up removing the sample for certain endpoints (e.g /heat /heat_cool).
Updated it to fallback to endpoint metadata if parent isn't defined, which seems to have fixed it:
- noise sensors list updated to use noise sensor sample
- thermostat list returns thermostat sample
razor-x
approved these changes
Jul 30, 2025
mikewuu
merged commit f52d478
into
evan/cx-417-json-response-blurbs-for-specialized-devices-need-to-show
4 checks passed
mikewuu
deleted the
mike/cx-417-json-response-blurbs-for-specialized-devices-need-to-show
branch
mikewuu
added a commit
that referenced
this pull request
Jul 30, 2025
* fix: Filter resourceSamples on endpoints like on route * Remove strict check * fix: show thermostat sample for /thermostats/list (#766) * include parent metadata * ci: Generate docs * update to only select parent metadata * ci: Generate docs * fallback endpoint sample * ci: Generate docs --------- Co-authored-by: Seam Bot <[email protected]> --------- Co-authored-by: Mike Wu <[email protected]> Co-authored-by: Seam Bot <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Extension of #711
Not sure if correct, but
parentPathis the only thing I could find to link it to the path metadata.