Before submitting, make sure you've checked the following:
Target branch: Please verify that the pull request targets the dev branch.
Description: Provide a concise description of the changes made in this pull request.
Changelog: Ensure a changelog entry following the format of Keep a Changelog is added at the bottom of the PR description.
Documentation: Have you updated relevant documentation Open WebUI Docs, or other documentation sources?
Dependencies: Are there any new dependencies? Have you updated the dependency versions in the documentation?
None
Testing: Have you written and run sufficient tests for validating the changes?
Code review: Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards?
Prefix: To cleary categorize this pull request, prefix the pull request title, using one of the following:
feat: Introduces a new feature or enhancement to the codebase
Changelog Entry
Description
You can now set the group's permissions when creating via api. The datatype for the permissions is currently a dict, although strongly typing the permissions would provide greater clarity. I chose not to strongly type the permissions here because it seems they are frequently changing/being added to.
Items not set in the API will inherit default group permissions.
Added
Added the ability to set group permissions via the API
Screenshots or Videos
Example swagger api:
Result:
Both 'Features' perms are still true.
🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.
## 📋 Pull Request Information
**Original PR:** https://github.com/open-webui/open-webui/pull/8651
**Author:** [@tarmst](https://github.com/tarmst)
**Created:** 1/17/2025
**Status:** ❌ Closed
**Base:** `dev` ← **Head:** `add-perms-to-group-creation-api`
---
### 📝 Commits (1)
- [`8fea234`](https://github.com/open-webui/open-webui/commit/8fea234e79637f476977bcfb62593075676c90d4) Allow permissions in group creation api
### 📊 Changes
**1 file changed** (+1 additions, -0 deletions)
<details>
<summary>View changed files</summary>
📝 `backend/open_webui/models/groups.py` (+1 -0)
</details>
### 📄 Description
# Pull Request Checklist
### Note to first-time contributors: Please open a discussion post in [Discussions](https://github.com/open-webui/open-webui/discussions) and describe your changes before submitting a pull request.
Discussion: https://github.com/open-webui/open-webui/discussions/8369
**Before submitting, make sure you've checked the following:**
- [x] **Target branch:** Please verify that the pull request targets the `dev` branch.
- [x] **Description:** Provide a concise description of the changes made in this pull request.
- [x] **Changelog:** Ensure a changelog entry following the format of [Keep a Changelog](https://keepachangelog.com/) is added at the bottom of the PR description.
- [x] **Documentation:** Have you updated relevant documentation [Open WebUI Docs](https://github.com/open-webui/docs), or other documentation sources?
- [x] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation?
- None
- [x] **Testing:** Have you written and run sufficient tests for validating the changes?
- [x] **Code review:** Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards?
- [x] **Prefix:** To cleary categorize this pull request, prefix the pull request title, using one of the following:
- **feat**: Introduces a new feature or enhancement to the codebase
# Changelog Entry
### Description
- You can now set the group's permissions when creating via api. The datatype for the permissions is currently a dict, although strongly typing the permissions would provide greater clarity. I chose not to strongly type the permissions here because it seems they are frequently changing/being added to.
Items not set in the API will inherit default group permissions.
### Added
- Added the ability to set group permissions via the API
### Screenshots or Videos
Example swagger api:
<img width="441" alt="Screenshot 2025-01-17 at 11 59 49 AM" src="https://github.com/user-attachments/assets/43fc047c-be94-4a56-9951-cbb1685b7d19" />
Result:
<img width="475" alt="Screenshot 2025-01-17 at 12 00 58 PM" src="https://github.com/user-attachments/assets/249c08bc-1d70-4dd0-bf55-ff49947a6458" />
Both 'Features' perms are still true.
---
<sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
📋 Pull Request Information
Original PR: https://github.com/open-webui/open-webui/pull/8651
Author: @tarmst
Created: 1/17/2025
Status: ❌ Closed
Base:
dev← Head:add-perms-to-group-creation-api📝 Commits (1)
8fea234Allow permissions in group creation api📊 Changes
1 file changed (+1 additions, -0 deletions)
View changed files
📝
backend/open_webui/models/groups.py(+1 -0)📄 Description
Pull Request Checklist
Note to first-time contributors: Please open a discussion post in Discussions and describe your changes before submitting a pull request.
Discussion: https://github.com/open-webui/open-webui/discussions/8369
Before submitting, make sure you've checked the following:
devbranch.Changelog Entry
Description
Items not set in the API will inherit default group permissions.
Added
Screenshots or Videos
Example swagger api:
Result:
Both 'Features' perms are still true.
🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.