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.

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

Jump to bottom

Serve docs from the server #435

Merged
merged 7 commits into from
May 11, 2022
Merged

Serve docs from the server #435

merged 7 commits into from
May 11, 2022

Conversation

svix-dylan
Copy link
Contributor

Includes our OpenAPI documentation as static files, and serves them
from the Rust server.

@svix-dylan
Copy link
Contributor Author

Open to suggestions on where these files and this module should live. I thought about putting them in the /endpoints/v1 folder, but since they're available at /docs I don't feel great putting them in a directory that represents a nested path.

@svix-dylan svix-dylan requested a review from a team May 11, 2022 20:30
tasn
tasn reviewed May 11, 2022
View reviewed changes
Copy link
Member

@tasn tasn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, just a few tiny comments.

server/svix-server/src/lib.rs Outdated Show resolved Hide resolved
server/svix-server/src/lib.rs Show resolved Hide resolved
server/svix-server/src/lib.rs Outdated Show resolved Hide resolved
server/svix-server/src/static/docs.html Outdated Show resolved Hide resolved
server/svix-server/src/lib.rs Show resolved Hide resolved
svix-dylan and others added 2 commits May 11, 2022 17:52
@svix-dylan @tasn
Update server/svix-server/src/lib.rs
06f238a 
Co-authored-by: Tom Hacohen <tasn@users.noreply.github.com>
@svix-dylan
redirect / to /docs
58ad6e3
tasn
tasn reviewed May 11, 2022
View reviewed changes
server/svix-server/src/lib.rs Outdated Show resolved Hide resolved
@svix-dylan @tasn
Update server/svix-server/src/static/docs.html
1771910 
Co-authored-by: Tom Hacohen <tasn@users.noreply.github.com>
tasn
tasn approved these changes May 11, 2022
View reviewed changes
server/svix-server/src/lib.rs Show resolved Hide resolved
@svix-dylan svix-dylan merged commit 84e7e28 into svix:main May 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tasn tasn tasn approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@svix-dylan @tasn