docs: add example for adding a vessel to a formation via API#295
Open
Hauke Löffler (hloeffler) wants to merge 3 commits into
Open
docs: add example for adding a vessel to a formation via API#295Hauke Löffler (hloeffler) wants to merge 3 commits into
Hauke Löffler (hloeffler) wants to merge 3 commits into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new REST API example to the Multiplayer Servers documentation explaining how to append a Vessel to an existing Formation using a JSON Patch request, including guidance on per-vessel overrides and a warning about improper ownerReferences usage.
Changes:
- Documented PATCHing a Formation to add a new Vessel entry to the Formation’s vessel list.
- Added a minimal example (name + region) and an example using per-vessel container overrides.
- Added a warning admonition about why creating a standalone Vessel with
ownerReferencesis not the correct approach.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
- Capitalize Vessel and Formation when referring to resource kinds - Use consistent placeholder <your-image-object-name> across the page
Brendan Le Glaunec (Ullaakut)
approved these changes
Jun 4, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a new section to the API examples page documenting how to add a vessel
to an existing formation via a PATCH request.
Changes
src/multiplayer-servers/api/examples.mdownerReferenceson standalone vessels is not the correct approach