This PR adds support for docblock descriptions for native enums and enum cases, as well as deprecation tag support for cases.
This enum
/**
* This is the description of the enum itself
*/
enum TestEnum
{
/**
* This is a case description
*/
case FOO;
/**
* This is another case description
* @deprecated it should not be used anymore
*/
case BAR;
}
results in the following type description in the schema:
{
"kind": "ENUM",
"name": "TestEnum",
"description": "This is the description of the enum itself",
"specifiedByUrl": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "BAR",
"description": "This is another case description",
"isDeprecated": true,
"deprecationReason": "it should not be used anymore"
},
{
"name": "FOO",
"description": "This is a case description",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
}
This PR adds support for docblock descriptions for native enums and enum cases, as well as deprecation tag support for cases.
This enum
results in the following type description in the schema:
GraphiQL output