mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-09-18 23:46:21 +02:00
c1cda2b113
* DOCS: Add new graphql 4 docs * Reorganise docs * Docs done * Basic graphql index page * TOC for getting started * show folders on graphql index page * Add middleware note * Docs update * Update docs to reflect flushless schema * Docs updates * Docs for getByLink * Query caching docs * Docs on nested operations * update docs for new graphql dev admin * Docs for configurable operations * Replace readSiteTrees with readPages * Schema defaults docs * Docs for inherited plugins * Docs for customising * * Docs for field whitelisting * Change whitelist word * New docs on modelConfig * Document dev/build extension * Document default/global plugins * Document new input type fields config * Apply suggestions from code review Co-authored-by: Andre Kiste <bergice@users.noreply.github.com> * Note about when procedural schema gets built * Fix link * Apply suggestions from code review Co-authored-by: Andre Kiste <bergice@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Andre Kiste <bergice@users.noreply.github.com> * DOCS Note about plugins in custom queries * DOCS Note about filter and custom resolvers * DOCS Note about canview paging * DOCS Updated guidance on _extend See https://github.com/silverstripe/silverstripe-graphql/issues/296 * Apply suggestions from code review Co-authored-by: Andre Kiste <bergice@users.noreply.github.com> * DOCS Pre-release warning Co-authored-by: Ingo Schommer <ingo@silverstripe.com> Co-authored-by: Andre Kiste <bergice@users.noreply.github.com> Co-authored-by: Ingo Schommer <me@chillu.com>
62 lines
1.5 KiB
Markdown
62 lines
1.5 KiB
Markdown
---
|
|
title: Nested type definitions
|
|
summary: Define dependent types inline with a parent type
|
|
---
|
|
# Working with DataObjects
|
|
|
|
[CHILDREN asList]
|
|
|
|
[alert]
|
|
You are viewing docs for a pre-release version of silverstripe/graphql (4.x).
|
|
Help us improve it by joining #graphql on the [Community Slack](https://www.silverstripe.org/blog/community-slack-channel/),
|
|
and report any issues at [github.com/silverstripe/silverstripe-graphql](https://github.com/silverstripe/silverstripe-graphql).
|
|
Docs for the current stable version (3.x) can be found
|
|
[here](https://github.com/silverstripe/silverstripe-graphql/tree/3)
|
|
[/alert]
|
|
|
|
## Nested type definitions
|
|
|
|
For readability and ergonomics, you can take advantage of nested type definitions. Let's imagine
|
|
we have a `Blog` and we want to expose `Author` and `Categories`, but while we're at it, we want
|
|
to specify what fields they should have.
|
|
|
|
*app/_graphql/models.yml*
|
|
```yaml
|
|
MyProject\Pages\Blog:
|
|
fields:
|
|
title: true
|
|
author:
|
|
fields:
|
|
firstName: true
|
|
surname: true
|
|
email: true
|
|
categories:
|
|
fields: '*'
|
|
```
|
|
|
|
Alternatively, we could flatten that out:
|
|
|
|
*app/_graphql/models.yml*
|
|
```yaml
|
|
MyProject\Pages\Blog:
|
|
fields:
|
|
title: true
|
|
author: true
|
|
categories: true
|
|
SilverStripe\Securty\Member:
|
|
fields
|
|
firstName: true
|
|
surname: true
|
|
email: true
|
|
MyProject\Models\BlogCategory:
|
|
fields: '*'
|
|
```
|
|
|
|
[info]
|
|
You cannot define operations on nested types. They only accept fields.
|
|
[/info]
|
|
|
|
### Further reading
|
|
|
|
[CHILDREN]
|