Skip to content

Commit 63157dc

Browse files
committed
docs: update SideroLinkConfig example
The provided example wasn't valid, it should not have a path component. Signed-off-by: Andrey Smirnov <andrey.smirnov@siderolabs.com>
1 parent fc7080e commit 63157dc

5 files changed

Lines changed: 10 additions & 10 deletions

File tree

pkg/machinery/config/types/siderolink/siderolink.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ type ConfigV1Alpha1 struct {
5757
// SideroLink API URL to connect to.
5858
// examples:
5959
// - value: >
60-
// "https://siderolink.api/join?token=secret"
60+
// "https://siderolink.api/?jointoken=secret"
6161
// schema:
6262
// type: string
6363
// pattern: "^(https|grpc)://"
@@ -76,7 +76,7 @@ func NewConfigV1Alpha1() *ConfigV1Alpha1 {
7676

7777
func exampleConfigV1Alpha1() *ConfigV1Alpha1 {
7878
cfg := NewConfigV1Alpha1()
79-
cfg.APIUrlConfig.URL = ensure.Value(url.Parse("https://siderolink.api/join?token=secret"))
79+
cfg.APIUrlConfig.URL = ensure.Value(url.Parse("https://siderolink.api/jointoken?token=secret"))
8080

8181
return cfg
8282
}

pkg/machinery/config/types/siderolink/siderolink_doc.go

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pkg/machinery/config/types/siderolink/siderolink_test.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@ func TestRedact(t *testing.T) {
2121
t.Parallel()
2222

2323
cfg := siderolink.NewConfigV1Alpha1()
24-
cfg.APIUrlConfig.URL = ensure.Value(url.Parse("https://siderolink.api/join?jointoken=secret&user=alice"))
24+
cfg.APIUrlConfig.URL = ensure.Value(url.Parse("https://siderolink.api/?jointoken=secret&user=alice"))
2525

26-
assert.Equal(t, "https://siderolink.api/join?jointoken=secret&user=alice", cfg.SideroLink().APIUrl().String())
26+
assert.Equal(t, "https://siderolink.api/?jointoken=secret&user=alice", cfg.SideroLink().APIUrl().String())
2727

2828
cfg.Redact("REDACTED")
2929

30-
assert.Equal(t, "https://siderolink.api/join?jointoken=REDACTED&user=alice", cfg.APIUrlConfig.String())
30+
assert.Equal(t, "https://siderolink.api/?jointoken=REDACTED&user=alice", cfg.APIUrlConfig.String())
3131
}
3232

3333
//go:embed testdata/document.yaml
@@ -37,7 +37,7 @@ func TestMarshalStability(t *testing.T) {
3737
t.Parallel()
3838

3939
cfg := siderolink.NewConfigV1Alpha1()
40-
cfg.APIUrlConfig.URL = ensure.Value(url.Parse("https://siderolink.api/join?jointoken=secret&user=alice"))
40+
cfg.APIUrlConfig.URL = ensure.Value(url.Parse("https://siderolink.api/?jointoken=secret&user=alice"))
4141

4242
marshaled, err := encoder.NewEncoder(cfg, encoder.WithComments(encoder.CommentsDisabled)).Encode()
4343
require.NoError(t, err)
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
apiVersion: v1alpha1
22
kind: SideroLinkConfig
3-
apiUrl: https://siderolink.api/join?jointoken=secret&user=alice
3+
apiUrl: https://siderolink.api/?jointoken=secret&user=alice

website/content/v1.10/reference/configuration/siderolink/siderolinkconfig.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,14 @@ title: SideroLinkConfig
1616
{{< highlight yaml >}}
1717
apiVersion: v1alpha1
1818
kind: SideroLinkConfig
19-
apiUrl: https://siderolink.api/join?token=secret # SideroLink API URL to connect to.
19+
apiUrl: https://siderolink.api/jointoken?token=secret # SideroLink API URL to connect to.
2020
{{< /highlight >}}
2121

2222

2323
| Field | Type | Description | Value(s) |
2424
|-------|------|-------------|----------|
2525
|`apiUrl` |URL |SideroLink API URL to connect to. <details><summary>Show example(s)</summary>{{< highlight yaml >}}
26-
apiUrl: https://siderolink.api/join?token=secret
26+
apiUrl: https://siderolink.api/?jointoken=secret
2727
{{< /highlight >}}</details> | |
2828

2929

0 commit comments

Comments
 (0)