Skip to content

Commit 400dcba

Browse files
author
tevfik
committed
docs(openapi): add /admin/sys/{rate-limit,alerts,registration,retention}; mark /admin/config/* deprecated
1 parent 003c1b4 commit 400dcba

2 files changed

Lines changed: 2647 additions & 1036 deletions

File tree

cmd/server/openapi.yaml

Lines changed: 74 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2641,7 +2641,7 @@ paths:
26412641
schema:
26422642
type: object
26432643

2644-
/admin/config/retention:
2644+
/admin/sys/retention:
26452645
put:
26462646
summary: Update data retention policy
26472647
tags: [Admin]
@@ -2657,7 +2657,7 @@ paths:
26572657
'200':
26582658
description: Retention updated
26592659

2660-
/admin/config/rate-limit:
2660+
/admin/sys/rate-limit:
26612661
put:
26622662
summary: Update rate limit settings
26632663
tags: [Admin]
@@ -2673,7 +2673,7 @@ paths:
26732673
'200':
26742674
description: Rate limit updated
26752675

2676-
/admin/config/alerts:
2676+
/admin/sys/alerts:
26772677
put:
26782678
summary: Update alert settings
26792679
tags: [Admin]
@@ -2689,7 +2689,7 @@ paths:
26892689
'200':
26902690
description: Alerts updated
26912691

2692-
/admin/config/registration:
2692+
/admin/sys/registration:
26932693
put:
26942694
summary: Update registration settings
26952695
tags: [Admin]
@@ -2705,6 +2705,76 @@ paths:
27052705
'200':
27062706
description: Registration updated
27072707

2708+
# Deprecated aliases — emit RFC 8594 Deprecation/Sunset/Link headers
2709+
# pointing at /admin/sys/* successors. Sunset: 2026-12-31.
2710+
/admin/config/retention:
2711+
put:
2712+
deprecated: true
2713+
summary: '[DEPRECATED] Use PUT /admin/sys/retention'
2714+
tags: [Admin]
2715+
security:
2716+
- BearerAuth: []
2717+
requestBody:
2718+
required: true
2719+
content:
2720+
application/json:
2721+
schema:
2722+
$ref: '#/components/schemas/UpdateRetentionRequest'
2723+
responses:
2724+
'200':
2725+
description: Retention updated (deprecated path)
2726+
2727+
/admin/config/rate-limit:
2728+
put:
2729+
deprecated: true
2730+
summary: '[DEPRECATED] Use PUT /admin/sys/rate-limit'
2731+
tags: [Admin]
2732+
security:
2733+
- BearerAuth: []
2734+
requestBody:
2735+
required: true
2736+
content:
2737+
application/json:
2738+
schema:
2739+
$ref: '#/components/schemas/UpdateRateLimitRequest'
2740+
responses:
2741+
'200':
2742+
description: Rate limit updated (deprecated path)
2743+
2744+
/admin/config/alerts:
2745+
put:
2746+
deprecated: true
2747+
summary: '[DEPRECATED] Use PUT /admin/sys/alerts'
2748+
tags: [Admin]
2749+
security:
2750+
- BearerAuth: []
2751+
requestBody:
2752+
required: true
2753+
content:
2754+
application/json:
2755+
schema:
2756+
$ref: '#/components/schemas/UpdateAlertConfigRequest'
2757+
responses:
2758+
'200':
2759+
description: Alerts updated (deprecated path)
2760+
2761+
/admin/config/registration:
2762+
put:
2763+
deprecated: true
2764+
summary: '[DEPRECATED] Use PUT /admin/sys/registration'
2765+
tags: [Admin]
2766+
security:
2767+
- BearerAuth: []
2768+
requestBody:
2769+
required: true
2770+
content:
2771+
application/json:
2772+
schema:
2773+
$ref: '#/components/schemas/UpdateRegistrationRequest'
2774+
responses:
2775+
'200':
2776+
description: Registration updated (deprecated path)
2777+
27082778
/admin/mqtt/stats:
27092779
get:
27102780
summary: Get MQTT broker statistics

0 commit comments

Comments
 (0)