tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

DOCS GraphQL blacklisted fields (#9768)

Browse Source
This commit is contained in:
Ingo Schommer 2021-01-14 10:19:24 +13:00 committed by GitHub
parent 51a8245694
commit d308bb022c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/en/02_Developer_Guides/19_GraphQL/02_working_with_dataobjects/01_dataobject_model_type.md
View File

@ -126,7 +126,7 @@ Page:
#### Customising the input types #### Customising the input types
The input types, specifically in `create` and `update` can be customised with a whitelist The input types, specifically in `create` and `update` can be customised with a whitelist
and/or blacklist of fields. and/or [blacklist](#blacklisted-fields) of fields.
**app/_graphql/models.yml** **app/_graphql/models.yml**
``` ```
@ -220,6 +220,26 @@ Page:
paginateList: false # don't paginate the read operation paginateList: false # don't paginate the read operation
``` ```
### Blacklisted fields {#blacklisted-fields}
While selecting all fields via `*` is usedful, there are some fields that you
don't want to accidentally expose, especially if you're a module author
and expect models within this code to be used through custom GraphQL endpoints.
For example, a module might add a secret "preview token" to each `SiteTree`.
A custom GraphQL endpoint might have used `fields: '*'` on `SiteTree` to list pages
on the public site, which now includes a sensitive field.
The `graphql_blacklisted_fields` property on `DataObject` allows you to
blacklist fields globally for all GraphQL schemas.
This blacklist applies for all operations (read, update, etc).
**app/_config/graphql.yml**
```yaml
SilverStripe\CMS\Model\SiteTree:
graphql_blacklisted_fields:
myPreviewTokenField: true
```
### Model configuration ### Model configuration
There are several settings you can apply to your model class (typically `DataObjectModel`), There are several settings you can apply to your model class (typically `DataObjectModel`),