Skip to content

docs: Update example section for SwarmJoinRequest#49122

Merged
thaJeztah merged 1 commit intomoby:masterfrom
XxRoloxX:49033-update-swarmjoin-datapathaddr-examples
Dec 19, 2024
Merged

docs: Update example section for SwarmJoinRequest#49122
thaJeztah merged 1 commit intomoby:masterfrom
XxRoloxX:49033-update-swarmjoin-datapathaddr-examples

Conversation

@XxRoloxX
Copy link
Copy Markdown
Contributor

@XxRoloxX XxRoloxX commented Dec 17, 2024

- What I did
Added the missing DataPathAddr parameter to the SwarmJoin operation example:
https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Swarm/operation/SwarmJoin

fixes #49033

- How I did it

Updated the swagger.yaml file and corresponding sections in docs/api/v1.*

- How to verify it

Start the swagger server with make swagger-docs and check: localhost:9000
Additionally to validate the syntax of these changes run hack/validate/swagger.

- Description for the changelog

Updated documentation by adding the DataPathAddr parameter to example usages of the SwarmJoin operation.

- 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 <[email protected]>
@XxRoloxX XxRoloxX force-pushed the 49033-update-swarmjoin-datapathaddr-examples branch from 23d5fbd to 1aecca8 Compare December 17, 2024 20:38
Copy link
Copy Markdown
Member

@thaJeztah thaJeztah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

DataPathAddr missing from REST API payload

2 participants