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
[website] Render Pulsar REST API in ReDoc and Fix endpoint template #2274
Conversation
### Motivation [ReDoc](https://github.com/Rebilly/ReDoc) provides a good mechanism to load OpenAPI/Swagger-generated API reference documentation. ### Changes - Use ReDoc to load the pulsar swagger definition - Fix the rest admin api references and `endpoint` macros
@cckellogg ^^ |
mvn -am -pl pulsar-broker install -DskipTests -Pswagger | ||
echo "Swagger json file is generated." | ||
|
||
cp pulsar-broker/target/docs/swagger.json site2/website/static/swagger/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
will this file be auto generated when we build the site or will we build it and check it in?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes. it will be auto generated when we build the site. I am adding this script here but it will be called in the CI build.
site2/website/package.json
Outdated
@@ -20,5 +20,8 @@ | |||
}, | |||
"jest": { | |||
"preset": "jest-puppeteer" | |||
}, | |||
"dependencies": { | |||
"redoc": "^2.0.0-alpha.30" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can this be moved to devDependencies since the site is statically generated.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah moved
rerun cpp tests |
1 similar comment
rerun cpp tests |
Motivation
ReDoc provides a good mechanism to load OpenAPI/Swagger-generated API reference documentation.
Changes
endpoint
macros