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

feat: serve openapi.yaml file as documentation page #73

Merged
merged 10 commits into from
Mar 16, 2022

Conversation

everly-gif
Copy link
Contributor

Description

  • To serve docs from openapi.yaml

Related issue(s)

See #43

This is my first time working with typescript, need suggestions and reviews.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

@everly-gif everly-gif changed the title Serve docs from yaml feat: Serve docs from yaml Mar 11, 2022
Copy link
Member

@BOLT04 BOLT04 left a comment

Choose a reason for hiding this comment

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

Hi @everly-gif, great work 👍. I left a comment about the usage of redoc-express. Let me know what you think.

src/controllers/docs.controller.ts Outdated Show resolved Hide resolved
@everly-gif everly-gif changed the title feat: Serve docs from yaml feat: serve openapi.yaml file as documentation page Mar 14, 2022
Copy link
Member

@BOLT04 BOLT04 left a comment

Choose a reason for hiding this comment

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

Hi @everly-gif, it's awesome that you're working on this, you're doing great 👍.
I tested the PR and we need some changes. Let me know what you think of my comments 👍

src/controllers/docs.controller.ts Outdated Show resolved Hide resolved
src/controllers/docs.controller.ts Outdated Show resolved Hide resolved
src/controllers/docs.controller.ts Outdated Show resolved Hide resolved
@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

Copy link
Member

@BOLT04 BOLT04 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, awesome work @everly-gif 😃

@everly-gif
Copy link
Contributor Author

looks great, awesome work @everly-gif 😃

@BOLT04 @magicmatatjahu Thank you so much for all the help.

@magicmatatjahu
Copy link
Member

/rtm

@asyncapi-bot asyncapi-bot merged commit 0d4a418 into asyncapi:master Mar 16, 2022
@asyncapi-bot
Copy link
Contributor

🎉 This PR is included in version 0.5.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants