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

Add curl examples to operator-http-api #255

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

nhandler
Copy link

When reading this document, many people will want to test out the
requests against their own environment. Providing curl examples will
help assist with this task.

When reading this document, many people will want to test out the
requests against their own environment. Providing curl examples will
help assist with this task.
@vinodkone
Copy link
Contributor

@nhandler Thanks for doing this! Awesome. Do I take it that you tested all these commands? Also, is the EOF required in all the curl commands?

Copy link
Contributor

@vinodkone vinodkone left a comment

Choose a reason for hiding this comment

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

LGTM!

@greggomann
Copy link
Contributor

greggomann commented Jan 16, 2018

@nhandler similar to Vinod's comment: I think we could probably get away without the heredoc notation, to get rid of the EOFs?

i.e.:

curl -i \
  -X POST http://<masterhost>:5050/api/v1 \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '
{
  "type": "GET_HEALTH"
}'

This works when I test it in bash anyway :)
I think it makes sense to avoid the EOFs in this context since these are documentation as well as examples, it will help reduce noise and make the essential information easier to identify.

@vinodkone
Copy link
Contributor

@nhandler If you can update the PR, I'll commit it ASAP.

@greggomann
Copy link
Contributor

@nhandler we were reviewing PRs today and came across this one - do you have a cycle to update real quick?

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

Successfully merging this pull request may close these issues.

3 participants