Skip to content

Commit 0ce8823

Browse files
ElderMattsvcAPLBot
andauthored
fix: broken links to techdocs (#835)
* fix: broken help urls * fix: added settings for cluster and obj --------- Co-authored-by: svcAPLBot <[email protected]>
1 parent 7d2d4b3 commit 0ce8823

File tree

2 files changed

+10
-8
lines changed

2 files changed

+10
-8
lines changed

src/openapi/settings.yaml

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,12 @@ Settings:
1010
$ref: 'definitions.yaml#/alerts'
1111
title: Alerts
1212
description: Configure alerting endpoints to receive notifications from Alertmanager.
13-
x-externalDocsPath: docs/for-ops/console/settings/alerts
13+
x-externalDocsPath: alert-settings
1414
cluster:
1515
additionalProperties: false
1616
$ref: 'cluster.yaml#/Cluster'
1717
title: Cluster
18+
x-externalDocsPath: cluster-settings
1819
platformBackups:
1920
additionalProperties: false
2021
type: object
@@ -73,6 +74,7 @@ Settings:
7374
$ref: 'definitions.yaml#/wordCharacterPattern'
7475
x-secret: true
7576
obj:
77+
x-externalDocsPath: object-storage-settings
7678
type: object
7779
properties:
7880
showWizard:
@@ -173,7 +175,7 @@ Settings:
173175
- type
174176
dns:
175177
$ref: 'definitions.yaml#/dns'
176-
x-externalDocsPath: docs/for-ops/console/settings/dns
178+
x-externalDocsPath: dns
177179
x-acl:
178180
platformAdmin: [read-any, update-any]
179181
teamAdmin: []
@@ -207,7 +209,7 @@ Settings:
207209
- className
208210
kms:
209211
$ref: 'definitions.yaml#/kms'
210-
x-externalDocsPath: docs/for-ops/console/settings/key-management
212+
x-externalDocsPath: sops
211213
x-acl:
212214
platformAdmin: [read-any, update-any]
213215
teamAdmin: []
@@ -244,7 +246,7 @@ Settings:
244246
description: Set OIDC claim to be passed by Keycloak as a unique user identifier. It is advised to not change the default.
245247
default: sub
246248
type: object
247-
x-externalDocsPath: docs/for-ops/console/settings/oidc
249+
x-externalDocsPath: oidc-settings
248250
x-acl:
249251
platformAdmin: [read-any, update-any]
250252
teamAdmin: []
@@ -350,7 +352,7 @@ Settings:
350352
description: Defines if the OCI Registry Cache Service (ORCS) is used to cache images from the public registry.
351353
required:
352354
- version
353-
x-externalDocsPath: docs/for-ops/console/settings/platform
355+
x-externalDocsPath: general-platform-settings
354356
x-acl:
355357
platformAdmin: [read-any, update-any]
356358
teamAdmin: [read]
@@ -368,7 +370,7 @@ Settings:
368370
type: string
369371
required:
370372
- version
371-
x-externalDocsPath: docs/for-ops/console/settings/platform
373+
x-externalDocsPath: general-platform-settings
372374
x-acl:
373375
platformAdmin: [read-any, update-any]
374376
teamAdmin: [read]
@@ -406,7 +408,7 @@ Settings:
406408
required:
407409
- smarthost
408410
type: object
409-
x-externalDocsPath: docs/for-ops/console/settings/smtp
411+
x-externalDocsPath: for-ops/console/settings/smtp
410412
x-acl:
411413
platformAdmin: [read-any, update-any]
412414
teamAdmin: []

src/openapi/team.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ Team:
112112
- read
113113
- update
114114
type: object
115-
x-externalDocsPath: docs/for-ops/console/teams
115+
x-externalDocsPath: platform-teams
116116

117117
AplTeamSpec:
118118
type: object

0 commit comments

Comments
 (0)