need to document example queries

Bug #1160929 reported by Doug Hellmann
8
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Ceilometer
Fix Released
Medium
Phil Neal
Grizzly
Fix Committed
Medium
Eoghan Glynn

Bug Description

We need to provide examples of using the API and CLI to query for data.

Phil Neal (nealph)
Changed in python-ceilometerclient:
assignee: nobody → Phil Neal (nealph)
Revision history for this message
Phil Neal (nealph) wrote :

Attached is a text file that I've pulled together with the requested examples. I think it would fit well in the API section of the CM documentation (ideally in a "request" then "response" layout), but I don't have permissions to edit.

I think we eventually can leverage it (with a little formatting) into an entry in the overall OpenStack documentation (@ http://api.openstack.org/) but it seems premature right now.

Changed in python-ceilometerclient:
status: New → In Progress
Revision history for this message
Doug Hellmann (doug-hellmann) wrote :

Thanks, Phil, that looks pretty good. We'll see about getting it formatted as reST and checked in.

Revision history for this message
Phil Neal (nealph) wrote :

Glad to do the reST formatting and push this through as a patch under bug/1160929
...just having issues with the doc build process (per my mailing-list post). Any issue with that?

Revision history for this message
Phil Neal (nealph) wrote :

Deleted text file and added rst file.

Revision history for this message
Phil Neal (nealph) wrote :

Patch submitted as draft (assuming there'll be some feedback on content formatting).

https://review.openstack.org/#/c/27437/1

Changed in python-ceilometerclient:
status: In Progress → Fix Committed
Revision history for this message
Doug Hellmann (doug-hellmann) wrote :

Gerrit should handle the bug state transitions automatically.

I went ahead and added some comments, but you'll need to submit the patch not in "draft" mode for it to be officially reviewed and accepted.

Changed in python-ceilometerclient:
status: Fix Committed → In Progress
Revision history for this message
Phil Neal (nealph) wrote :

I mucked up the Gerrit review a bit, but you should see your suggestions in there now, Doug.

Eoghan Glynn (eglynn)
affects: python-ceilometerclient → ceilometer
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to ceilometer (stable/grizzly)

Reviewed: https://review.openstack.org/28161
Committed: http://github.com/openstack/ceilometer/commit/e9198d7226d50d3a15b413e4a7f81a32ab695b39
Submitter: Jenkins
Branch: stable/grizzly

commit e9198d7226d50d3a15b413e4a7f81a32ab695b39
Author: Phil Neal <email address hidden>
Date: Mon Apr 29 12:06:15 2013 -0600

    Adds examples of CLI and API queries to the V2 documentation.

    This patch includes additional reST-formatted text that will add new/expanded examples of v2 API use to the existing documentation.
    Fixes: bug #1160929

    Change-Id: I63fa9dd8b050a63f005c4a5b35399355fdeb7605
    (cherry picked from commit 6979b16e2c5ce84fb04cbb8ea34a55ea77a8abe7)

Revision history for this message
Eoghan Glynn (eglynn) wrote :
Changed in ceilometer:
status: In Progress → Fix Committed
milestone: none → havana-1
importance: Undecided → Medium
Thierry Carrez (ttx)
Changed in ceilometer:
status: Fix Committed → Fix Released
Thierry Carrez (ttx)
Changed in ceilometer:
milestone: havana-1 → 2013.2
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.