Skip to content

Correct SpawnEntity service call example#700

Merged
azeey merged 3 commits into
gazebosim:masterfrom
C88-YQ:fix-spawn-entity-doc
Jun 18, 2026
Merged

Correct SpawnEntity service call example#700
azeey merged 3 commits into
gazebosim:masterfrom
C88-YQ:fix-spawn-entity-doc

Conversation

@C88-YQ

@C88-YQ C88-YQ commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

🦟 Bug fix

Related to ros-simulation/simulation_interfaces#4

Summary

This PR updates the SpawnEntity service documentation example to match the current simulation_interfaces/srv/SpawnEntity definition.

Previously, the example passed the model path through the top-level uri:

uri: '/path/to/model.sdf'

However, simulation_interfaces/srv/SpawnEntity was updated to replace the old top-level string uri field with Resource entity_resource. As a result, the documented command no longer matches the service interface and fails when copied directly.

Backport Policy

  • This is safe to backport to the following versions:
    • Jetty
    • Ionic
    • Harmonic
    • Fortress
  • This should not be backported
  • I am not sure
  • Other (fill in yourself)

Checklist

  • Signed all commits for DCO
  • Added a screen capture or video to the PR description that demonstrates the fix (as needed)
  • Added tests
  • Updated documentation (as needed)
  • Updated migration guide (as needed)
  • Consider updating Python bindings (if the library has them)
  • codecheck passed (See contributing)
  • All tests passed (See test coverage)
  • Updated Bazel files (if adding new files). Created an issue otherwise.
  • While waiting for a review on your PR, please help review another open pull request to support the maintainers
  • Was GenAI used to generate this PR? If so, make sure to add "Generated-by" to your commits. (See this policy for more info.)

Signed-off-by: C88-YQ <1409947012@qq.com>

@azeey azeey left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks! Can we add this to the Jetty directory as well?

Signed-off-by: C88-YQ <1409947012@qq.com>
@C88-YQ

C88-YQ commented Jun 18, 2026

Copy link
Copy Markdown
Contributor Author

Thanks for the suggestion! I’ve added it to the Jetty directory as well.

@github-project-automation github-project-automation Bot moved this from Inbox to In review in Core development Jun 18, 2026
@azeey azeey enabled auto-merge (squash) June 18, 2026 18:26
@azeey azeey merged commit 3ac8d88 into gazebosim:master Jun 18, 2026
6 checks passed
@github-project-automation github-project-automation Bot moved this from In review to Done in Core development Jun 18, 2026
@C88-YQ C88-YQ deleted the fix-spawn-entity-doc branch June 19, 2026 07:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants