Skip to content

Add cop to check for GraphQL field descriptions (EE)

charlie ablett requested to merge cop-for-graphql-field-descriptions-ee into master

What does this MR do?

EE port of

Adds a Rubocop custom cop to raise an error if a modified GraphQL field is missing a description. Since descriptions are a part of the generated GraphQL docs, having the descriptions filled in makes it more useful.

This cop ignores existing failures, but #67087 addresses that.

Does this MR meet the acceptance criteria?


Performance and Testing


If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:

  • [-] Label as security and @ mention @gitlab-com/gl-security/appsec
  • [-] The MR includes necessary changes to maintain consistency between UI, API, email, or other methods
  • [-] Security reports checked/validated by a reviewer from the AppSec team
Edited by 🤖 GitLab Bot 🤖

Merge request reports