Adding mutation and query to configurable and downloadable product endpoints #3867

erikmarr · 2019-03-04T21:47:40Z

This PR is a:

New topic
Content update
Content fix or rewrite
Bug fix or improvement

Summary

When this pull request is merged, it will fix #3779 and #3777.

Additional information

List all affected URLs

whatsnew
Added query and mutation to the configurable and downloadable product endpoints

keharper · 2019-03-04T22:12:41Z

guides/v2.3/graphql/reference/configurable-product.md

@@ -3,18 +3,27 @@ group: graphql
 title: ConfigurableProduct endpoint
 ---

-The `ConfigurableProduct` endpoint defines which configurable product-specific attributes are returned when performing a `products` search.
+The `ConfigurableProduct` endpoint defines a query and mutation for configurable products.


Suggested change

The `ConfigurableProduct` endpoint defines a query and mutation for configurable products.

The `ConfigurableProduct` endpoint defines a mutation for adding configurable products to a cart. It also extends the `ProductInterface` so that attributes that are specific to configurable products can be queried in a `products` search.

updated sentence

I added a similar construction to the downloadable products topic

keharper · 2019-03-04T22:50:05Z

guides/v2.3/graphql/reference/configurable-product.md

-Field | Type | Description
+### Syntax
+
+`products(filter: {sku: {eq: "$ConfigurableProductSkuName"}})`


This isn't correct. For now, delete the current syntax and add the following. This will take multiple passes:

Add the following inline fragment to the output section of your products query to return information specific to configurable products:

... on ConfigurableProduct { configurable_options { <attributes> } }

keharper · 2019-03-04T22:53:24Z

guides/v2.3/graphql/reference/configurable-product.md

 --- | --- | ---
 `configurable_product_links` | SimpleProduct | An array of linked simple products
-`configurable_product_options` | ConfigurableProductOptions | An array of linked simple product items
+`configurable_product_options` | [ConfigurableProductOptions](#configProdOptions) | An array of linked simple product items


Add another pair of brackets around ConfigurableProductOptions. One pair for the link, the other to show it's an array.

keharper · 2019-03-04T22:54:37Z

guides/v2.3/graphql/reference/configurable-product.md

@@ -23,17 +32,20 @@ Field | Type | Description
 `label` | String | A string that describes the configurable product option. It is displayed on the UI.
 `position` | Int | A number that indicates the order in which the attribute is displayed
 `product_id` | Int | This is the same as a product's 'id' field
-`values` | ConfigurableProductOptionsValues | An array that defines the value_index codes assigned to the configurable product
+`values` | [ConfigurableProductOptionsValues](#configProdOptionsValues) | An array that defines the value_index codes assigned to the configurable product


Same comment about brackets

keharper · 2019-03-04T22:59:56Z

guides/v2.3/graphql/reference/configurable-product.md

+
+Attribute | Type | Description
+--- | --- | ---
+`cartItems` | [ConfigurableProductCartItemInput](#configProdCartItemInput) | An array of configurable items to add to the cart


keharper · 2019-03-04T23:03:00Z

guides/v2.3/graphql/reference/downloadable-product.md


-Field | Type | Description
+Attributes | Type | Description
 --- | --- | ---
 `downloadable_product_links` | `DownloadableProductLinks` | An array containing information about the links for this downloadable product


Add brackets here and below

keharper · 2019-03-04T23:05:21Z

guides/v2.3/graphql/reference/downloadable-product.md

+
+Attributes | Type | Description
+--- | --- | ---
+`items` | [CustomerDownloadableProduct](#custDownloadProduct) | List of purchased downloadable items


guides/v2.3/graphql/reference/downloadable-product.md

keharper

Approved, pending some tweaks.

keharper · 2019-03-05T20:18:22Z

guides/v2.3/graphql/reference/configurable-product.md


-Field | Type | Description
+### Syntax
+Add the following inline fragment to the output section of your products query to return information specific to configurable products:


Suggested change

Add the following inline fragment to the output section of your products query to return information specific to configurable products:

Add the following inline fragment to the output section of your `products` query to return information specific to configurable products:

keharper · 2019-03-05T20:19:16Z

guides/v2.3/graphql/reference/configurable-product.md

@@ -23,17 +39,20 @@ Field | Type | Description
 `label` | String | A string that describes the configurable product option. It is displayed on the UI.
 `position` | Int | A number that indicates the order in which the attribute is displayed
 `product_id` | Int | This is the same as a product's 'id' field
-`values` | ConfigurableProductOptionsValues | An array that defines the value_index codes assigned to the configurable product
+`values` | [[ConfigurableProductOptionsValues]](#configProdOptionsValues) | An array that defines the value_index codes assigned to the configurable product


Suggested change

`values` | [[ConfigurableProductOptionsValues]](#configProdOptionsValues) | An array that defines the value_index codes assigned to the configurable product

`values` | [[ConfigurableProductOptionsValues]](#configProdOptionsValues) | An array that defines the `value_index` codes assigned to the configurable product

keharper · 2019-03-05T20:21:02Z

guides/v2.3/graphql/reference/configurable-product.md

@@ -76,8 +95,8 @@ The following query returns information about configurable product `WH01`, which
          product {
            id
            categories {


The categories object produces redundant output. Let's save a few electrons by removing that object from the query.

I can't comment on text that isn't near changed text, but also delete store_label, default_label, and use_default_value (lines 88-90).

keharper · 2019-03-05T20:29:37Z

guides/v2.3/graphql/reference/downloadable-product.md


-## DownloadableProduct object
+### Syntax
+Add the following inline fragment to the output section of your products query to return information specific to downloadable products:


Suggested change

Add the following inline fragment to the output section of your products query to return information specific to downloadable products:

Add the following inline fragment to the output section of your `products` query to return information specific to downloadable products:

keharper · 2019-03-05T20:30:36Z

guides/v2.3/graphql/reference/downloadable-product.md

+## Downloadable product
+The `DownloadableProduct` object contains the following attributes:
+
+Attributes | Type | Description


Suggested change

Attributes | Type | Description

Attribute | Type | Description

keharper · 2019-03-05T20:30:47Z

guides/v2.3/graphql/reference/downloadable-product.md


-Field | Type | Description
+Attributes | Type | Description


Suggested change

Attributes | Type | Description

Attribute | Type | Description

keharper · 2019-03-05T20:30:58Z

guides/v2.3/graphql/reference/downloadable-product.md


-Field | Type | Description
+Attributes | Type | Description


Suggested change

Attributes | Type | Description

Attribute | Type | Description

keharper · 2019-03-05T20:36:41Z

guides/v2.3/graphql/reference/downloadable-product.md

+}
+```
+
+## Customer Downloadable Product {#customerDownloadProduct}


Since this query is defined in this module, move it so that it precedes the products query. Since ConfigurableProduct module only defined a mutation, it should be after the query.

moved and created new section:

Downloadable product query

The DownloadableProduct query returns downloadable product information when you perform a products search.

keharper · 2019-03-05T20:36:53Z

guides/v2.3/graphql/reference/downloadable-product.md

+### Customer downloadable products object
+The `CustomerDownloadableProducts` object contains the following attribute.
+
+Attributes | Type | Description


Suggested change

Attributes | Type | Description

Attribute | Type | Description

keharper · 2019-03-05T20:37:24Z

guides/v2.3/graphql/reference/downloadable-product.md

+### Customer downloadable product object {#custDownloadProduct}
+The `CustomerDownloadableProduct` object contains the following attributes:
+
+Attributes | Type | Description


Suggested change

Attributes | Type | Description

Attribute | Type | Description

ghost · 2019-03-05T22:20:23Z

Hi @erikmarr, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

dshevtsov · 2019-03-25T19:43:45Z

@erikmarr
There is missing whatsnew for the Major Update PR.

dshevtsov · 2019-03-25T22:33:25Z

@erikmarr please review the whatsnew description and remove an extra space inside parentheses in markdown hyperlinks

keharper · 2019-03-26T02:19:31Z

@dshevtsov I deleted the space

erikmarr added 3 commits March 4, 2019 13:03

adding mutation to topic

3655021

updating topics with new info

e8fe347

added anchor link to new query

f5f1fe9

erikmarr added Major Update Significant original updates to existing content Community Docs impacted by community code contribution xx2.3.1 Magento 2.3.1 changes labels Mar 4, 2019

erikmarr self-assigned this Mar 4, 2019

erikmarr requested a review from keharper March 4, 2019 21:47

keharper reviewed Mar 4, 2019

View reviewed changes

keharper suggested changes Mar 4, 2019

View reviewed changes

entering edits from Kevin

59c9973

keharper approved these changes Mar 5, 2019

View reviewed changes

entering another round of edits

c27b3b5

erikmarr merged commit 72995b8 into 2.3.1-integration Mar 5, 2019

erikmarr deleted the em_magento-graphqlConfigDown branch March 5, 2019 22:53

	The `ConfigurableProduct` endpoint defines a query and mutation for configurable products.
	The `ConfigurableProduct` endpoint defines a mutation for adding configurable products to a cart. It also extends the `ProductInterface` so that attributes that are specific to configurable products can be queried in a `products` search.

	Add the following inline fragment to the output section of your products query to return information specific to configurable products:
	Add the following inline fragment to the output section of your `products` query to return information specific to configurable products:

	`values` \| [[ConfigurableProductOptionsValues]](#configProdOptionsValues) \| An array that defines the value_index codes assigned to the configurable product
	`values` \| [[ConfigurableProductOptionsValues]](#configProdOptionsValues) \| An array that defines the `value_index` codes assigned to the configurable product

	Attributes \| Type \| Description
	Attribute \| Type \| Description

Adding mutation and query to configurable and downloadable product endpoints #3867

Adding mutation and query to configurable and downloadable product endpoints #3867

Uh oh!

Conversation

erikmarr commented Mar 4, 2019 • edited by keharper Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

This PR is a:

Summary

Additional information

Uh oh!

keharper Mar 4, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

keharper left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Downloadable product query

Uh oh!

Choose a reason for hiding this comment

erikmarr commented Mar 4, 2019 •

edited by keharper

Loading

keharper Mar 4, 2019 •

edited

Loading

dshevtsov commented Mar 25, 2019 •

edited

Loading