Skip to content
Snippets Groups Projects

Show descriptions for `:alpha` items in GraphQL docs

All threads resolved!

What does this MR do and why?

Previously the original descriptions of "alpha" items were not displayed in the generated GraphQL docs. This was because marking items as "alpha" leverages our deprecation code, and for deprecated items we only display the deprecation notice and not the original item description.

For alpha fields, we now display the warning of its instability but also the original description.

Screenshots or screen recordings

Before After
image image

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Edited by Luke Duncalfe

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • Author Maintainer

    Pipeline failure is a known master:broken #369190 (closed).

  • Krasimir Angelov
  • Krasimir Angelov approved this merge request

    approved this merge request

  • Krasimir Angelov removed review request for @krasio

    removed review request for @krasio

  • Author Maintainer

    @stanhu Could you please give this MR its backend maintainer review? Thank you!

  • Luke Duncalfe requested review from @stanhu

    requested review from @stanhu

  • Luke Duncalfe added 1 commit

    added 1 commit

    Compare with previous version

  • Stan Hu approved this merge request

    approved this merge request

  • Stan Hu resolved all threads

    resolved all threads

  • Stan Hu enabled an automatic merge when the pipeline for b35229a3 succeeds

    enabled an automatic merge when the pipeline for b35229a3 succeeds

  • Luke Duncalfe aborted the automatic merge because source branch was updated

    aborted the automatic merge because source branch was updated

  • Luke Duncalfe added 1 commit

    added 1 commit

    Compare with previous version

  • merged

  • Hi @.luke,

    Please note that authors are not authorized to merge their own merge requests and need to seek another maintainer to merge.

    For more information please refer to:

    This message was generated automatically. You're welcome to improve it.

  • Luke Duncalfe mentioned in commit 683075af

    mentioned in commit 683075af

  • Author Maintainer

    I self-merged as this was set to MWPS !93624 (comment 1046867990) and the pipeline had an unrelated failure.

  • added workflowstaging label and removed workflowcanary label

  • Harsimar Sandhu removed review request for @harsimarsandhu

    removed review request for @harsimarsandhu

  • Please register or sign in to reply
    Loading