Skip to content

Commit 5dd6d8a

Browse files
docs(lb): update wording for uri param (#4595)
Co-authored-by: Jonathan R. <[email protected]>
1 parent 6137a76 commit 5dd6d8a

File tree

4 files changed

+12
-12
lines changed

4 files changed

+12
-12
lines changed

cmd/scw/testdata/test-all-usage-lb-backend-create-usage.golden

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ ARGS:
1919
[health-check.check-max-retries] Number of consecutive unsuccessful health checks after which the server will be considered dead
2020
[health-check.mysql-config.user] MySQL user to use for the health check
2121
[health-check.pgsql-config.user] PostgreSQL user to use for the health check
22-
[health-check.http-config.uri] HTTP URI used for the health check
22+
[health-check.http-config.uri] HTTP path used for the health check
2323
[health-check.http-config.method] HTTP method used for the health check
2424
[health-check.http-config.code] HTTP response code expected for a successful health check
2525
[health-check.http-config.host-header] HTTP host header used for the health check
26-
[health-check.https-config.uri] HTTP URI used for the health check
26+
[health-check.https-config.uri] HTTP path used for the health check
2727
[health-check.https-config.method] HTTP method used for the health check
2828
[health-check.https-config.code] HTTP response code expected for a successful health check
2929
[health-check.https-config.host-header] HTTP host header used for the health check

cmd/scw/testdata/test-all-usage-lb-backend-update-healthcheck-usage.golden

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ ARGS:
1414
[check-send-proxy] Defines whether proxy protocol should be activated for the health check
1515
[mysql-config.user] MySQL user to use for the health check
1616
[pgsql-config.user] PostgreSQL user to use for the health check
17-
[http-config.uri] HTTP URI used for the health check
17+
[http-config.uri] HTTP path used for the health check
1818
[http-config.method] HTTP method used for the health check
1919
[http-config.code] HTTP response code expected for a successful health check
2020
[http-config.host-header] HTTP host header used for the health check
21-
[https-config.uri] HTTP URI used for the health check
21+
[https-config.uri] HTTP path used for the health check
2222
[https-config.method] HTTP method used for the health check
2323
[https-config.code] HTTP response code expected for a successful health check
2424
[https-config.host-header] HTTP host header used for the health check

docs/commands/lb.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -291,11 +291,11 @@ scw lb backend create [arg=value ...]
291291
| health-check.check-max-retries | | Number of consecutive unsuccessful health checks after which the server will be considered dead |
292292
| health-check.mysql-config.user | | MySQL user to use for the health check |
293293
| health-check.pgsql-config.user | | PostgreSQL user to use for the health check |
294-
| health-check.http-config.uri | | HTTP URI used for the health check |
294+
| health-check.http-config.uri | | HTTP path used for the health check |
295295
| health-check.http-config.method | | HTTP method used for the health check |
296296
| health-check.http-config.code | | HTTP response code expected for a successful health check |
297297
| health-check.http-config.host-header | | HTTP host header used for the health check |
298-
| health-check.https-config.uri | | HTTP URI used for the health check |
298+
| health-check.https-config.uri | | HTTP path used for the health check |
299299
| health-check.https-config.method | | HTTP method used for the health check |
300300
| health-check.https-config.code | | HTTP response code expected for a successful health check |
301301
| health-check.https-config.host-header | | HTTP host header used for the health check |
@@ -522,11 +522,11 @@ scw lb backend update-healthcheck [arg=value ...]
522522
| check-send-proxy | | Defines whether proxy protocol should be activated for the health check |
523523
| mysql-config.user | | MySQL user to use for the health check |
524524
| pgsql-config.user | | PostgreSQL user to use for the health check |
525-
| http-config.uri | | HTTP URI used for the health check |
525+
| http-config.uri | | HTTP path used for the health check |
526526
| http-config.method | | HTTP method used for the health check |
527527
| http-config.code | | HTTP response code expected for a successful health check |
528528
| http-config.host-header | | HTTP host header used for the health check |
529-
| https-config.uri | | HTTP URI used for the health check |
529+
| https-config.uri | | HTTP path used for the health check |
530530
| https-config.method | | HTTP method used for the health check |
531531
| https-config.code | | HTTP response code expected for a successful health check |
532532
| https-config.host-header | | HTTP host header used for the health check |

internal/namespaces/lb/v1/lb_cli.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -909,7 +909,7 @@ func lbBackendCreate() *core.Command {
909909
},
910910
{
911911
Name: "health-check.http-config.uri",
912-
Short: `HTTP URI used for the health check`,
912+
Short: `HTTP path used for the health check`,
913913
Required: false,
914914
Deprecated: false,
915915
Positional: false,
@@ -937,7 +937,7 @@ func lbBackendCreate() *core.Command {
937937
},
938938
{
939939
Name: "health-check.https-config.uri",
940-
Short: `HTTP URI used for the health check`,
940+
Short: `HTTP path used for the health check`,
941941
Required: false,
942942
Deprecated: false,
943943
Positional: false,
@@ -1517,7 +1517,7 @@ func lbBackendUpdateHealthcheck() *core.Command {
15171517
},
15181518
{
15191519
Name: "http-config.uri",
1520-
Short: `HTTP URI used for the health check`,
1520+
Short: `HTTP path used for the health check`,
15211521
Required: false,
15221522
Deprecated: false,
15231523
Positional: false,
@@ -1545,7 +1545,7 @@ func lbBackendUpdateHealthcheck() *core.Command {
15451545
},
15461546
{
15471547
Name: "https-config.uri",
1548-
Short: `HTTP URI used for the health check`,
1548+
Short: `HTTP path used for the health check`,
15491549
Required: false,
15501550
Deprecated: false,
15511551
Positional: false,

0 commit comments

Comments
 (0)