api doc samples include XML

Bug #1311268 reported by aeva black
8
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Ironic
Fix Released
Low
Ruby Loo

Bug Description

Issue
=====

v1 API doc samples include XML:
  http://docs.openstack.org/developer/ironic/webapi/v1.html
however, our API does not support XML.

Suggested fix
===========

API doc should not include XML samples.

aeva black (tenbrae)
Changed in ironic:
status: New → Triaged
importance: Undecided → Low
tags: added: documentation
Changed in ironic:
assignee: nobody → Srinivasa Acharya (rsacharya)
Revision history for this message
Dmitry Tantsur (divius) wrote :

Hi! Per global bugs clean-up, we're unassigning bugs that are without patch and other visible progress for more than 7 days. Please feel free to reassign yourself, set status to In Progress and leave some status comment, if this is wrong. Thank you for understanding!

Changed in ironic:
assignee: Srinivasa Acharya (rsacharya) → nobody
tags: added: low-hanging-fruit
Revision history for this message
Nigel Wright (hertzz) wrote :

In progress - looking at documentation

Changed in ironic:
assignee: nobody → Nigel Wright (hertzz)
status: Triaged → In Progress
Revision history for this message
Nigel Wright (hertzz) wrote :

Documentation in RST format obtained from API code so cant update documentation directly. However XML format in documentation is for an example data sample from a GET request not any kind of POST - so is there actually a need to update this? Pls advise if this bug should be set to invalid.

Revision history for this message
Ruby Loo (rloo) wrote :

Hi Nigel, this bug is valid. The generated docn includes XML samples and it shouldn't. Would you mind if I fixed it? (I just fixed it in my local copy.)

Ruby Loo (rloo)
Changed in ironic:
assignee: Nigel Wright (hertzz) → Ruby Loo (rloo)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to ironic (master)

Fix proposed to branch: master
Review: https://review.openstack.org/119868

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to ironic (master)

Reviewed: https://review.openstack.org/119868
Committed: https://git.openstack.org/cgit/openstack/ironic/commit/?id=3ca54acf91c61a38c63e9a36947aabbb77b1629e
Submitter: Jenkins
Branch: master

commit 3ca54acf91c61a38c63e9a36947aabbb77b1629e
Author: Ruby Loo <email address hidden>
Date: Mon Sep 8 18:40:56 2014 +0000

    Remove XML from api doc samples

    v1 API doc samples include XML:
      http://docs.openstack.org/developer/ironic/webapi/v1.html
    However, the Ironic API does not support XML.

    This removes the XML documentation from the generated docs.

    Change-Id: I0588709190eafa52a252d19a163dc42c36f2e061
    Closes-Bug: #1311268

Changed in ironic:
status: In Progress → Fix Committed
Thierry Carrez (ttx)
Changed in ironic:
milestone: none → juno-rc1
status: Fix Committed → Fix Released
Thierry Carrez (ttx)
Changed in ironic:
milestone: juno-rc1 → 2014.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.