Skip to content

Add deprecation reason to GraphQL API docs

What does this MR do?

This MR adds deprecation reasons to our auto-generated GraphQL API docs.

Where a field has been deprecated, a warning icon will now display next to the field name, and the deprecation reason will now replace the description of the field.

This MR does not improve the existing deprecation reasons. We can do that in #199952 (closed).

Issue: #198571 (closed)

Screenshots

Banner

Note, since this screen cap was taken, the word "Deprecated" has been replaced with a warning icon !24331 (comment 282629757).

image

Field in table

latestPipeline is a deprecated field:

image

Does this MR meet the acceptance criteria?

Conformity

Edited by 🤖 GitLab Bot 🤖

Merge request reports

Loading