Skip to content

Fix wrong syntax in GraphQL plugin docs #537

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

Merged
merged 2 commits into from
Dec 7, 2021
Merged

Fix wrong syntax in GraphQL plugin docs #537

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2120167
Fix wrong syntax in GraphQL plugin docs
iicdii Dec 1, 2021
0239037
Merge branch 'main' into dev/lint-graphql-docs
pwizla Dec 7, 2021
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
36 changes: 16 additions & 20 deletions docs/developer-docs/latest/plugins/graphql.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ input DocumentFiltersInput {
or: [DocumentFiltersInput]
not: DocumentFiltersInput
}
​

input DocumentInput {
name: String
description: String
Expand All @@ -131,7 +131,7 @@ input DocumentInput {
updatedAt: DateTime
publishedAt: DateTime
}
​

type Document {
name: String
description: String
Expand All @@ -140,21 +140,21 @@ type Document {
updatedAt: DateTime
publishedAt: DateTime
}
​

type DocumentEntity {
id: ID
attributes: Document
}
​

type DocumentEntityResponse {
data: DocumentEntity
}
​

type DocumentEntityResponseCollection {
data: [DocumentEntity!]!
meta: ResponseCollectionMeta!
}
​

type DocumentRelationResponseCollection {
data: [DocumentEntity!]!
}
Expand Down Expand Up @@ -192,23 +192,23 @@ Strapi provides a programmatic API to customize GraphQL, which allows:

```js
// path: ./src/index.js
​

module.exports = {
/**
* An asynchronous register function that runs before
* your application is initialized.
*
* This gives you an opportunity to extend code.
*/
register({ strapi }) => {
/**
* An asynchronous register function that runs before
* your application is initialized.
*
* This gives you an opportunity to extend code.
*/
register({ strapi }) {
const extensionService = strapi.plugin('graphql').service('extension');
​
extensionService.shadowCRUD('api::restaurant.restaurant').disable();
extensionService.shadowCRUD('api::category.category').disableQueries();
extensionService.shadowCRUD('api::address.address').disableMutations();
extensionService.shadowCRUD('api::document.document').field('locked').disable();
extensionService.shadowCRUD('api::like.like').disableActions(['create', 'update', 'delete']);
​
const extension = ({ nexus }) => ({
// Nexus
types: [
Expand All @@ -222,13 +222,11 @@ module.exports = {
plugins: [
nexus.plugin({
name: 'MyPlugin',
​
onAfterBuild(schema) {
console.log(schema);
},
}),
],
​
// GraphQL SDL
typeDefs: `
type Article {
Expand All @@ -244,14 +242,12 @@ module.exports = {
},
},
},
​
resolversConfig: {
'Query.address': {
auth: false,
},
},
});
​
extensionService.use(extension);
},
};
Expand Down