Markdown

• bullet lists, numbered lists
• italic, bold, struck text
• accordions
• links
• tables
• images
• alerts
• …

Alerts#

You can use markdown alerts in your descriptions.

> [!tip]
> You can now use markdown alerts in your descriptions.

The following alert types are supported:

• note
• tip
• important
• warning
• caution
• success

Have a look at our OpenAPI example to see more examples.

Note: Not everything is supported in all places. For example, you can use images in most places, but not in parameter descriptions.