Skip to content

🤖 Sync Liquid Docs Schema #943

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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
dev-bot-shopify wants to merge 1 commit into from
Closed

🤖 Sync Liquid Docs Schema #943

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
60 changes: 59 additions & 1 deletion data/filters.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4433,7 +4433,35 @@
"deprecated": false,
"deprecation_reason": "",
"description": "",
"parameters": [],
"parameters": [
{
"description": "The text for the previous page link.",
"name": "previous",
"positional": false,
"required": false,
"types": [
"string"
]
},
{
"description": "The text for the next page link.",
"name": "next",
"positional": false,
"required": false,
"types": [
"string"
]
},
{
"description": "The anchor to add to the pagination links.",
"name": "anchor",
"positional": false,
"required": false,
"types": [
"string"
]
}
],
"return_type": [
{
"type": "string",
Expand All @@ -4452,6 +4480,36 @@
"parameter": false,
"display_type": "text",
"show_data_tab": true
},
{
"name": "previous",
"description": "Specify the text for the previous page link.",
"syntax": "paginate | default_pagination: previous: string",
"path": "/collections/sale-potions",
"raw_liquid": "{% paginate collection.products by 2 %}\n {% for product in collection.products %}\n {{- product.title }}\n {% endfor %}\n\n {{- paginate | default_pagination: previous: 'Previous' -}}\n{% endpaginate %}",
"parameter": true,
"display_type": "text",
"show_data_tab": false
},
{
"name": "next",
"description": "Specify the text for the next page link.",
"syntax": "paginate | default_pagination: next: string",
"path": "/collections/sale-potions",
"raw_liquid": "{% paginate collection.products by 2 %}\n {% for product in collection.products %}\n {{- product.title }}\n {% endfor %}\n\n {{- paginate | default_pagination: next: 'Next' -}}\n{% endpaginate %}",
"parameter": true,
"display_type": "text",
"show_data_tab": false
},
{
"name": "anchor",
"description": "Specify the anchor to add to the pagination links.",
"syntax": "paginate | default_pagination: anchor: string",
"path": "/collections/sale-potions",
"raw_liquid": "{% paginate collection.products by 2 %}\n {% for product in collection.products %}\n {{- product.title }}\n {% endfor %}\n\n <div id=\"pagination\">\n {{- paginate | default_pagination: anchor: 'pagination' -}}\n </div>\n{% endpaginate %}",
"parameter": true,
"display_type": "text",
"show_data_tab": false
}
],
"summary": "Generates HTML for a set of links for paginated results. Must be applied to the [`paginate` object](/docs/api/liquid/objects/paginate).",
Expand Down
62 changes: 62 additions & 0 deletions data/objects.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4338,6 +4338,22 @@
],
"summary": "Returns `true` if an avatar is associated with a customer. Returns `false` if not.",
"name": "has_avatar?"
},
{
"deprecated": false,
"deprecation_reason": "",
"description": "The account shown will be in the currency associated with the customer’s current context.\nFor example, if a customer is browsing the storefront in the US market, their USD store credit account will be\nreturned. If they do not have a USD store credit account `nil` will be returned.",
"examples": [],
"return_type": [
{
"type": "store_credit_account",
"name": "",
"description": "",
"array_value": ""
}
],
"summary": "The store credit account associated with the customer.",
"name": "store_credit_account"
}
],
"summary": "A [customer](https://help.shopify.com/manual/customers) of the store.",
Expand Down Expand Up @@ -9583,6 +9599,10 @@
{
"object": "metafield",
"property": "value"
},
{
"object": "store_credit_account",
"property": "balance"
}
],
"template": []
Expand Down Expand Up @@ -16047,6 +16067,48 @@
},
"return_type": []
},
{
"access": {
"global": false,
"parents": [
{
"object": "customer",
"property": "store_credit_account"
}
],
"template": []
},
"deprecated": false,
"deprecation_reason": "",
"description": "",
"properties": [
{
"deprecated": false,
"deprecation_reason": "",
"description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.",
"examples": [],
"return_type": [
{
"type": "money",
"name": "",
"description": "",
"array_value": ""
}
],
"summary": "The balance of the store credit account in the currency's subunit.",
"name": "balance"
}
],
"summary": "A [store_credit_account](https://help.shopify.com/en/manual/customers/store-credit) owned by a [customer](/docs/api/liquid/objects/customer).",
"name": "store_credit_account",
"examples": [],
"json_data": {
"path": "/",
"handle": "customer.store_credit_account",
"data_from_file": ""
},
"return_type": []
},
{
"access": {
"global": false,
Expand Down
12 changes: 6 additions & 6 deletions data/tags.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1074,15 +1074,15 @@
"category": "theme",
"deprecated": false,
"deprecation_reason": "",
"description": "You need to use these tags only if your section or app block is meant to be installed on multiple themes or stores. Otherwise, you should include the JavaScript that your section needs in your theme's [`assets`](/themes/architecture#assets) directory. Each section or app block can have only one `{% javascript %}` tag.\n\nTo learn more about how section-specific JavaScript is loaded and run, refer to the documentation for [sections](/themes/architecture/sections/section-assets#javascript).\n> Caution:\n> Liquid isn't rendered inside of `{% javascript %}` tags. Including Liquid code can cause syntax errors.",
"description": "Each section, block or snippet can have only one `{% javascript %}` tag.\n\nTo learn more about how Javascript that's defined between the `javascript` tags is loaded and run, refer to the documentation for [javascript tags](/storefronts/themes/best-practices/javascript-and-stylesheet-tags#javascript).\n> Caution:\n> Liquid isn't rendered inside of `{% javascript %}` tags. Including Liquid code can cause syntax errors.",
"parameters": [],
"summary": "JavaScript code included in a [section](/themes/architecture/sections) file.",
"summary": "JavaScript code included in [section](/storefronts/themes/architecture/sections), [block](/storefronts/themes/architecture/blocks) and [snippet](/storefronts/themes/architecture/snippets) files.",
"name": "javascript",
"syntax": "{% javascript %}\n javascript_code\n{% endjavascript %}",
"syntax_keywords": [
{
"keyword": "javascript_code",
"description": "The JavaScript code for the section."
"description": "The JavaScript code for the section, block or snippet."
}
],
"examples": []
Expand Down Expand Up @@ -1119,15 +1119,15 @@
"category": "theme",
"deprecated": false,
"deprecation_reason": "",
"description": "You need to use these tags only if your section or app block is meant to be installed on multiple themes or stores. Otherwise, you should include the CSS styles that your section needs in your theme's [`assets`](/themes/architecture#assets) directory. Each section or app block can have only one `{% stylesheet %}` tag.\n\nTo learn more about how section-specific CSS is loaded and run, refer to the documentation for [sections](/themes/architecture/sections/section-assets#stylesheet).\n> Caution:\n> Liquid isn't rendered inside of `{% stylesheet %}` tags. Including Liquid code can cause syntax errors.",
"description": "Each section, block or snippet can have only one `{% stylesheet %}` tag.\n\nTo learn more about how CSS that's defined between the `stylesheet` tags is loaded and run, refer to the documentation for [stylesheet tags](/storefronts/themes/best-practices/javascript-and-stylesheet-tags#stylesheet).\n> Caution:\n> Liquid isn't rendered inside of `{% stylesheet %}` tags. Including Liquid code can cause syntax errors.",
"parameters": [],
"summary": "CSS styles included in a [section](/themes/architecture/sections) file.",
"summary": "CSS styles included in [section](/storefronts/themes/architecture/sections), [block](/storefronts/themes/architecture/blocks) and [snippet](/storefronts/themes/architecture/snippets) files.",
"name": "stylesheet",
"syntax": "{% stylesheet %}\n css_styles\n{% endstylesheet %}",
"syntax_keywords": [
{
"keyword": "css_styles",
"description": "The CSS styles for the section."
"description": "The CSS styles for the section, block or snippet."
}
],
"examples": []
Expand Down
Loading