Skip to content

docs: hide non-functional "Try it out" button from API reference#39

Merged
xsmyile merged 1 commit into
masterfrom
docs/hide-api-try-it-button
Jun 16, 2026
Merged

docs: hide non-functional "Try it out" button from API reference#39
xsmyile merged 1 commit into
masterfrom
docs/hide-api-try-it-button

Conversation

@xsmyile

@xsmyile xsmyile commented Jun 16, 2026

Copy link
Copy Markdown
Member

The API reference showed an interactive "Try it out" playground that can never work: its requests target the OpenAPI servers URL (http://localhost:8025), which is mixed-content blocked from the hosted HTTPS docs and CORS-blocked even when run locally (RustMail sends no CORS headers). The existing showTryButton: false had no effect — it's not a valid config key in vitepress-openapi@0.1.19. Replaced it with operation.hiddenSlots: ['playground']. Verified by rebuilding the docs: zero "Try it out" occurrences remain across the API pages.

The prior showTryButton key is not valid in vitepress-openapi 0.1.19
so it was ignored. The playground targets localhost:8025, which is
mixed-content blocked from the hosted docs and CORS-blocked locally.
@xsmyile xsmyile merged commit 00f8f62 into master Jun 16, 2026
2 checks passed
@xsmyile xsmyile deleted the docs/hide-api-try-it-button branch June 16, 2026 11:19
@xsmyile xsmyile mentioned this pull request Jun 16, 2026
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.

1 participant