Skip to content

馃 Sync Liquid Docs Schema #1914

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
shopify-build-cli wants to merge 1 commit into
base: main
Choose a base branch
from
Open

馃 Sync Liquid Docs Schema #1914

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 41 additions & 2 deletions data/filters.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1332,6 +1332,25 @@
"syntax": "string | date: string",
"name": "date"
},
{
"category": "metafield",
"deprecated": false,
"deprecation_reason": "",
"description": "Disclosures scoped to a country or a country subdivision are returned only for buyers in that\njurisdiction. A disclosure is returned whenever the buyer's jurisdiction cannot be determined,\nso a disclosure is never hidden on the strength of an unknown.",
"parameters": [],
"return_type": [
{
"type": "array",
"name": "",
"description": "",
"array_value": "untyped"
}
],
"examples": [],
"summary": "Filters a list of disclosures to the ones that apply to the buyer's jurisdiction.",
"syntax": "array | applicable_disclosures",
"name": "applicable_disclosures"
},
{
"category": "font",
"deprecated": false,
Expand Down Expand Up @@ -6009,7 +6028,7 @@
"category": "html",
"deprecated": false,
"deprecation_reason": "",
"description": "",
"description": "You can add any other [HTML attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script#attributes)\nto the tag by adding a parameter that matches the attribute name, and the desired value. Boolean attributes, such as\n`defer` and `async`, are rendered when the value is `true`, and omitted when the value is `false`.\n\n> Note:\n> The `src` attribute is managed by the filter and can't be overridden.",
"parameters": [],
"return_type": [
{
Expand All @@ -6029,6 +6048,16 @@
"parameter": false,
"display_type": "text",
"show_data_tab": true
},
{
"name": "HTML attributes",
"description": "You can specify [HTML attributes](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script#attributes) by adding a parameter that matches the attribute name, and the desired value. Boolean attributes, such as `defer` and `async`, are rendered when the value is `true`, and omitted when the value is `false`. The `src` attribute is managed by the filter and can't be overridden.\n",
"syntax": "string | script_tag: attribute: string",
"path": "/",
"raw_liquid": "{{ 'cart.js' | asset_url | script_tag: type: 'module', defer: true }}",
"parameter": true,
"display_type": "text",
"show_data_tab": true
}
],
"summary": "Generates an HTML `<script>` tag for a given resource URL. The tag has a `type` attribute of `text/javascript`.",
Expand Down Expand Up @@ -6069,7 +6098,7 @@
"category": "html",
"deprecated": false,
"deprecation_reason": "",
"description": "",
"description": "You can add any other [HTML attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link#attributes)\nto the tag by adding a parameter that matches the attribute name, and the desired value.\n\n> Note:\n> The `href` and `rel` attributes are managed by the filter and can't be overridden.",
"parameters": [
{
"description": "The type of media that the resource applies to.",
Expand Down Expand Up @@ -6118,6 +6147,16 @@
"parameter": true,
"display_type": "text",
"show_data_tab": true
},
{
"name": "HTML attributes",
"description": "You can specify [HTML attributes](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link#attributes) by adding a parameter that matches the attribute name, and the desired value. The `href` and `rel` attributes are managed by the filter and can't be overridden.\n",
"syntax": "string | stylesheet_tag: attribute: string",
"path": "/",
"raw_liquid": "{{ 'base.css' | asset_url | stylesheet_tag: fetchpriority: 'high' }}",
"parameter": true,
"display_type": "text",
"show_data_tab": true
}
],
"summary": "Generates an HTML `<link>` tag for a given resource URL. The tag has the following parameters:\n\n| Attribute | Value |\n| --- | --- |\n| `rel` | `stylesheet` |\n| `type` | `text/css` |\n| `media` | `all` |",
Expand Down
112 changes: 77 additions & 35 deletions data/objects.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3828,7 +3828,7 @@
"array_value": ""
}
],
"summary": "The market that includes this country.",
"summary": "The market that applies to this country. In cases where multiple markets match, this returns the most-specific country region market.",
"name": "market"
},
{
Expand Down Expand Up @@ -8793,7 +8793,7 @@
"array_value": ""
}
],
"summary": "The currently selected market on the storefront.",
"summary": "The market that applies to the buyer's country. In cases where multiple markets match, this returns the most-specific country region market.",
"name": "market"
},
{
Expand Down Expand Up @@ -9714,6 +9714,22 @@
],
"summary": "The relative URL of the metaobject.",
"name": "url"
},
{
"deprecated": false,
"deprecation_reason": "",
"description": "The name doesn't include the `metaobject.` prefix, or the file extension (`.json` or `.liquid`).\n\nIf a custom template isn't assigned to the metaobject, then `nil` is returned.",
"examples": [],
"return_type": [
{
"type": "string",
"name": "",
"description": "",
"array_value": ""
}
],
"summary": "The name of the [custom template](/themes/architecture/templates#alternate-templates) assigned to the metaobject.",
"name": "template_suffix"
}
],
"summary": "Basic information about a [`metaobject`](/api/liquid/objects#metaobject). These properties are grouped under the `system` object to avoid collisions between system property names and user-defined metaobject fields.",
Expand Down Expand Up @@ -13745,6 +13761,22 @@
"summary": "The description of the product.",
"name": "description"
},
{
"deprecated": false,
"deprecation_reason": "",
"description": "> Note:\n> This is the same value as [`product.description`](/docs/api/liquid/objects/product#product-description).\n> The description of remote products is modified to include a link to the remote store's shipping and refund policies, if the shop has defined them.",
"examples": [],
"return_type": [
{
"type": "string",
"name": "",
"description": "",
"array_value": ""
}
],
"summary": "The description of the product.",
"name": "content"
},
{
"deprecated": false,
"deprecation_reason": "",
Expand Down Expand Up @@ -13857,22 +13889,6 @@
"summary": "The vendor of the product.",
"name": "vendor"
},
{
"deprecated": false,
"deprecation_reason": "",
"description": "> Note:\n> This is the same value as [`product.description`](/docs/api/liquid/objects/product#product-description).",
"examples": [],
"return_type": [
{
"type": "string",
"name": "",
"description": "",
"array_value": ""
}
],
"summary": "The description of the product.",
"name": "content"
},
{
"deprecated": false,
"deprecation_reason": "",
Expand Down Expand Up @@ -15301,7 +15317,7 @@
{
"deprecated": false,
"deprecation_reason": "",
"description": "Only filters that are relevant to the current search results are returned. If the search results contain more than 1000\nproducts, then the array will be empty.\n\n> Tip:\n> To learn about how to set up filters in the admin, visit the [Shopify Help Center](https://help.shopify.com/manual/online-store/themes/customizing-themes/storefront-filters).",
"description": "Only filters that are relevant to the current search results are returned. Filters and their value counts are\ncalculated from up to the first 1,000 search results.\n\n> Tip:\n> To learn about how to set up filters in the admin, visit the [Shopify Help Center](https://help.shopify.com/manual/online-store/themes/customizing-themes/storefront-filters).",
"examples": [],
"return_type": [
{
Expand Down Expand Up @@ -15333,7 +15349,7 @@
{
"deprecated": false,
"deprecation_reason": "",
"description": "An item can be an [`article`](/docs/api/liquid/objects/article), a [`page`](/docs/api/liquid/objects/page), or a\n[`product`](/docs/api/liquid/objects/product).\n\n> Tip:\n> Use the [paginate](/docs/api/liquid/tags/paginate) tag to choose how many results to show per page, up to a limit of 50.",
"description": "An item can be an [`article`](/docs/api/liquid/objects/article), a [`page`](/docs/api/liquid/objects/page), or a\n[`product`](/docs/api/liquid/objects/product).\n\n> Tip:\n> Use the [paginate](/docs/api/liquid/tags/paginate) tag to choose how many results to show per page, up to a limit of 50.\n> Pagination covers up to the first 1,000 results.",
"examples": [
{
"name": "Search result `object_type`",
Expand All @@ -15357,19 +15373,7 @@
"type": "array",
"name": "",
"description": "",
"array_value": "article"
},
{
"type": "array",
"name": "",
"description": "",
"array_value": "page"
},
{
"type": "array",
"name": "",
"description": "",
"array_value": "product"
"array_value": "article | page | product"
}
],
"summary": "The search result items.",
Expand All @@ -15388,7 +15392,7 @@
"array_value": ""
}
],
"summary": "The number of results.",
"summary": "The number of results, up to a maximum of 1,000. If a search matches more than 1,000 results, then it\nreturns 1,000.",
"name": "results_count"
},
{
Expand Down Expand Up @@ -17322,6 +17326,28 @@
"summary": "Returns `true` if the locale is the store's primary locale. Returns `false` if not.",
"name": "primary"
},
{
"deprecated": false,
"deprecation_reason": "",
"description": "Returns `rtl` for right-to-left locales and `ltr` for left-to-right locales.\n\nYou can use `direction` to set the [`dir` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir) on the `html` element, so that the page flows correctly for right-to-left languages.",
"examples": [],
"return_type": [
{
"type": "string",
"name": "ltr",
"description": "",
"array_value": ""
},
{
"type": "string",
"name": "rtl",
"description": "",
"array_value": ""
}
],
"summary": "The text direction of the locale.",
"name": "direction"
},
{
"deprecated": false,
"deprecation_reason": "",
Expand Down Expand Up @@ -17484,7 +17510,7 @@
},
"deprecated": false,
"deprecation_reason": "",
"description": "If a location doesn't stock a variant, then there won't be a `store_availability` for that variant and location.\n\n> Note:\n> The `store_availability` object is defined only if one or more locations has [local pickup](https://help.shopify.com/manual/shipping/setting-up-and-managing-your-shipping/local-methods/local-pickup)\n> enabled.",
"description": "If a location doesn't stock a variant, then there won't be a `store_availability` for that variant and location.\n\n> Note:\n> A returned location isn't guaranteed to offer [local pickup](https://help.shopify.com/manual/shipping/setting-up-and-managing-your-shipping/local-methods/local-pickup).\n> Check `pick_up_enabled` before presenting a location as a pickup option.",
"properties": [
{
"deprecated": false,
Expand Down Expand Up @@ -17518,6 +17544,22 @@
"summary": "Returns `true` if the location has pickup enabled. Returns `false` if not.",
"name": "pick_up_enabled"
},
{
"deprecated": false,
"deprecation_reason": "",
"description": "",
"examples": [],
"return_type": [
{
"type": "boolean",
"name": "",
"description": "",
"array_value": ""
}
],
"summary": "Returns `true` if the location is a physical retail storefront that sells in person. Returns `false` if not.",
"name": "physical_storefront"
},
{
"deprecated": false,
"deprecation_reason": "",
Expand Down
Loading
Loading