Skip to content

docs(nerdgraph): update widget link and description API examples#23503

Open
sujitnewrelic wants to merge 1 commit intodevelopfrom
api-correction-widget-des-and-link
Open

docs(nerdgraph): update widget link and description API examples#23503
sujitnewrelic wants to merge 1 commit intodevelopfrom
api-correction-widget-des-and-link

Conversation

@sujitnewrelic
Copy link
Contributor

Summary

  • Update the dashboardUpdateWidgetsInPage API examples to show that the full widget configuration is required when updating widgets, not just the fields being changed
  • Remove the "Bulk update multiple widgets" section to avoid confusion
  • Use GraphQL variables pattern for consistency with other examples in the document

Changes

The widget update examples now correctly show that you must include the complete widget configuration (visualization, layout, title, linkedEntityGuids, rawConfiguration) when using dashboardUpdateWidgetsInPage, even if you only want to update the description or link fields.

Test plan

  • Verify the updated code examples render correctly on the docs site
  • Confirm the GraphQL mutation format is accurate and follows API requirements

🤖 Generated with Claude Code

Update the dashboardUpdateWidgetsInPage API examples to show that the
full widget configuration is required when updating widgets, not just
the fields being changed. This includes visualization, layout, title,
linkedEntityGuids, and rawConfiguration.

Changes:
- Update "Update widget link and description" example with full config
- Update "Remove widget link and description" example with full config
- Remove "Bulk update multiple widgets" section
- Use GraphQL variables pattern for consistency with other examples

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@github-actions
Copy link

Hi @sujitnewrelic 👋

Thanks for your pull request! Your PR is in a queue, and a writer will take a look soon. We generally publish small edits within one business day, and larger edits within three days.

Please ensure the propsed changes look good by building it first in your local environment. Refer to this contribution guide to get the site up and running in your local.

If you really require a preview url, reach out to one of the writers and they will generate one for you.

@sujitnewrelic sujitnewrelic self-assigned this Mar 23, 2026
@sujitnewrelic sujitnewrelic added content requests related to docs site content from_tw Identifies issues/PRs from Tech Docs writers labels Mar 23, 2026
@sujitnewrelic
Copy link
Contributor Author

netlify build

@github-actions
Copy link

🚀 Netlify Preview Building!

If the build is successful, the preview for this pull request will be available at the following URL (usually takes 10-20 minutes):

https://api-correction-widget-des-and-link--docs-website-netlify.netlify.app

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content requests related to docs site content from_tw Identifies issues/PRs from Tech Docs writers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant