-
Notifications
You must be signed in to change notification settings - Fork 16
Product update: roles requirements #451
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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: | ||
| 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 | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| 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.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.