Skip to content

Commit 64015ab

Browse files
committed
chore: update Proxmox API specifications
## 📊 API Specification Changes This PR contains automated updates to the Proxmox API specifications. ### PVE API Changes - Endpoints: 428 → 428 (+0) - File sizes: - JSON: 3.2M - YAML: 2.4M ### PBS API Changes - Endpoints: 240 → 240 (+0) - File sizes: - JSON: 1.8M - YAML: 1.3M ### Validation Status ✅ All specifications pass OpenAPI 3.0.3 validation ### Performance Metrics ### Next Steps 1. Review the changes in the Files tab 2. Check for any breaking changes 3. Merge to update the API specifications --- *Generated automatically by GitHub Actions on 2026-01-04 02:53:02 UTC*
1 parent 1387629 commit 64015ab

5 files changed

Lines changed: 61 additions & 22 deletions

File tree

pr_body.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ This PR contains automated updates to the Proxmox API specifications.
44

55
### PVE API Changes
66

7-
- Endpoints: 410 → 428 (+18)
7+
- Endpoints: 428 → 428 (+0)
88
- File sizes:
99
- JSON: 3.2M
1010
- YAML: 2.4M
1111

1212
### PBS API Changes
1313

14-
- Endpoints: 239 → 240 (+1)
14+
- Endpoints: 240 → 240 (+0)
1515
- File sizes:
1616
- JSON: 1.8M
1717
- YAML: 1.3M
@@ -30,4 +30,4 @@ This PR contains automated updates to the Proxmox API specifications.
3030
3. Merge to update the API specifications
3131

3232
---
33-
*Generated automatically by GitHub Actions on 2025-12-07 02:44:32 UTC*
33+
*Generated automatically by GitHub Actions on 2026-01-04 02:53:02 UTC*

proxmox-backup-server/apidoc.js

Lines changed: 28 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19649,6 +19649,7 @@ var apiSchema = [
1964919649
"properties": {
1965019650
"name": {
1965119651
"description": "Package name to get changelog of.",
19652+
"pattern": "/^[a-z0-9][-+.a-z0-9:]+$/",
1965219653
"type": "string"
1965319654
},
1965419655
"node": {
@@ -28934,7 +28935,21 @@ Ext.onReady(function () {
2893428935
usage += cliUsageRenderer(method, endpoint);
2893528936
}
2893628937

28937-
let sections = [
28938+
let sections = [];
28939+
28940+
if (info.unstable) {
28941+
sections.push({
28942+
title: 'Unstable',
28943+
html: `<div class="proxmox-warning-row" style="padding: 10px;">
28944+
<i class="fa fa-exclamation-triangle" aria-hidden="true"></i>
28945+
This API endpoint is marked as unstable. All information on this
28946+
page is subject to change, including input parameters, return values
28947+
and permissions.
28948+
</div>`,
28949+
});
28950+
}
28951+
28952+
sections.push(
2893828953
{
2893928954
title: 'Description',
2894028955
html: Ext.htmlEncode(info.description),
@@ -28945,7 +28960,7 @@ Ext.onReady(function () {
2894528960
html: usage,
2894628961
bodyPadding: 10,
2894728962
},
28948-
];
28963+
);
2894928964

2895028965
if (info.parameters && info.parameters.properties) {
2895128966
let pstore = Ext.create('Ext.data.Store', {
@@ -29117,10 +29132,12 @@ Ext.onReady(function () {
2911729132
xtype: 'panel',
2911829133
title: 'Returns: ' + rtype,
2911929134
items: [
29120-
info.returns.description ? {
29121-
html: Ext.htmlEncode(info.returns.description),
29122-
bodyPadding: '5px 10px 5px 10px',
29123-
} : {},
29135+
info.returns.description
29136+
? {
29137+
html: Ext.htmlEncode(info.returns.description),
29138+
bodyPadding: '5px 10px 5px 10px',
29139+
}
29140+
: {},
2912429141
{
2912529142
xtype: 'gridpanel',
2912629143
features: [groupingFeature],
@@ -29166,12 +29183,14 @@ Ext.onReady(function () {
2916629183
text: 'Show RAW',
2916729184
handler: function (btn) {
2916829185
rawSection.setVisible(!rawSection.isVisible());
29169-
btn.setText(rawSection.isVisible() ? 'Hide RAW' : 'Show RAW');
29186+
btn.setText(
29187+
rawSection.isVisible() ? 'Hide RAW' : 'Show RAW',
29188+
);
2917029189
},
2917129190
},
2917229191
],
29173-
}
29174-
]
29192+
},
29193+
],
2917529194
});
2917629195

2917729196
sections.push(rawSection);

proxmox-backup-server/pbs-api.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34386,7 +34386,8 @@
3438634386
"required": true,
3438734387
"schema": {
3438834388
"type": "string",
34389-
"description": "Package name to get changelog of."
34389+
"description": "Package name to get changelog of.",
34390+
"pattern": "^[a-z0-9][-+.a-z0-9:]+$"
3439034391
},
3439134392
"description": "Package name to get changelog of."
3439234393
},

proxmox-backup-server/pbs-api.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23741,6 +23741,7 @@ paths:
2374123741
schema:
2374223742
type: string
2374323743
description: Package name to get changelog of.
23744+
pattern: ^[a-z0-9][-+.a-z0-9:]+$
2374423745
description: Package name to get changelog of.
2374523746
- name: version
2374623747
in: query

proxmox-virtual-environment/apidoc.js

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -65237,7 +65237,21 @@ Ext.onReady(function () {
6523765237
usage += cliUsageRenderer(method, endpoint);
6523865238
}
6523965239

65240-
let sections = [
65240+
let sections = [];
65241+
65242+
if (info.unstable) {
65243+
sections.push({
65244+
title: 'Unstable',
65245+
html: `<div class="proxmox-warning-row" style="padding: 10px;">
65246+
<i class="fa fa-exclamation-triangle" aria-hidden="true"></i>
65247+
This API endpoint is marked as unstable. All information on this
65248+
page is subject to change, including input parameters, return values
65249+
and permissions.
65250+
</div>`,
65251+
});
65252+
}
65253+
65254+
sections.push(
6524165255
{
6524265256
title: 'Description',
6524365257
html: Ext.htmlEncode(info.description),
@@ -65248,7 +65262,7 @@ Ext.onReady(function () {
6524865262
html: usage,
6524965263
bodyPadding: 10,
6525065264
},
65251-
];
65265+
);
6525265266

6525365267
if (info.parameters && info.parameters.properties) {
6525465268
let pstore = Ext.create('Ext.data.Store', {
@@ -65420,10 +65434,12 @@ Ext.onReady(function () {
6542065434
xtype: 'panel',
6542165435
title: 'Returns: ' + rtype,
6542265436
items: [
65423-
info.returns.description ? {
65424-
html: Ext.htmlEncode(info.returns.description),
65425-
bodyPadding: '5px 10px 5px 10px',
65426-
} : {},
65437+
info.returns.description
65438+
? {
65439+
html: Ext.htmlEncode(info.returns.description),
65440+
bodyPadding: '5px 10px 5px 10px',
65441+
}
65442+
: {},
6542765443
{
6542865444
xtype: 'gridpanel',
6542965445
features: [groupingFeature],
@@ -65469,12 +65485,14 @@ Ext.onReady(function () {
6546965485
text: 'Show RAW',
6547065486
handler: function (btn) {
6547165487
rawSection.setVisible(!rawSection.isVisible());
65472-
btn.setText(rawSection.isVisible() ? 'Hide RAW' : 'Show RAW');
65488+
btn.setText(
65489+
rawSection.isVisible() ? 'Hide RAW' : 'Show RAW',
65490+
);
6547365491
},
6547465492
},
6547565493
],
65476-
}
65477-
]
65494+
},
65495+
],
6547865496
});
6547965497

6548065498
sections.push(rawSection);

0 commit comments

Comments
 (0)