Skip to content

Add missing description to field args #37

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 1 commit into from
Jul 14, 2015
Merged

Add missing description to field args #37

Show file tree
Hide file tree
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
77 changes: 77 additions & 0 deletions src/__tests__/starWarsIntrospectionTests.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,6 +298,83 @@ describe('Star Wars Introspection Tests', () => {
return testQuery(query, expected);
});

it('Allows querying the schema for field args', () => {
var query = `
query IntrospectionQueryTypeQuery {
__schema {
queryType {
fields {
name
args {
name
description
type {
name
kind
ofType {
name
kind
}
}
defaultValue
}
}
}
}
}
`;
var expected = {
__schema: {
queryType: {
fields: [
{
name: 'hero',
args: []
},
{
name: 'human',
args: [
{
name: 'id',
description: 'id of the human',
type: {
kind: 'NON_NULL',
name: null,
ofType: {
kind: 'SCALAR',
name: 'String'
}
},
defaultValue: null
}
]
},
{
name: 'droid',
args: [
{
name: 'id',
description: 'id of the droid',
type: {
kind: 'NON_NULL',
name: null,
ofType: {
kind: 'SCALAR',
name: 'String'
}
},
defaultValue: null
}
]
}
]
}
}
};

return testQuery(query, expected);
});

it('Allows querying the schema for documentation', () => {
var query = `
query IntrospectionDroidDescriptionQuery {
Expand Down
14 changes: 12 additions & 2 deletions src/__tests__/starWarsSchema.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,12 +243,22 @@ var queryType = new GraphQLObjectType({
},
human: {
type: humanType,
args: {id: { name: 'id', type: new GraphQLNonNull(GraphQLString)}},
args: {
id: {
description: 'id of the human',
type: new GraphQLNonNull(GraphQLString)
}
},
resolve: (root, {id}) => starWarsData.Humans[id],
},
droid: {
type: droidType,
args: {id: { name: 'id', type: new GraphQLNonNull(GraphQLString)}},
args: {
id: {
description: 'id of the droid',
type: new GraphQLNonNull(GraphQLString)
}
},
resolve: (root, {id}) => starWarsData.Droids[id],
},
})
Expand Down
1 change: 1 addition & 0 deletions src/type/definition.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,6 +300,7 @@ function defineFieldMap(
);
return {
name: argName,
description: arg.description === undefined ? null : arg.description,
type: arg.type,
defaultValue: arg.defaultValue === undefined ? null : arg.defaultValue
};
Expand Down