RC OpenAPI (SwaggerUI) - #5086 : Dynamic server URL and missing Scenery3D endpoints #5108
Closed
kutaibaa-akraa
started this conversation in
General
Replies: 1 comment
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
@gzotti @alex-w @10110111
@gzotti Thank you for completing this work with such excellence—I truly appreciate it. This is a significant leap forward for the Remote Control plugin's documentation and usability. However, I have a few observations regarding the current implementation:
I've been testing the OpenAPI/Swagger UI integration from PR #5086 and noticed two issues that may affect its usability in different network configurations.
1. Static server URL in
stelOpenAPI.yamlThe current
stelOpenAPI.yamluses a fixed URL:This works only when Stellarium is running on
localhost:8090. However, when I changed the port (e.g.,8091) or accessed the interface from a different IP address (e.g.,192.168.1.5:8091), the page loaded successfully but all API requests failed with network errors.Simple fix: Use a relative path instead:
This works on any port and any hostname, making the documentation truly portable. I've tested this on both
localhostand remote IP addresses, and it works perfectly.2. Missing Scenery3D endpoints
I also noticed that three endpoints from the Scenery3D plugin are not documented in the OpenAPI specification:
GET /api/scenery3d/listscenePOST /api/scenery3d/loadscene(requires anidparameter)GET /api/scenery3d/scenedescription/(requires anidparameter)These are also missing from the official RemoteControl API documentation and the Scenery3D plugin docs.
Should we add these endpoints for consistency?
Thank you for your work on this feature—it's a valuable addition to the Remote Control plugin.
All reactions