Skip to content

Add vulnerability check fields to the API docs

Problem to solve

The Vulnerability Check approval rule now has a selection of specific fields that allow further customisation of the rule's behaviour (as seen below).

Screenshot_2021-11-11_at_11.51.24

None of these fields are documented at all in our REST API docs - leaving customers 'guessing' as to what they might be.

  • What docs or doc section affected? Include links or paths
  1. https://docs.gitlab.com/ee/api/merge_request_approvals.html#create-project-level-rule
  2. https://docs.gitlab.com/ee/api/merge_request_approvals.html#update-project-level-rule

Proposal

Add API documentation to cover the additional fields.

Other links/references

As a result of slack discussions going on here:

  1. https://gitlab.slack.com/archives/CFHGVJ06R/p1636632452023500
  2. https://gitlab.slack.com/archives/C01EMBKS5DW/p1631665666032500