Repository navigation
application/scan — run a data scan/audit over the store #10
Replies: 5 comments
|
Are we going to get any updates on this? There was a compromise (https://github.com/Shopify/app-intent-types#review-process) to respond to discussions and PRs within 5 business days. |
|
Hey. We've added application/optimization-plan. They feel very similar overall. Would that suffice your use-case? |
|
Thanks, Two things would help it route well for the use cases in this thread:
Happy to open a PR with the doc wording if useful. |
|
Quick update: we have implemented the How we mapped it:
My offer from the earlier comment still stands. I'm happy to open a PR adding customer data quality (deduplication, record cleanup) and store audits/scans to the type's examples, so apps in those categories land on this type instead of proposing new ones. Thanks for pointing us here! |
|
Following up on my earlier offer, here's the doc change I'd suggest for main...guillelopezgines:app-intent-types:patch-1 Why: when #30 landed, its references to application/scan were removed because that type isn't supported, which left the doc silent on scans and audits. Its examples are all SEO, accessibility, conversion and merchandising, and requests phrased as "find" or "check" don't obviously map to a plan. Spelling this out would help scan and audit apps choose this type rather than proposing new ones. Singulary already uses it this way in production. What changes:
Happy to adjust the wording. |
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
What type?
application/scan— a scan/audit run over a slice of the store's data, executed by an app, producing findings the merchant reviews in the app.What do merchants ask Sidekick that needs it? "Find my duplicate customers", "check my store for SEO issues", "find product images missing alt text", "check my shop for broken links", "audit my inventory for stale stock". All share one shape: scope + check → findings report.
What apps would register it? Ours (Singulary — duplicate customer detection). Beyond us, whole App Store categories share the shape: SEO auditors, image/alt-text and accessibility checkers, broken-link checkers, product data quality apps, inventory auditors.
Schema sketch:
Proposed content of
application/scan.json:{ "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://extensions.shopifycdn.com/shopifycloud/schemas/v1/application/scan.json", "title": "Scan", "type": "object", "properties": { "id": { "type": "string", "description": "The scan ID. Used for edit actions." }, "resource": { "type": "string", "enum": ["customers", "products", "orders", "inventory", "pages", "media", "store"], "description": "The store data the scan runs over. Use store for whole-store scans." }, "check": { "type": "string", "description": "App-defined check the scan performs, e.g. duplicates, seo-issues, missing-alt-text, broken-links, stale-inventory." }, "query": { "type": "string", "description": "Optional filter narrowing the scan scope, in Shopify search syntax, e.g. tag:wholesale." }, "since": { "type": "string", "format": "date-time", "description": "Only scan records created or updated after this time (incremental scan). Omit for a full scan." }, "scheduled_at": { "type": "string", "format": "date-time", "description": "Run the scan at this time instead of immediately." }, "notify": { "type": "boolean", "description": "Notify the merchant when the scan completes." } }, "additionalProperties": true }Anything close in the existing list?
shopify/customer|product|orderimports are the inverse (Sidekick hands the app specific GIDs; a scan's whole point is the app discovers the records itself). Noapplication/*type overlaps.Alternatives considered: adding a
scanaction toshopify/customer(or to the wholeshopify/*family). Rejected because it breaks the family's contract —shopify/*intents take a resource GID asvalueand produce a resource result, while a scan has no input GID and outputs a findings report — and because the scan config (scope, filter, check, schedule) needs its own schema either way, which is what a type is. A family-levelscanaction would also miss whole-store and content/media scans, which have noshopify/*resource type. Theresourceenum field inapplication/scankeeps the per-resource routing benefit. Happy to pivot to the family-action design if you'd rather extendshopify/*.All reactions