Skip to content

fix(openapi): document arrayBuffer bodies #341

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
lxy2500798479 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(openapi): document arrayBuffer bodies #341

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions src/openapi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -936,6 +936,13 @@ export function toOpenAPISchema(
schema: body
}
continue

case 'arrayBuffer':
case 'application/octet-stream':
content['application/octet-stream'] = {
schema: body
}
continue
}
}

Expand Down
33 changes: 33 additions & 0 deletions test/openapi/to-openapi-schema.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,39 @@ describe('OpenAPI > toOpenAPISchema', () => {
})
})

it('handle arrayBuffer request body', () => {
const app = new Elysia().post('/upload', () => 'ok', {
parse: 'arrayBuffer',
body: t.Any({
description: 'Binary file data'
})
})

is(app, {
components: {
schemas: {}
},
paths: {
'/upload': {
post: {
operationId: 'postUpload',
requestBody: {
description: 'Binary file data',
content: {
'application/octet-stream': {
schema: {
description: 'Binary file data'
}
}
},
required: true
}
}
}
}
})
})

it('handle response', () => {
const app = new Elysia().get(
'/user',
Expand Down