31196-Routable Interface in GraphQL

[KrishnaK-Z]

Description (*)

Added a RoutableInterface to the base schema, and implemented in all entity types which are routable.

Related Pull Requests

https://github.com/magento/partners-magento2ee/pull/445

Fixed Issues (if relevant)

1. Fixes [EY] Routable Interface in GraphQL #31196

Manual testing scenarios (*)

Questions or comments

Sample Query:

  route(url:"about-us") {
    __typename
    display_metadata {
      title
      keywords
      description
    }
    ...on SimpleProduct {
      id
      name
      sku
    }
    ...on CategoryTree {
    name
    id
    path
    name
    description
      meta_title
      meta_keywords
      meta_description
    breadcrumbs {
      category_id
      category_name
    }
    }
    ...on CmsPage {
    	title
      url_key
      page_layout
      content
      content_heading
  }
  }
}

Contribution checklist (*)

• Pull request has a meaningful description of its purpose
• All commits are accompanied by meaningful commit messages
• All new or changed code is covered with unit/integration tests (if applicable)
• All automated tests passed successfully (all builds are green)

[m2-assistant]

Hi @KrishnaK-Z. Thank you for your contribution
Here is some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

• @magento give me test instance - deploy test instance based on PR changes
• @magento give me 2.4-develop instance - deploy vanilla Magento instance

❗ Automated tests can be triggered manually with an appropriate comment:

• @magento run all tests - run or re-run all required tests against the PR changes
• @magento run <test-build(s)> - run or re-run specific test build(s)
  For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names. Allowed build names are:

1. Database Compare
2. Functional Tests CE
3. Functional Tests EE,
4. Functional Tests B2B
5. Integration Tests
6. Magento Health Index
7. Sample Data Tests CE
8. Sample Data Tests EE
9. Sample Data Tests B2B
10. Static Tests
11. Unit Tests
12. WebAPI Tests

You can find more information about the builds here

ℹ️ Please run only needed test builds instead of all when developing. Please run all test builds before sending your PR for review.

For more details, please, review the Magento Contributor Guide documentation.

⚠️ According to the Magento Contribution requirements, all Pull Requests must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

🕙 You can find the schedule on the Magento Community Calendar page.

📞 The triage of Pull Requests happens in the queue order. If you want to speed up the delivery of your contribution, please join the Community Contributions Triage session to discuss the appropriate ticket.

🎥 You can find the recording of the previous Community Contributions Triage on the Magento Youtube Channel

✏️ Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

[KrishnaK-Z]

@magento run all tests

[keharper]

My suggestions are optional, but please accept them unless they are incorrect, or if you can improve them. I recommend using the GH web interface to accept the suggestions in a batch, then merge the batch, rather than manually updating the graphqls files.

Note that the descriptions in the UrlRewriteGraphQl schema file need more attention.

[keharper]

I stopped here, because I don't understand the schema well enough to offer any suggestions. This area of the schema is not intuitive, and the descriptions need to be more than a restatement of the attribute/type names.

I would also prefer that "metadata" not be used as part of the attribute/data type name, but changing that would require approval from Magento developers/architects.

[KrishnaK-Z]

Hi @keharper ... we had a call with @cpartica earlier regarding returning the metadata response as object. I hope this is what expected.

[KrishnaK-Z]

@magento run all tests

[KrishnaK-Z]

@magento run all tests

[KrishnaK-Z]

@magento run all tests

[KrishnaK-Z]

@magento run all tests

[cpartica]

we can't have here:
magento/module-catalog”: “”,
“magento/module-cms-graph-ql”: “”,
“magento/module-catalog-graph-ql”: “*”

Use any pattern to decouple this like composite

[prabhuram93]

This PR is being processed internally. Please do not add any more commits to this PR. Thanks!

[m2-assistant]

Hi @KrishnaK-Z, 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.