Skip to content

Add Swagger UI API page to /docs#239

Merged
jkingsman merged 3 commits into
jkingsman:mainfrom
Bjorkan:API-test
May 14, 2026
Merged

Add Swagger UI API page to /docs#239
jkingsman merged 3 commits into
jkingsman:mainfrom
Bjorkan:API-test

Conversation

@Bjorkan
Copy link
Copy Markdown
Contributor

@Bjorkan Bjorkan commented May 1, 2026

Summary

  • Add a custom /docs Swagger UI page for the RemoteTerm API
  • Improve OpenAPI metadata with richer API description, tag descriptions, and common error response docs
  • Add an “API Docs” button beside “Add Integration” in the MQTT & Automation settings section
  • Proxy /docs and /openapi.json through Vite dev server so the docs work from localhost:5173

Testing

  • ./scripts/quality/all_quality.sh Passed

Screenshots

swagger-01-overview swagger-02-messages-section swagger-03-fanout-endpoint

@jkingsman
Copy link
Copy Markdown
Owner

Love the API and formatting improvements. Thanks! I don't think that having the API docs linked from the integrations area makes a lot of sense, since there's basically nothing in that area where having API knowledge is terribly relevant, but I'm open to making it more clear in availability in either (both?) of the readmes.

@Bjorkan
Copy link
Copy Markdown
Contributor Author

Bjorkan commented May 3, 2026

Love the API and formatting improvements. Thanks! I don't think that having the API docs linked from the integrations area makes a lot of sense, since there's basically nothing in that area where having API knowledge is terribly relevant, but I'm open to making it more clear in availability in either (both?) of the readmes.

Of course! I just whipped something together! It was kinda helpful to me atleast to see the API avaliable 😆

@jkingsman
Copy link
Copy Markdown
Owner

If you remove the link I'd happily merge as is 🙂

@Bjorkan
Copy link
Copy Markdown
Contributor Author

Bjorkan commented May 14, 2026

If you remove the link I'd happily merge as is 🙂

Will check that tomorrow!

@Bjorkan Bjorkan marked this pull request as ready for review May 14, 2026 08:30
@Bjorkan Bjorkan changed the title WIP: Add Swagger UI API page to Automation Add Swagger UI API page to /docs May 14, 2026
@jkingsman jkingsman merged commit 9b67512 into jkingsman:main May 14, 2026
5 checks passed
@jkingsman
Copy link
Copy Markdown
Owner

Thanks for the PR! ♥

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants