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

[documentation] tendrl-api full example is missing #51

Closed
mbukatov opened this issue Dec 20, 2016 · 1 comment
Closed

[documentation] tendrl-api full example is missing #51

mbukatov opened this issue Dec 20, 2016 · 1 comment
Assignees

Comments

@mbukatov
Copy link
Contributor

mbukatov commented Dec 20, 2016

The README file states that:

Running behind apache makes the API available at http://<hostname>:80/api/.

It would be nice if this note would also include a full example of some query of the api, eg.:

$ curl http://<hostname>/api/1.0/Flows

Reasoning

This would be useful for quick check that the tendl-api is up and running.

Moreover at the current state, there is no full example of tendrl-api query documented anywhere and it's not straightforward to connect the dots based on the other documents either.

Documentation of Tenrl API refers to the api calls like this:

GET /cluster/:cluster_id/volume/actions

And Tenrl API overview like this:

curl https://api.example.com/1.0

So to get a full url for the api together, I would need to combine information from 3 files (which belongs to 2 components).

@mbukatov
Copy link
Contributor Author

this is still valid, and I would need to include this in my resurrection of tendrl docs ...

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

No branches or pull requests

4 participants