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

Adding GraphQL CMS and Theme Attributes to storeConfig #3803

Merged
merged 4 commits into from
Feb 22, 2019

Conversation

erikmarr
Copy link
Contributor

@erikmarr erikmarr commented Feb 21, 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 #3342

Additional information

List all affected URLs

@erikmarr erikmarr requested a review from keharper February 21, 2019 22:50
`cms_no_route` | String | Identifies a specific CMS page that you want to appear when a 404 “Page Not Found” error occurs
`front` | String | Indicates the landing page that is associated with the base URL
`no_route` | String | Contains the URL of the default page that you want to appear when if a 404 “Page not Found” error occurs
`show_cms_breadcrumbs` | Int | Determines if a breadcrumb trail appears on all CMS pages in the catalog. Options: Yes / No
Copy link
Contributor

Choose a reason for hiding this comment

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

The value can't be Yes/No when the value is an Int

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed

---

The `storeConfig` endpoint returns information about a store's configuration, including its locale, currency codes, and the secure and unsecure URLs.
The `Store` endpoint defines information about a store's configuration.
Copy link
Contributor

Choose a reason for hiding this comment

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

Add a link to https://devdocs.magento.com/guides/v2.3/graphql/send-request.html with an explanation that the Store header allows you to query a non-default store.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed


### Supported theme attributes

Use the `theme` attributes to retrieve information about the store's thematic elements; such as, footer and header information, copyright text, and logo information.
Copy link
Contributor

Choose a reason for hiding this comment

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

Mention these attributes are defined in the ThemeGraphQl module.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed

`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
`default_keywords` | String | A series of keywords that describe your store, each separated by a comma
`default_title` | String | The title that appears at the title bar of each page when viewed in a browser
`demonotice` | Int | Controls the display of the demo store notice at the top of the page. Options include: Yes / No
Copy link
Contributor

Choose a reason for hiding this comment

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

The value can't be Yes/No when the value is an Int

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed


Attribute | Data Type | Description
--- | --- | ---
`absolute_footer` | String | Contains scripts that must be included in the HTML before the closing <body> tag
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
`absolute_footer` | String | Contains scripts that must be included in the HTML before the closing <body> tag
`absolute_footer` | String | Contains scripts that must be included in the HTML before the closing `<body>` tag

Copy link
Contributor

Choose a reason for hiding this comment

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

You don't need to escape the less/greater than signs.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed

`default_keywords` | String | A series of keywords that describe your store, each separated by a comma
`default_title` | String | The title that appears at the title bar of each page when viewed in a browser
`demonotice` | Int | Controls the display of the demo store notice at the top of the page. Options include: Yes / No
`head_includes` | String | Contains scripts that must be included in the HTML before the closing &lt;head&gt; tag
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
`head_includes` | String | Contains scripts that must be included in the HTML before the closing &lt;head&gt; tag
`head_includes` | String | Contains scripts that must be included in the HTML before the closing `<head>` tag

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed

{:style="table-layout:auto;"}

### Supported CMS attributes

Use the `cms` attributes to retrieve information about the store's default pages.
Copy link
Contributor

Choose a reason for hiding this comment

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

Mention these attributes are defined in the CmsGraphQl module

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed

@erikmarr erikmarr requested a review from keharper February 22, 2019 17:27
@erikmarr
Copy link
Contributor Author

running tests

@erikmarr erikmarr merged commit 9965ed7 into master Feb 22, 2019
@ghost
Copy link

ghost commented Feb 22, 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-graphqlStoreConfig branch February 22, 2019 19:43
@erikmarr erikmarr restored the em_magento-graphqlStoreConfig branch February 22, 2019 19:58
@erikmarr erikmarr deleted the em_magento-graphqlStoreConfig branch March 5, 2019 16:50
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

GraphQL: Add documentation for storeConfig queries in 2.3.1
2 participants