Skip to content

Expose config option to show swagger operationId

Jacques Erasmus requested to merge 361126-expose-operationId-config into master

What does this MR do and why?

Gives users the option to show operation IDs when viewing OpenAPI spec files by passing ?displayOperationId=true in the query string.

The is the default behaviour of SwaggerUI (example).

Screenshots or screen recordings

Operation IDs hidden Operation IDs visible
Screenshot_2023-08-21_at_12.10.15 Screenshot_2023-08-21_at_12.10.52

How to set up and validate locally

  1. Open a OpenAPI spec file (swagger.json)
  2. The operation IDs should not show by default
  3. Adding ?displayOperationId=true to the URL show show the operation IDs

MR acceptance checklist

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

Related to #361126 (closed)

Edited by Jacques Erasmus

Merge request reports