Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

GraphQL: Update schema to include undocumented changes #8584

Merged
merged 2 commits into from
Jan 29, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions src/_includes/graphql/store-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Attribute | Data Type | Description | Default or example value
`cms_no_cookies` | String | Identifies a specific CMS page that appears when cookies are not enabled for the browser | `enable-cookies`
`cms_no_route` | String | Identifies a specific CMS page that you want to appear when a 404 “Page Not Found” error occurs | `no-route`
`code` | String | Deprecated. Use `store_code` instead. A unique identifier for the store | `default`
`configurable_thumbnail_source` | String | Determines which thumbnail should be used in the cart for configurable products. Possible values: `parent` or `itself` (child) | `parent`
`copyright` | String | The copyright statement that appears at the bottom of each page | Copyright © 2013-present Magento, Inc. All rights reserved.
`default_description` | String | The description that provides a summary of your site for search engine listings and should not be more than 160 characters in length | null
`default_display_currency_code` | String | The code representing the currency displayed on the store | `USD`
Expand Down
4 changes: 2 additions & 2 deletions src/guides/v2.4/graphql/interfaces/category-interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Attribute | Type | Description
`breadcrumbs` | [Breadcrumb] | A Breadcrumb object contains information the categories that comprise the breadcrumb trail for the specified category
`canonical_url` | String | The relative canonical URL. This value is returned only if the system setting **Use Canonical Link Meta Tag For Categories** is enabled
`cms_block` | CmsBlock | Contains a category CMS block. This attribute is defined in the `CatalogCmsGraphQl` module
`created_at` | String | Timestamp indicating when the category was created
`created_at` | String | Deprecated. This field should not be used on the storefront. Timestamp indicating when the category was created
`default_sort_by` | String | The attribute to use for sorting
`description` | String | An optional description of the category
`id` | Int | Deprecated. Use `uid` instead. An ID that uniquely identifies the category
Expand All @@ -29,7 +29,7 @@ Attribute | Type | Description
`products(<attributes>)` | CategoryProducts | The list of products assigned to the category
`staged` | Boolean! | Indicates whether the category is staged for a future campaign
`uid` | ID! | The unique ID for an object implementing `CategoryInterface`
`updated_at` | String | Timestamp indicating when the category was updated
`updated_at` | String | Deprecated. This field should not be used on the storefront. Timestamp indicating when the category was updated
`url_key` | String | The URL key assigned to the category
`url_path` | String | The URL path assigned to the category

Expand Down
12 changes: 6 additions & 6 deletions src/guides/v2.4/graphql/interfaces/product-interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ The following table defines the `ProductInterface` attributes and objects.

Attribute | Data type | Description
--- | --- | ---
`attribute_set_id` | Int | The attribute set assigned to the product
`attribute_set_id` | Int | Deprecated. This field should not be used on the storefront. The attribute set assigned to the product
`canonical_url` | String | The relative canonical URL. This value is returned only if the system setting **Use Canonical Link Meta Tag For Products** is enabled
`categories` | [[CategoryInterface]]({{ page.baseurl }}/graphql/interfaces/category-interface.html) | The categories assigned to the product. See [CategoryInterface attributes]({{ page.baseurl }}/graphql/interfaces/category-interface.html) for more information
`country_of_manufacture` | String | The product's country of origin
`created_at` | String | Timestamp indicating when the product was created
`created_at` | String | Deprecated. This field should not be used on the storefront. Timestamp indicating when the product was created
`crosssell_products` | [ProductInterface] | An array of cross-sell products
`description` | ComplexTextValue | An object that contains detailed information about the product. The object can include simple HTML tags
`gift_message_available` | String | Indicates whether a gift message is available
Expand All @@ -43,8 +43,8 @@ Attribute | Data type | Description
`meta_keyword` | String | A comma-separated list of keywords that are visible only to search engines
`meta_title` | String | A string that is displayed in the title bar and tab of the browser and in search results lists
`name` | String | The product name. Customers use this name to identify the product.
`new_from_date` | String | The beginning date for new product listings, and determines if the product is featured as a new product
`new_to_date` | String | The end date for new product listings
`new_from_date` | String | Deprecated. This field should not be used on the storefront. The beginning date for new product listings, and determines if the product is featured as a new product
`new_to_date` | String | Deprecated. This field should not be used on the storefront. The end date for new product listings
`only_x_left_in_stock` | Float | The "Only X left Threshold" assigned to the product. This attribute is defined in the `InventoryGraphQl` module.
`options_container` | String | If the product has multiple options, determines where they appear on the product page
`price` | ProductPrices | Deprecated. Use `price_range` instead
Expand All @@ -58,7 +58,7 @@ Attribute | Data type | Description
`short_description` | ComplexTextValue | An object that contains a short description of the product. Its use depends on the store's theme. The object can include simple HTML tags
`sku` | String | A number or code assigned to a product to identify the product, options, price, and manufacturer
`small_image` | [ProductImage](#ProductImage) | An object that contains the URL and label for the small image used on catalog pages
`special_from_date` | String | The beginning date that a product has a special price
`special_from_date` | String | Deprecated. This field should not be used on the storefront. The beginning date that a product has a special price
`special_price` | Float | The discounted price of the product
`special_to_date` | String | The end date that a product has a special price
`staged` | Boolean! | Indicates whether the product is staged for a future campaign
Expand All @@ -70,7 +70,7 @@ Attribute | Data type | Description
`tier_prices` | [ProductTierPrices] | Deprecated. Use `price_tiers` instead
`type_id` | String | Deprecated. Use the GraphQL `__typename` meta attribute instead
`uid` | ID! | The unique ID for objects implementing `ProductInterface`
`updated_at` | String | The timestamp indicating when the product was last updated
`updated_at` | String | Deprecated. This field should not be used on the storefront. The timestamp indicating when the product was last updated
`upsell_products` | [ProductInterface] | An array of up-sell products
`url_key` | String | The part of the URL that identifies the product. This attribute is defined in the `CatalogUrlRewriteGraphQl` module
`url_path` | String | Deprecated. Use `canonical_url` instead
Expand Down