Skip to content
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.

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

COMDOX-828 Services Schema #73

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open

COMDOX-828 Services Schema #73

wants to merge 12 commits into from

Conversation

jhadobe
Copy link
Contributor

@jhadobe jhadobe commented Nov 2, 2023

This PR demonstrates the possibility of having a separately generated GraphQL schema for services.

It includes:

  • Catalog Service
  • Live Search
  • Product Recommendations

Staging: https://developer-stage.adobe.com/commerce/services/graphql/reference/

Sanity check, I see the following queries:

  • attributeMetadata
  • categories
  • productSearch
  • products
  • recommendations
  • refineProduct

These queries match the following services:

@jhadobe jhadobe self-assigned this Nov 2, 2023
@jhadobe jhadobe added major-update Significant original updates to existing content maintenance internal labels Nov 2, 2023
@jhadobe jhadobe changed the title Services Schema COMDOX-828 Services Schema Nov 3, 2023
@jhadobe jhadobe marked this pull request as ready for review November 3, 2023 00:09
Copy link
Contributor

@jeff-matthews jeff-matthews left a comment

Choose a reason for hiding this comment

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

Nice work @jhadobe! 🥇 I made some suggestions based on what I saw in Kevin's migration PR (#71).

@keharper, it might be a good idea to hold off on merging #71 if this PR basically fast tracks our ambitions to eliminate the manually maintained API reference for services. Or perhaps you and Jared should combine efforts if you think the autogenerated content needs to be supplemented with manually written .md. What do you think?

I've noticed that there are some missing descriptions in some of the queries and types. It also looks like there are more types than what we currently have in production, but I'm not sure. It makes me wonder if there are some elements of the schema that should remain private.

src/pages/graphql/index.md Outdated Show resolved Hide resolved
src/pages/graphql/index.md Outdated Show resolved Hide resolved
src/pages/graphql/index.md Outdated Show resolved Hide resolved
src/data/navigation/header.js Outdated Show resolved Hide resolved
spectaql/config.yml Outdated Show resolved Hide resolved
spectaql/config.yml Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
internal maintenance major-update Significant original updates to existing content
Projects
Status: 🛠 Changes Requested
Development

Successfully merging this pull request may close these issues.

2 participants