Declare the webhook alert_status field as a String

Max Woolfrequested to merge
mw-openapi-hook-alert-status-string into master

What does this MR do and why?

This MR fixes the type of the alert_status field on webhook entities, which was declared as a Ruby Symbol instead of a String.

  • lib/api/entities/hook.rb declared alert_status with documentation type Symbol, but Symbol is not a JSON type and the API always returns this field as a string.
  • It also updates the three example: :executable lines in doc/api/openapi/openapi_v3.yaml to example: executable, so Ruby's safe YAML loader accepts the document and other parsers see a value the API actually returns.
  • The fix belongs in the declaration, not the generator: a previous attempt at !256708 (closed) stringified Symbols in the rake task that renders the document, but for this field the declaration itself is the source of the Symbol.

The YAML file was hand-edited rather than regenerated; the static-analysis job's gitlab:openapi:v3:check_docs run verifies it matches a fresh render.

🤖 Generated with Claude Code

Merge request reports