[Web runtime] Add a Swagger UI page for the OpenAPI demo - #1566
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a self-contained Swagger UI viewer and updates documentation to make the rclnodejs-web openapi output immediately usable in the web demo workflow, without introducing new runtime/library dependencies.
Changes:
- Add
demo/web/javascript/swagger-ui.html(and screenshot) to browse a generatedopenapi.jsonvia Swagger UI from a CDN. - Update demo docs (
demo/web/javascript/README.md,index.html) to point users to the Swagger UI page and reduce duplicatedfetch()/EventSourcewalkthrough text. - Update project docs (
README.md,web/README.md) to highlight OpenAPI export and refresh Web-runtime messaging.
Reviewed changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| web/README.md | Documents OpenAPI export and updates the web-runtime tagline accordingly. |
| README.md | Renames the web section and adds a brief OpenAPI export mention; condenses Observable Subscriptions section. |
| demo/web/javascript/web.json | Documents http.host and updates usage notes for running the web CLI from the demo. |
| demo/web/javascript/swagger-ui.html | New Swagger UI page that loads ./openapi.json using CDN-hosted Swagger UI assets. |
| demo/web/javascript/README.md | Adds an “OpenAPI — no server required” walkthrough and trims duplicated HTTP/SSE browser examples. |
| demo/web/javascript/index.html | Adds a footer note linking to the new Swagger UI page. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -1,11 +1,12 @@ | |||
| { | |||
| "$comment": "Sample rclnodejs/web config consumed by `npx -p rclnodejs rclnodejs-web web.json` (the `-p rclnodejs` form works even when rclnodejs isn't already installed in the current project). Every key is optional; the defaults shown match the CLI defaults.", | |||
| "$comment": "Sample rclnodejs/web config consumed by `npx rclnodejs-web web.json` from a project that has rclnodejs installed. Inside a checkout of the rclnodejs repo itself, run `node ../../../bin/rclnodejs-web.js web.json` instead — npx resolves `rclnodejs` against the enclosing package.json, which *is* rclnodejs here, so it finds no bin to run. Every key is optional; the defaults shown match the CLI defaults.", | |||
|
coverage: 91.122% (+0.02%) from 91.103% — minggangw:fix-1564-1 into RobotWebTools:develop |
Closed
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.
Adds a self-contained Swagger UI viewer and updates documentation to make the
rclnodejs-web openapioutput immediately usable in the web demo workflow, without introducing new runtime/library dependencies.Changes:
demo/web/javascript/swagger-ui.html(and screenshot) to browse a generatedopenapi.jsonvia Swagger UI from a CDN.demo/web/javascript/README.md,index.html) to point users to the Swagger UI page and reduce duplicatedfetch()/EventSourcewalkthrough text.README.md,web/README.md) to highlight OpenAPI export and refresh Web-runtime messaging.Fix: #1564