Repository navigation
DOCS-4990: Update SetConfigProperty docs for fragment-provided properties - #5461
Open
Shannon Bradshaw (shannonbradshaw) wants to merge 1 commit into
Open
Shannon Bradshaw (shannonbradshaw) wants to merge 1 commit into
Shannon Bradshaw (shannonbradshaw) wants to merge 1 commit into
Conversation
app#13986 (APP-18252) lets SetConfigProperty set properties that come from an imported fragment by writing a $set fragment override, instead of returning an error. Update the proto description override and regenerate the app API page. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01W6PSK35kbAfSpymUypcgjm
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
viambot
added
the
safe to build
This branch has not been deployed
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
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.
Documents: DOCS-4990
Source changes
SetConfigPropertynow sets properties that come from an imported fragment by writing a$setfragment override on the last import that provides them, instead of returning a "not supported yet" error.Docs changes
static/include/app/apis/overrides/protos/app.SetConfigProperty.md: replaced "setting a property that may come from the fragment returns an error" with where each change is written (part config, fragment override, or new on the part config) and the two errors that remain (billing/access_policyfrom a fragment, and replacing a whole resource from a fragment imported more than once). Behavior read fromdata/set_config_property.go(setConfigProperty,lastImportForPath,appendFragmentMod).static/include/app/apis/generated/app.md: regenerated withupdate_sdk_methods.py "" app. The only hunk is the description above. The summary table uses the first sentence only, so it is unchanged.Fragment variables in
SetConfigProperty(APP-18253) are still in review, so this PR says nothing about them.How I found these
app-api-xref.md(AppService)SetConfigProperty,set_config_property,setConfigPropertyacross the docs repo found only the generated page, its table, and the override file.Checks
vale 3.12.0 (both files),
frontmatter_rules.py, andmake build-prodpass. Prettier and markdownlint don't coverstatic/.Generated by daily docs change agent
Generated by Claude Code