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

Update Customer GraphQL Documentation to Include Mutations #3740

Closed
wants to merge 10 commits into from

Conversation

erikmarr
Copy link
Contributor

@erikmarr erikmarr commented Feb 14, 2019

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 issue #3338.

This PR updates the graphql documentation to include the new mutations.

Additional information

List all affected URLs

@erikmarr erikmarr requested a review from keharper February 14, 2019 16:52
@erikmarr erikmarr added 2.3.x Magento 2.3 related changes Technical Updates to the code or processes that alter the technical content of the doc Community Docs impacted by community code contribution xx2.3.1 Magento 2.3.1 changes and removed 2.3.x Magento 2.3 related changes labels Feb 14, 2019
@erikmarr erikmarr self-assigned this Feb 14, 2019
Copy link
Contributor

@keharper keharper left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some big-picture things before I start reviewing at the sentence level.

  • Create a head2 called Parameters and move all the parameter tables under that.
  • Find a way to consolidate the Customer tables. That's too much duplicate info.
  • Create subsections under Mutations: Manage customers, manage customer addresses, manage customer tokens
  • Your example usage statements are H2s. They should be a lower heading than what's used for the mutation name.

@erikmarr
Copy link
Contributor Author

@keharper I have made several changes, but am struggling with some of these suggestions. I feel like we should keep the queries and mutations as separate tables/sections since they cannot be used together in the same graphql call (at least that is my understanding). I propose a structure like:

Queries
-structure of call
-attribute tables
-example

Mutations
-structure of call
-attribute tables
-Manage customers
--Example(s)
-Manage customer address
--Example(s)
-Manage customer token
--Example(s)

Here's a new build with the above proposed structure:
https://devdocs.magedevteam.com/em_magento-graphql150/guides/v2.3/graphql/reference/customer.html

@keharper keharper changed the title Update GraphQL Documentation to Include Mutations Update Customer GraphQL Documentation to Include Mutations Feb 19, 2019
@erikmarr
Copy link
Contributor Author

@erikmarr
Copy link
Contributor Author

erikmarr commented Mar 1, 2019

closing as this is resolved in the following PR: #3818

@erikmarr erikmarr closed this Mar 1, 2019
@ghost
Copy link

ghost commented Mar 1, 2019

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.

@erikmarr erikmarr deleted the em_magento-graphql150 branch March 5, 2019 16:50
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Community Docs impacted by community code contribution Technical Updates to the code or processes that alter the technical content of the doc xx2.3.1 Magento 2.3.1 changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants