Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions src/_product-updates/2026-04-07-roles-requirements.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: Roles requirements
tags: [New]
---

Your users need to know what authentication methods are required, but they also have to know what access level or roles are needed to start sending requests to specific endpoints. There's currently no way to describe it in OpenAPI: that's why we are introducing `x-rolesRequirements`. Combined with security schemes, it gives your users a complete picture.

The `x-rolesRequirements` property can be added to any OpenAPI/AsyncAPI operation. It can either be an array of strings or a string:

```yaml
paths:
/clusters:
post:
Comment thread
grossyoan marked this conversation as resolved.
summary: Create a new cluster
x-rolesRequirements:
- Organization owner
- Product owner
# ... rest of operation
/clusters/{id}:
get:
summary: Get cluster details
x-rolesRequirements: "Cluster privileges: read"
# ... rest of operation
```

![Example of roles requirements](/docs/images/changelog/roles-requirements-multilines.png)

Changes to role requirements don't create changelog entries: you can update them without affecting version history.

[Learn more about it in our help center](/help/specification-support/roles-requirements/)

As always, don't hesitate to [reach out](mailto:hello@bump.sh) if you have any feedback.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading