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

The REST API responses are completely undocumented #941

Open
efeg opened this issue Sep 13, 2019 · 0 comments
Open

The REST API responses are completely undocumented #941

efeg opened this issue Sep 13, 2019 · 0 comments
Labels
usability Improves the ease of use or learnability of the system.

Comments

@efeg
Copy link
Collaborator

efeg commented Sep 13, 2019

Thanks Justin Kaufman for reporting this!

The REST API documentation is available on cruise-control’s GitHub page here. While it does effectively list endpoints, methods, and query parameters, it omits any mention of what the response will be.

Other open-sourced LinkedIn projects do not have this problem: as examples, consider Burrow or Brooklin.
@efeg efeg added the usability Improves the ease of use or learnability of the system. label Sep 13, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
usability Improves the ease of use or learnability of the system.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@efeg