From 1aecca8bbd9389201cf9bfaf8d0cc7ce4d849176 Mon Sep 17 00:00:00 2001 From: Adam Lamers Date: Tue, 17 Dec 2024 18:35:48 +0100 Subject: [PATCH] docs: Update example section for SwarmJoinRequest - Updated the example section in `swagger.yaml` for the `DataPathAddr` parameter in `SwarmJoinRequest`. - Updated corresponding example sections in `docs/api/v1.*` Signed-off-by: Adam Lamers --- api/swagger.yaml | 1 + docs/api/v1.30.yaml | 1 + docs/api/v1.31.yaml | 1 + docs/api/v1.32.yaml | 1 + docs/api/v1.33.yaml | 1 + docs/api/v1.34.yaml | 1 + docs/api/v1.35.yaml | 1 + docs/api/v1.36.yaml | 1 + docs/api/v1.37.yaml | 1 + docs/api/v1.38.yaml | 1 + docs/api/v1.39.yaml | 1 + docs/api/v1.40.yaml | 1 + docs/api/v1.41.yaml | 1 + docs/api/v1.42.yaml | 1 + docs/api/v1.43.yaml | 1 + docs/api/v1.44.yaml | 1 + docs/api/v1.45.yaml | 1 + docs/api/v1.46.yaml | 1 + docs/api/v1.47.yaml | 1 + 19 files changed, 19 insertions(+) diff --git a/api/swagger.yaml b/api/swagger.yaml index 79bb65755616d..6a1d487bc88a9 100644 --- a/api/swagger.yaml +++ b/api/swagger.yaml @@ -11696,6 +11696,7 @@ paths: example: ListenAddr: "0.0.0.0:2377" AdvertiseAddr: "192.168.1.1:2377" + DataPathAddr: "192.168.1.1" RemoteAddrs: - "node1:2377" JoinToken: "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2" diff --git a/docs/api/v1.30.yaml b/docs/api/v1.30.yaml index 8f2941511d821..a418162f227b1 100644 --- a/docs/api/v1.30.yaml +++ b/docs/api/v1.30.yaml @@ -7582,6 +7582,7 @@ paths: example: ListenAddr: "0.0.0.0:2377" AdvertiseAddr: "192.168.1.1:2377" + DataPathAddr: "192.168.1.1" RemoteAddrs: - "node1:2377" JoinToken: "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2" diff --git a/docs/api/v1.31.yaml b/docs/api/v1.31.yaml index ad95f8b84d2fa..cbfd14071556b 100644 --- a/docs/api/v1.31.yaml +++ b/docs/api/v1.31.yaml @@ -7679,6 +7679,7 @@ paths: example: ListenAddr: "0.0.0.0:2377" AdvertiseAddr: "192.168.1.1:2377" + DataPathAddr: "192.168.1.1" RemoteAddrs: - "node1:2377" JoinToken: "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2" diff --git a/docs/api/v1.32.yaml b/docs/api/v1.32.yaml index 1b4f849745266..e41f062fefe4e 100644 --- a/docs/api/v1.32.yaml +++ b/docs/api/v1.32.yaml @@ -8636,6 +8636,7 @@ paths: example: ListenAddr: "0.0.0.0:2377" AdvertiseAddr: "192.168.1.1:2377" + DataPathAddr: "192.168.1.1" RemoteAddrs: - "node1:2377" JoinToken: "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2" diff --git a/docs/api/v1.33.yaml b/docs/api/v1.33.yaml index 6a95e9fe03e05..6a87f72b24c57 100644 --- a/docs/api/v1.33.yaml +++ b/docs/api/v1.33.yaml @@ -8644,6 +8644,7 @@ paths: example: ListenAddr: "0.0.0.0:2377" AdvertiseAddr: "192.168.1.1:2377" + DataPathAddr: "192.168.1.1" RemoteAddrs: - "node1:2377" JoinToken: "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2" diff --git a/docs/api/v1.34.yaml b/docs/api/v1.34.yaml index 291eb74c6cf4d..085395936645e 100644 --- a/docs/api/v1.34.yaml +++ b/docs/api/v1.34.yaml @@ -8684,6 +8684,7 @@ paths: example: ListenAddr: "0.0.0.0:2377" AdvertiseAddr: "192.168.1.1:2377" + DataPathAddr: "192.168.1.1" RemoteAddrs: - "node1:2377" JoinToken: "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2" diff --git a/docs/api/v1.35.yaml b/docs/api/v1.35.yaml index 708c59fb60b2b..eea9a1c2376f6 100644 --- a/docs/api/v1.35.yaml +++ b/docs/api/v1.35.yaml @@ -8717,6 +8717,7 @@ paths: example: ListenAddr: "0.0.0.0:2377" AdvertiseAddr: "192.168.1.1:2377" + DataPathAddr: "192.168.1.1" RemoteAddrs: - "node1:2377" JoinToken: "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2" diff --git a/docs/api/v1.36.yaml b/docs/api/v1.36.yaml index 5cc32eedce105..cf066d4cdf7ff 100644 --- a/docs/api/v1.36.yaml +++ b/docs/api/v1.36.yaml @@ -8761,6 +8761,7 @@ paths: example: ListenAddr: "0.0.0.0:2377" AdvertiseAddr: "192.168.1.1:2377" + DataPathAddr: "192.168.1.1" RemoteAddrs: - "node1:2377" JoinToken: "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2" diff --git a/docs/api/v1.37.yaml b/docs/api/v1.37.yaml index 466cc4ac31f88..ec16073e5f5f5 100644 --- a/docs/api/v1.37.yaml +++ b/docs/api/v1.37.yaml @@ -8804,6 +8804,7 @@ paths: example: ListenAddr: "0.0.0.0:2377" AdvertiseAddr: "192.168.1.1:2377" + DataPathAddr: "192.168.1.1" RemoteAddrs: - "node1:2377" JoinToken: "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2" diff --git a/docs/api/v1.38.yaml b/docs/api/v1.38.yaml index 8c8f5db75a602..660900a62588e 100644 --- a/docs/api/v1.38.yaml +++ b/docs/api/v1.38.yaml @@ -8875,6 +8875,7 @@ paths: example: ListenAddr: "0.0.0.0:2377" AdvertiseAddr: "192.168.1.1:2377" + DataPathAddr: "192.168.1.1" RemoteAddrs: - "node1:2377" JoinToken: "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2" diff --git a/docs/api/v1.39.yaml b/docs/api/v1.39.yaml index cae679c9cafb0..d62e90b819a1e 100644 --- a/docs/api/v1.39.yaml +++ b/docs/api/v1.39.yaml @@ -10194,6 +10194,7 @@ paths: example: ListenAddr: "0.0.0.0:2377" AdvertiseAddr: "192.168.1.1:2377" + DataPathAddr: "192.168.1.1" RemoteAddrs: - "node1:2377" JoinToken: "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2" diff --git a/docs/api/v1.40.yaml b/docs/api/v1.40.yaml index 3ac6997b37b08..d5416311d984a 100644 --- a/docs/api/v1.40.yaml +++ b/docs/api/v1.40.yaml @@ -10508,6 +10508,7 @@ paths: example: ListenAddr: "0.0.0.0:2377" AdvertiseAddr: "192.168.1.1:2377" + DataPathAddr: "192.168.1.1" RemoteAddrs: - "node1:2377" JoinToken: "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2" diff --git a/docs/api/v1.41.yaml b/docs/api/v1.41.yaml index 6ef61c705e736..58c1c2b58ed79 100644 --- a/docs/api/v1.41.yaml +++ b/docs/api/v1.41.yaml @@ -10807,6 +10807,7 @@ paths: example: ListenAddr: "0.0.0.0:2377" AdvertiseAddr: "192.168.1.1:2377" + DataPathAddr: "192.168.1.1" RemoteAddrs: - "node1:2377" JoinToken: "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2" diff --git a/docs/api/v1.42.yaml b/docs/api/v1.42.yaml index db0a47fe78eea..bddf47c836508 100644 --- a/docs/api/v1.42.yaml +++ b/docs/api/v1.42.yaml @@ -11185,6 +11185,7 @@ paths: example: ListenAddr: "0.0.0.0:2377" AdvertiseAddr: "192.168.1.1:2377" + DataPathAddr: "192.168.1.1" RemoteAddrs: - "node1:2377" JoinToken: "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2" diff --git a/docs/api/v1.43.yaml b/docs/api/v1.43.yaml index 5846dce83be18..5eb5b501b2815 100644 --- a/docs/api/v1.43.yaml +++ b/docs/api/v1.43.yaml @@ -11203,6 +11203,7 @@ paths: example: ListenAddr: "0.0.0.0:2377" AdvertiseAddr: "192.168.1.1:2377" + DataPathAddr: "192.168.1.1" RemoteAddrs: - "node1:2377" JoinToken: "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2" diff --git a/docs/api/v1.44.yaml b/docs/api/v1.44.yaml index cecb079cb706d..939f9e158c137 100644 --- a/docs/api/v1.44.yaml +++ b/docs/api/v1.44.yaml @@ -11373,6 +11373,7 @@ paths: example: ListenAddr: "0.0.0.0:2377" AdvertiseAddr: "192.168.1.1:2377" + DataPathAddr: "192.168.1.1" RemoteAddrs: - "node1:2377" JoinToken: "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2" diff --git a/docs/api/v1.45.yaml b/docs/api/v1.45.yaml index f97947ebc7965..290924a4ae824 100644 --- a/docs/api/v1.45.yaml +++ b/docs/api/v1.45.yaml @@ -11353,6 +11353,7 @@ paths: example: ListenAddr: "0.0.0.0:2377" AdvertiseAddr: "192.168.1.1:2377" + DataPathAddr: "192.168.1.1" RemoteAddrs: - "node1:2377" JoinToken: "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2" diff --git a/docs/api/v1.46.yaml b/docs/api/v1.46.yaml index a5c70e607d9e2..df99f1e6361d6 100644 --- a/docs/api/v1.46.yaml +++ b/docs/api/v1.46.yaml @@ -11472,6 +11472,7 @@ paths: example: ListenAddr: "0.0.0.0:2377" AdvertiseAddr: "192.168.1.1:2377" + DataPathAddr: "192.168.1.1" RemoteAddrs: - "node1:2377" JoinToken: "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2" diff --git a/docs/api/v1.47.yaml b/docs/api/v1.47.yaml index 5fc41213632d2..3ff1f0725eaf2 100644 --- a/docs/api/v1.47.yaml +++ b/docs/api/v1.47.yaml @@ -11618,6 +11618,7 @@ paths: example: ListenAddr: "0.0.0.0:2377" AdvertiseAddr: "192.168.1.1:2377" + DataPathAddr: "192.168.1.1" RemoteAddrs: - "node1:2377" JoinToken: "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2"