[PR #4998] feat: API schema #4040

New issue

Open

opened 2026-02-26 08:32:54 +03:00 by kerem · 0 comments

kerem commented

2026-02-26 08:32:54 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/NginxProxyManager/nginx-proxy-manager/pull/4998
Author: @Sander0542
Created: 11/29/2025
Status: 🔄 Open

Base: develop ← Head: feature/api-schema

📝 Commits (10+)

74b4950 fix: Set certificate files format to binary
8f7dc2c fix: Expand user permissions
13fa259 fix: Expand access list owner, items, clients and proxy hosts
5163bac fix: Access list object owner, items and clients
e9fe767 fix: Permission object required fields
4b11ef8 fix: User permissions object ref
3bbb6da fix: User common refs
9ac1042 fix: Add missing expands
1aadeab fix: authorization username and password
061c354 fix: Common meta object

📊 Changes

18 files changed (+523 additions, -135 deletions)

View changed files

📝 backend/schema/common.json (+48 -6)
➕ backend/schema/components/access-list-list.json (+7 -0)
📝 backend/schema/components/access-list-object.json (+122 -3)
📝 backend/schema/components/audit-log-object.json (+1 -2)
📝 backend/schema/components/dead-host-object.json (+16 -3)
📝 backend/schema/components/permission-object.json (+44 -8)
📝 backend/schema/components/stream-object.json (+1 -2)
📝 backend/schema/components/user-object.json (+19 -71)
📝 backend/schema/paths/nginx/access-lists/get.json (+64 -13)
📝 backend/schema/paths/nginx/access-lists/listID/get.json (+62 -1)
📝 backend/schema/paths/nginx/access-lists/listID/put.json (+9 -3)
📝 backend/schema/paths/nginx/certificates/certID/get.json (+20 -3)
📝 backend/schema/paths/nginx/dead-hosts/hostID/get.json (+21 -3)
📝 backend/schema/paths/nginx/proxy-hosts/hostID/get.json (+16 -1)
📝 backend/schema/paths/nginx/redirection-hosts/hostID/get.json (+21 -3)
📝 backend/schema/paths/nginx/streams/streamID/get.json (+18 -2)
📝 backend/schema/paths/users/post.json (+14 -8)
📝 backend/schema/paths/users/userID/get.json (+20 -3)

📄 Description

Currently, the API schema has some missing properties. This PR adds the missing one so that we have a more complete API schema.

Closes #4356

_{🔄 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/NginxProxyManager/nginx-proxy-manager/pull/4998 **Author:** [@Sander0542](https://github.com/Sander0542) **Created:** 11/29/2025 **Status:** 🔄 Open **Base:** `develop` ← **Head:** `feature/api-schema` --- ### 📝 Commits (10+) - [`74b4950`](https://github.com/NginxProxyManager/nginx-proxy-manager/commit/74b4950e12df035c78245f184975dd25a7df9fd6) fix: Set certificate files format to binary - [`8f7dc2c`](https://github.com/NginxProxyManager/nginx-proxy-manager/commit/8f7dc2cfe091ab1ca65f034233070cfa041d453e) fix: Expand user permissions - [`13fa259`](https://github.com/NginxProxyManager/nginx-proxy-manager/commit/13fa25979aa28223bceae7d7bbe91f74fd073195) fix: Expand access list owner, items, clients and proxy hosts - [`5163bac`](https://github.com/NginxProxyManager/nginx-proxy-manager/commit/5163bac5a052ce418620904e31b8d71231bd4c31) fix: Access list object owner, items and clients - [`e9fe767`](https://github.com/NginxProxyManager/nginx-proxy-manager/commit/e9fe767ada22c7100941b2c919af2907947f0adc) fix: Permission object required fields - [`4b11ef8`](https://github.com/NginxProxyManager/nginx-proxy-manager/commit/4b11ef8ac41df52ac5fb47bb8734c60dd7df4469) fix: User permissions object ref - [`3bbb6da`](https://github.com/NginxProxyManager/nginx-proxy-manager/commit/3bbb6dab0172b75b6d85ed4e64192fee31ad77f9) fix: User common refs - [`9ac1042`](https://github.com/NginxProxyManager/nginx-proxy-manager/commit/9ac10422e1e084871dc53ffa44aa323c5e30f3c2) fix: Add missing expands - [`1aadeab`](https://github.com/NginxProxyManager/nginx-proxy-manager/commit/1aadeab3ea4c726c1911ba02b8c8aff7b084fe16) fix: authorization username and password - [`061c354`](https://github.com/NginxProxyManager/nginx-proxy-manager/commit/061c354ca3040e644c748eb44f5a223a131f271e) fix: Common meta object ### 📊 Changes **18 files changed** (+523 additions, -135 deletions) <details> <summary>View changed files</summary> 📝 `backend/schema/common.json` (+48 -6) ➕ `backend/schema/components/access-list-list.json` (+7 -0) 📝 `backend/schema/components/access-list-object.json` (+122 -3) 📝 `backend/schema/components/audit-log-object.json` (+1 -2) 📝 `backend/schema/components/dead-host-object.json` (+16 -3) 📝 `backend/schema/components/permission-object.json` (+44 -8) 📝 `backend/schema/components/stream-object.json` (+1 -2) 📝 `backend/schema/components/user-object.json` (+19 -71) 📝 `backend/schema/paths/nginx/access-lists/get.json` (+64 -13) 📝 `backend/schema/paths/nginx/access-lists/listID/get.json` (+62 -1) 📝 `backend/schema/paths/nginx/access-lists/listID/put.json` (+9 -3) 📝 `backend/schema/paths/nginx/certificates/certID/get.json` (+20 -3) 📝 `backend/schema/paths/nginx/dead-hosts/hostID/get.json` (+21 -3) 📝 `backend/schema/paths/nginx/proxy-hosts/hostID/get.json` (+16 -1) 📝 `backend/schema/paths/nginx/redirection-hosts/hostID/get.json` (+21 -3) 📝 `backend/schema/paths/nginx/streams/streamID/get.json` (+18 -2) 📝 `backend/schema/paths/users/post.json` (+14 -8) 📝 `backend/schema/paths/users/userID/get.json` (+20 -3) </details> ### 📄 Description Currently, the API schema has some missing properties. This PR adds the missing one so that we have a more complete API schema. Closes #4356 Related to https://github.com/Sander0542/terraform-provider-nginxproxymanager/issues/240 --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

kerem added the

pull-request

label

2026-02-26 08:32:54 +03:00

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

starred/nginx-proxy-manager-NginxProxyManager#4040

No description provided.

Rows
Columns