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.

Sign up for GitHub

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

Jump to bottom

PWA-1487: additional schema definition for routable interface #476

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

PWA-1487: additional schema definition for routable interface #476

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions design-documents/graph-ql/coverage/routing/storefront-route.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,10 @@ Since the entity type is built in to GraphQL introspection, `RoutableInterface`

```graphql
interface RoutableInterface {
display_metadata: String
#copied from the deprecated EntityUrl type which will not be used anymore
relative_url: String @doc(description: "The internal relative URL. If the specified url is a redirect, the query returns the redirected URL, not the original.")
redirectCode: Int @doc(description: "301 or 302 HTTP code for url permanent or temporary redirect or 0 for the 200 no redirect")
display_metadata: String
}
```

Expand All @@ -90,7 +93,7 @@ type CmsPage implements RoutableInterface {
# multiple interfaces
type SimpleProduct implements ProductInterface & RoutableInterface {
# [...other property definitions]
display_metadata: String
display_metadata: String # not to be confused with meta_description, meta_keywords, meta_title which is defined in each entity like cms
}
```

Expand All @@ -100,6 +103,7 @@ To enable clients to query based on route, add a root query to the schema.

```graphql
type Query {
urlResolver(url: String!): EntityUrl @deprecated(reason: "Use `route` instead")
route(url: String!): RoutableInterface
}
```
Expand Down