Skip to content
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.

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

Add openapi query & response specifications to WebSoc schemas #79

Open
andrew-wang0 opened this issue Jan 13, 2025 · 2 comments
Open

Add openapi query & response specifications to WebSoc schemas #79

andrew-wang0 opened this issue Jan 13, 2025 · 2 comments
Assignees
Labels
good first task Good for newcomers

Comments

@andrew-wang0
Copy link
Member

Expected Behavior

Query and response schemas in /apps/api/src/schema/websoc.ts should have descriptions and examples.

Example of query and response parameters with descriptive metadata:
image
image

Current Behavior

Query and response schemas lack openapi specifications

Possible Solution

Add .openapi(...) to schemas
See openapi implementation in /apps/api/src/schema/larc.ts

@andrew-wang0 andrew-wang0 added the good first task Good for newcomers label Jan 13, 2025
@andrew-wang0 andrew-wang0 changed the title Add openapi query & response specificatinos to WebSoc schemas Add openapi query & response specifications to WebSoc schemas Jan 13, 2025
@vinnyho
Copy link

vinnyho commented Jan 14, 2025

Hello, could I take this?

@andrew-wang0
Copy link
Member Author

@vinnyho missed your message somehow! Yes, you can take this on.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first task Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants