add admin-api doc for peer-clusters #918
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
merlimat
reviewed
Nov 23, 2017
| ### REST API docs | ||
|
|
||
| The REST API docs are built using a JSON definition generated by Maven's Swagger plugin. This definition is automatically generated when Maven builds Pulsar. In the rare case when you do need to re-generate this JSON definition, run `mvn package` to build all of Pulsar. Then you'll need to copy the new definition into the `site/_data` folder using this command: | ||
| The REST API docs are built using a JSON definition generated by Maven's Swagger plugin. This definition is automatically generated when Maven builds Pulsar. In the rare case when you do need to re-generate this JSON definition, run `mvn package -P swagger` to build all of Pulsar. Then you'll need to copy the new definition into the `site/_data` folder using this command: |
Contributor
There was a problem hiding this comment.
The admin-rest-api-swagger.json should already be generated automatically during the website build. (I think we should remove from git)
I think the issue is that the website build is not passing the -P swagger. I'll fix it now.
merlimat
approved these changes
Nov 24, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Add admin-api doc for peer-clusters introduced in #903