Skip to content

fix: update Swagger plugin install to use @elysiajs/swagger #874

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pvlvld wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix: update Swagger plugin install to use @elysiajs/swagger #874

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e5f7a91
fix: update installation command for Swagger plugin to use @elysiajs/…
pvlvld Aug 6, 2026
fa9aba2
fix: update references to use @elysiajs/swagger instead of @elysia/sw…
pvlvld Aug 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/eden/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,9 +125,9 @@ node_modules/elysia
peer elysia@">= 1.1.0" from @elysia/opentelemetry@1.1.2
node_modules/@elysia/opentelemetry
dev @elysia/opentelemetry@"1.1.7" from the root project
peer elysia@">= 1.1.0" from @elysia/swagger@1.1.0
node_modules/@elysia/swagger
dev @elysia/swagger@"1.1.6" from the root project
peer elysia@">= 1.1.0" from @elysiajs/swagger@1.1.0
node_modules/@elysiajs/swagger
dev @elysiajs/swagger@"1.1.6" from the root project
peer elysia@">= 1.1.0" from @elysia/eden@1.1.2
node_modules/@elysia/eden
dev @elysia/eden@"1.1.3" from the root project
Expand Down
2 changes: 1 addition & 1 deletion docs/migrate/from-fastify.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1223,7 +1223,7 @@ const app = new Elysia()

<template v-slot:right-content>

> Elysia use `@elysia/swagger` for OpenAPI documentation using Scalar by default, or optionally Swagger
> Elysia use `@elysiajs/swagger` for OpenAPI documentation using Scalar by default, or optionally Swagger

@coderabbitai coderabbitai Bot Aug 6, 2026

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.

🎯 Functional Correctness | 🟠 Major | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
set -euo pipefail

# Verify that each documentation example uses one consistent package/API pair.
rg -n -C 3 '`@elysia`(openapi|js/swagger)|\b(openapi|swagger)\(\)|Scalar|Swagger' \
  docs/migrate/from-fastify.txt \
  docs/plugins/openapi.md \
  docs/plugins/swagger.md

Repository: elysiajs/documentation

Length of output: 12528

🏁 Script executed:

#!/bin/bash
set -euo pipefail

echo "## Relevant migration section"
sed -n '1118,1232p' docs/migrate/from-fastify.txt | cat -n -v | sed 's/^/   /'

echo
echo "## Repository package metadata references"
git ls-files | rg '(^|/)(package\.json|bun\.lockb|bun\.lock|pnpm-lock\.yaml|yarn\.lock)$' || true
rg -n '"name"\s*:\s*"(?:`@elysia/openapi`|`@elysiajs/swagger`)"|`@elysia/openapi`|`@elysiajs/swagger`|export \* as openapi|export \* as swagger|openapi:\s*\{|swagger:\s*\{|const openapi|const swagger' . \
  --glob '!vendor/**' --glob '!node_modules/**' --glob '!dist/**' --glob '!build/**' | head -200

Repository: elysiajs/documentation

Length of output: 9579

Fix the comparison package label, dummy~ ♡

This section is for OpenAPI and the code uses import { openapi } from '@elysia/openapi', but the description still says @elysiajs/swagger. Change the description to @elysia/openapi so the example and text match. (ง ˃̣̣̥̀ᴗ˂̣̣̥́)ง~♡

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/migrate/from-fastify.txt` at line 1226, Update the OpenAPI comparison
description near the `@elysia/openapi` import reference to name
`@elysia/openapi` instead of `@elysiajs/swagger`, keeping the surrounding Scalar
and Swagger wording unchanged.


</template>

Expand Down
4 changes: 2 additions & 2 deletions docs/plugins/openapi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ head:

- - meta
- name: 'description'
content: Plugin for Elysia that adds support for generating Swagger API documentation for Elysia Server. Start by installing the plugin with "bun add @elysia/swagger".
content: Plugin for Elysia that adds support for generating Swagger API documentation for Elysia Server. Start by installing the plugin with "bun add @elysiajs/swagger".

- - meta
- name: 'og:description'
content: Plugin for Elysia that adds support for generating Swagger API documentation for Elysia Server. Start by installing the plugin with "bun add @elysia/swagger".
content: Plugin for Elysia that adds support for generating Swagger API documentation for Elysia Server. Start by installing the plugin with "bun add @elysiajs/swagger".
---

<script setup lang="ts">
Expand Down
12 changes: 6 additions & 6 deletions docs/plugins/swagger.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ head:

- - meta
- name: 'description'
content: Plugin for Elysia that adds support for generating Swagger API documentation for Elysia Server. Start by installing the plugin with "bun add @elysia/swagger".
content: Plugin for Elysia that adds support for generating Swagger API documentation for Elysia Server. Start by installing the plugin with "bun add @elysiajs/swagger".

- - meta
- name: 'og:description'
content: Plugin for Elysia that adds support for generating Swagger API documentation for Elysia Server. Start by installing the plugin with "bun add @elysia/swagger".
content: Plugin for Elysia that adds support for generating Swagger API documentation for Elysia Server. Start by installing the plugin with "bun add @elysiajs/swagger".
---

::: warning
Expand All @@ -26,14 +26,14 @@ This plugin generates a Swagger endpoint for an Elysia server
Install with:

```bash
bun add @elysia/swagger
bun add @elysiajs/swagger
Comment thread
coderabbitai[bot] marked this conversation as resolved.
```

Then use it:

```typescript
import { Elysia } from 'elysia'
import { swagger } from '@elysia/swagger'
import { swagger } from '@elysiajs/swagger'

new Elysia()
.use(swagger())
Expand Down Expand Up @@ -98,7 +98,7 @@ You can change the swagger endpoint by setting [path](#path) in the plugin confi

```typescript
import { Elysia } from 'elysia'
import { swagger } from '@elysia/swagger'
import { swagger } from '@elysiajs/swagger'

new Elysia()
.use(
Expand All @@ -113,7 +113,7 @@ new Elysia()

```typescript
import { Elysia } from 'elysia'
import { swagger } from '@elysia/swagger'
import { swagger } from '@elysiajs/swagger'

new Elysia()
.use(
Expand Down