Skip to content

Add a cop to check for GraphQL field descriptions

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

What does this MR do?

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.

EE: https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/16438

Does this MR meet the acceptance criteria?

Conformity

Performance and Testing

Security

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

Related to https://gitlab.com/gitlab-org/gitlab-ce/issues/64322

Edited by charlie ablett

Merge request reports