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

Document HTTP API v1. #135

Merged
merged 1 commit into from
Jul 8, 2015
Merged

Document HTTP API v1. #135

merged 1 commit into from
Jul 8, 2015

Conversation

juliusv
Copy link
Member

@juliusv juliusv commented Jul 1, 2015

No description provided.

@juliusv
Copy link
Member Author

juliusv commented Jul 1, 2015

@fabxc

The one thing I want to change before merging is the location of this document in the menu structure. I haven't found a good place for it yet. Maybe rename one of the sections to make it fit in better? Like the Visualization section?


The current stable HTTP API is reachable under `/api/v1` on a Prometheus
server. Any non-breaking additions will be added under that endpoint. There are
no minor versions of the API.
Copy link
Contributor

Choose a reason for hiding this comment

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

This was more for the design doc. I don't think we have to document what we not have.

Copy link
Member Author

Choose a reason for hiding this comment

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

Removed the last sentence.

@juliusv juliusv force-pushed the http-api-docs branch 2 times, most recently from 65078b2 to 3c6580a Compare July 2, 2015 13:56
@juliusv
Copy link
Member Author

juliusv commented Jul 2, 2015

I've updated the "Query language" menu section to just "Querying" now, so that the "HTTP API" section fits in better. Also, linked to it from the beginning of the "Basics" section. It's still not perfect, as the API has one endpoint so far that isn't strictly "querying" (the series deletion), but probably the best we can do for without major restructuring of the menus.

@fabxc
Copy link
Contributor

fabxc commented Jul 2, 2015

Yes, that will work. 👍

@juliusv
Copy link
Member Author

juliusv commented Jul 2, 2015

Before merging this, we need to fix the vector output format to have the same timestamp/value representation as the matrix one.

I already changed this PR to reflect the anticipated change now.

[
{
"metric": { "<label_name>": "<label_value>", ... },
"timestamp": <unix_time>,
Copy link
Contributor

Choose a reason for hiding this comment

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

To be removed.

Copy link
Member Author

Choose a reason for hiding this comment

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

Ah right, done.

@juliusv
Copy link
Member Author

juliusv commented Jul 2, 2015

@fabxc Hmm, now it would be most consistent to also bundle up the timestamp with the value for scalar and string return types.

@fabxc
Copy link
Contributor

fabxc commented Jul 2, 2015

Yes, I've thought about that - would be 👍 on this. Even though it requires more back porting for the legacy API.

@fabxc
Copy link
Contributor

fabxc commented Jul 6, 2015

[<timestamp>, <value>] is in Prometheus master for all types.

@juliusv
Copy link
Member Author

juliusv commented Jul 7, 2015

Updated to match prometheus/prometheus#872. Should be good to merge now.

@fabxc
Copy link
Contributor

fabxc commented Jul 8, 2015

Yes 👍

juliusv added a commit that referenced this pull request Jul 8, 2015
@juliusv juliusv merged commit e12b8c5 into master Jul 8, 2015
@juliusv juliusv deleted the http-api-docs branch July 8, 2015 05:19
aylei pushed a commit to aylei/docs that referenced this pull request Oct 28, 2019
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.

2 participants