Skip to content

add admin-api doc for peer-clusters #918

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

Merged
merlimat merged 3 commits into from
Nov 24, 2017
Merged

add admin-api doc for peer-clusters #918

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
654b669
add admin-api doc for peer-clusters
rdhabalia Nov 23, 2017
1a0d3a1
update latest swagger
rdhabalia Nov 23, 2017
7984dec
update swagger file generation doc
rdhabalia Nov 23, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion site/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ $ make protobuf_doc_gen

### 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:

@merlimat merlimat Nov 23, 2017

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.


```bash
$ make swagger_definition_copy
Expand Down
Loading