Skip to content

Add Settings intents to Admin intents API docs#3955

Open
adambarrus wants to merge 2 commits into2026-04-rcfrom
admin-settings-intents-docs-2026-04-rc
Open

Add Settings intents to Admin intents API docs#3955
adambarrus wants to merge 2 commits into2026-04-rcfrom
admin-settings-intents-docs-2026-04-rc

Conversation

@adambarrus
Copy link

Summary

  • Add four new Settings intent types to the Intents API documentation: settings/StoreDetails, settings/StoreDefaults, settings/OrderIdFormat, and settings/OrderProcessing
  • Add code examples for each new Settings intent
  • Regenerate generated_docs_data.json to reflect the changes

Details

Updates the Admin intents documentation to include new edit actions for store settings. Each Settings intent gets its own example file showing the invoke + complete pattern. The supported resources table in the invoke API description is updated with a new "Settings" section.

Related: https://github.com/Shopify/extensibility/pull/1020
Resolves: https://github.com/shop/issues-admin-extensibility/issues/2259

Test plan

  • Verify the generated docs JSON files are valid and contain the new Settings intents
  • Confirm the example files render correctly on shopify.dev

🤖 Generated with Claude Code

@adambarrus adambarrus self-assigned this Feb 24, 2026
Copy link
Contributor

@nneubarth nneubarth left a comment

Choose a reason for hiding this comment

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

Looking at the initial intent docs, I think these changes should be pretty minimal b90f42b

Copy link
Contributor

Choose a reason for hiding this comment

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

Do you know where these jsx examples are actually displayed in the docs? I can't seem to find them, and I don't remember seeing them before. They aren't in the initial intents doc update PR.

Copy link
Author

Choose a reason for hiding this comment

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

They're displayed when selected in the drop down in the right most column of the page:

Screenshot 2026-02-24 at 12 01 27 PM

Copy link
Author

Choose a reason for hiding this comment

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

I made an update that includes two tabs in the example now: one for js and one for jsx. Please take a look and lmk what you think!

cc @charlesdobson

@adambarrus adambarrus force-pushed the admin-settings-intents-docs-2026-04-rc branch from e133f81 to 001c73f Compare February 24, 2026 21:09
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
!components.d.ts
packages/**/*.js
!packages/**/__mocks__/**/*.js
!packages/**/intents/examples/*.js
Copy link
Author

Choose a reason for hiding this comment

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

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants