Collection of Compute v2.1 API doc bugs

[Anne Gentle]

from https://etherpad.openstack.org/p/nova-v2.1-api-doc

API docs have a problem:
config_drive.py (alex: we should get rid of extension, there is one section describe this extension http://developer.openstack.org/api-ref-compute-v2.1.html#os-config-drive-v2.1)
create_backup.py (alex: there are two section for same apihttp://developer.openstack.org/api-ref-compute-v2.1.html#os-create-backup-v2.1 http://developer.openstack.org/api-ref-compute-v2.1.html#backupserver)
extended_availability_zone.py (alex: remove this http://developer.openstack.org/api-ref-compute-v2.1.html#os-extended-availability-zone-v2.1)
extended_server_attributes.py (alex: remove this http://developer.openstack.org/api-ref-compute-v2.1.html#os-extended-server-attributes-v2.1)
extended_status.py (alex: remove this http://developer.openstack.org/api-ref-compute-v2.1.html#os-extended-status-v2.1)
extended_volumes.py (alex: remove this http://developer.openstack.org/api-ref-compute-v2.1.html#os-extended-volumes-v2.1 this should part of servers) (alex: we didn't attach action anymore http://developer.openstack.org/api-ref-compute-v2.1.html#attachVolume)
flavor_rxtx.py (alex: remove, merge into flavor http://developer.openstack.org/api-ref-compute-v2.1.html#os-flavor-rxtx-v2.1)
flavors.py (alex: just call this as flavor section? http://developer.openstack.org/api-ref-compute-v2.1.html#os-flavors-v2.1
rescue.py (alex: missing unrescue http://developer.openstack.org/api-ref-compute-v2.1.html#rescue)
servers.py (alex: http://developer.openstack.org/api-ref-compute-v2.1.html#os-server-usage-v2.1 we should call this as server section? I didn't find out any other section called as servers. As we will get rid of extension, the response should include all the extend attributes.)

Compute API v2.1 missing doc
assisted_volume_snapshots.py
attach_interfaces.py
baremetal_nodes.py
block_device_mapping.py
block_device_mapping_v1.py
cloudpipe.py
consoles.py
console_auth_tokens.py
mage_metadata.py
image_size.py (alex: this should merge into images)
images.py
networks_associate.py
extension_info.py
fixed_ips.py
security_group_default_rules.py
scheduler_hints.py
server_external_events.pya
server_metadata.py
simple_tenant_usage.py
volumes.py
hide_server_addresses.py
preserve_ephemeral_rebuild.py

[Atsushi SAKAI (sakaia)]

Let me clearify the meaning.

Your meaning is extension should be unified? or another plan?

[OpenStack Infra (hudson-openstack)]

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

[Atsushi SAKAI (sakaia)]

I cannot understand following points.
It would be appreciated, that suggest me a practical expection

1)config_drive.py (alex: we should get rid of extension, there is one section describe this extension http://developer.openstack.org/api-ref-compute-v2.1.html#os-config-drive-v2.1)

2)(alex: we didn't attach action anymore http://developer.openstack.org/api-ref-compute-v2.1.html#attachVolume)

3)flavors.py (alex: just call this as flavor section? http://developer.openstack.org/api-ref-compute-v2.1.html#os-flavors-v2.1

4)servers.py (alex: http://developer.openstack.org/api-ref-compute-v2.1.html#os-server-usage-v2.1 we should call this as server section? I didn't find out any other section called as servers. As we will get rid of extension, the response should include all the extend attributes.)

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/220412
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=46436afdf3a458bf561e88e6d87e4f451ab30ab7
Submitter: Jenkins
Branch: master

commit 46436afdf3a458bf561e88e6d87e4f451ab30ab7
Author: Atsushi SAKAI <email address hidden>
Date: Fri Sep 4 14:33:07 2015 +0900

    Compute v2.1 docs clean up

      Remove create_backup (duplication)
      Remove extended-availability-zone (legacy v2 only)
      Remove extended-server-attributes (legacy v2 only)
      Remove extended-status (legacy v2 only)
      Remove extended-volume (legacy v2 only)

    Partial-Bug: #1488144
    Change-Id: Ib63637d5eb8dab32d1def25db985c085427f6a0c

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/220457
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=4d3e8fdb4e8171f7bf0ed670fc39d815d983cd70
Submitter: Jenkins
Branch: master

commit 4d3e8fdb4e8171f7bf0ed670fc39d815d983cd70
Author: Atsushi SAKAI <email address hidden>
Date: Fri Sep 4 19:28:57 2015 +0900

    Compute v2.1 docs clean up (part2)

      Merge flavor_rxtx into flavor

    Partial-Bug: #1488144
    Change-Id: Ibf54618b5f35c71542a1e74dbb1e5941e7b9165a

[OpenStack Infra (hudson-openstack)]

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

[Atsushi SAKAI (sakaia)]

preserve_ephemeral_rebuild.py is already documented.

  Update server start and stop with 204 return code
  Also, added missing server actions.
  Change-Id: I5723943a07772186116c306ba65fc9a6008e73db
  Closes-Bug: #1197415
  https://github.com/openstack/api-site/commit/b14680f9030810d809b4a9250ec260309b6fa59a

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/220975
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=43b4ac32b4c8374b1993fd58404475be785bed9e
Submitter: Jenkins
Branch: master

commit 43b4ac32b4c8374b1993fd58404475be785bed9e
Author: Atsushi SAKAI <email address hidden>
Date: Mon Sep 7 21:24:34 2015 +0900

    Compute v2.1 docs clean up (part 4) (scheduler_hints)

    Add scheduler_hints description
      it is based on not linked wadl file in v2.1.

    (df) Fixed an error in v2 code sample and
    patched with some edits

    Change-Id: I8955392760415a93f62efa19786a3b87a5a38413
    Partial-Bug: #1488144

[OpenStack Infra (hudson-openstack)]

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

[Atsushi SAKAI (sakaia)]

server_metadata.py is already included
http://developer.openstack.org/api-ref-compute-v2.1.html#server-metadata-v2.1

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/221295
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=3d1159187df9c38d2cd8746b0a3887a6f01edd84
Submitter: Jenkins
Branch: master

commit 3d1159187df9c38d2cd8746b0a3887a6f01edd84
Author: Atsushi SAKAI <email address hidden>
Date: Tue Sep 8 21:14:49 2015 +0900

    Compute v2.1 docs clean up (part 6) (not linked wadl)

    Add extensions and os-simple-tenant-usage
      it is based on not linked wadl file in v2.1

    Partial-Bug: #1488144

    Change-Id: Ie85acd47678f7e639528e8556fc53bde0c01a48a

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/221135
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=e991560405194cdb9dac8e773e8bcfcf6f6863d0
Submitter: Jenkins
Branch: master

commit e991560405194cdb9dac8e773e8bcfcf6f6863d0
Author: Atsushi SAKAI <email address hidden>
Date: Tue Sep 8 10:40:23 2015 +0900

    Compute v2.1 docs clean up (part 5) (cloudpipe)

    Add cloudpipe description
      it is based on v2 ext.
        Changes are
          remove xml file
          parameter's "Style" query=>plain
                               header=>plain

    Change-Id: Icf1863429c03c769dd87edb5fe2c2a97a21ee3ad
    Partial-Bug: #1488144

[Atsushi SAKAI (sakaia)]

server_metadata.py is already included
http://developer.openstack.org/api-ref-compute-v2.1.html#server-metadata-v2.1

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/220867
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=b767f3fabc647e32841df1b470d05d816ef417e4
Submitter: Jenkins
Branch: master

commit b767f3fabc647e32841df1b470d05d816ef417e4
Author: Atsushi SAKAI <email address hidden>
Date: Mon Sep 7 10:58:19 2015 +0900

    Compute v2.1 docs clean up (part 3) (baremetal-nodes)

    Add baremetal-nodes based on v2-ext
      with changes API path from v2.0 to v2.1
      and adding
       delete /v2.1/{tenant_id}/servers/{server_id}/os-baremetal-nodes/{node_id}

    Change-Id: I72412b3df321c3b82451e50a9f26955c5b64517a
    Partial-Bug: #1488144

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/221572
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=436b173dffc8da1bd7794a8a6e32f88483352f28
Submitter: Jenkins
Branch: master

commit 436b173dffc8da1bd7794a8a6e32f88483352f28
Author: Atsushi SAKAI <email address hidden>
Date: Wed Sep 9 11:12:10 2015 +0900

    Compute v2.1 docs clean up (part 7) (security_group_default_rules)

    Add os-security-group-default-rules
      it is based on v2 ext file.
        changes are #1 remove xml file, #2 change /v2 => /v2.1
        JSON samples are not edited/changed.

      Also ordering is alphabetical
        os-security-groups
        os-security-group-default-rules <= added
        os-security-group-rules

    Change-Id: I4c06148fe45b32f1aa936bba14d71cd6328fe439
    Partial-Bug: #1488144

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[Atsushi SAKAI (sakaia)]

networks_associate.py is already included
http://developer.openstack.org/api-ref-compute-v2.1.html#AssociateHost

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/221580
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=465329e69cd37c8dd174bb6fa4e7071a65ec073b
Submitter: Jenkins
Branch: master

commit 465329e69cd37c8dd174bb6fa4e7071a65ec073b
Author: Atsushi SAKAI <email address hidden>
Date: Wed Sep 9 11:50:16 2015 +0900

    Compute v2.1 docs clean up (part 8) (fixed_ips)

    Add os-fixed-ips
      it is based on v2 ext file
        Changes are #1 remove link to xml sample file
                    #2 change /v2 => /v2.1
        JSON samples are not edited/changed.

    Change-Id: I8da2147514bc4940532953951f3310dc6ba0fef7
    Partial-Bug: #1488144

[Atsushi SAKAI (sakaia)]

The following file name should be modified to image_metadata.py
mage_metadata.py

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Change abandoned by Atsushi SAKAI (<email address hidden>) on branch: master
Review: https://review.openstack.org/222454
Reason: I attached wrong tag.

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/222193
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=5d83d1132e1c718faf50dc52ec2af7d42f02335f
Submitter: Jenkins
Branch: master

commit 5d83d1132e1c718faf50dc52ec2af7d42f02335f
Author: Atsushi SAKAI <email address hidden>
Date: Thu Sep 10 22:33:29 2015 +0900

    Compute v2.1 docs clean up (part11) (os-server-external-events)

    Add os-server-external-events
       WADL file is created.
       JSON files are not linked file.

    To write this document, I am refering following document.
       https://wiki.openstack.org/wiki/Nova/ExternalEventAPI

    Change-Id: I2fd9b568bfad1f889f78f6c705dab12596dfb7dd
    Partial-Bug: #1488144

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/223078
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=0b61d4e89e2a0d5395fb32ab12c5949cb5f41553
Submitter: Jenkins
Branch: master

commit 0b61d4e89e2a0d5395fb32ab12c5949cb5f41553
Author: Atsushi SAKAI <email address hidden>
Date: Fri Sep 11 19:57:15 2015 +0900

    Compute v2.1 docs clean up (part13) (images related)

    Add images/image-metadata/image-size
       WADL file is based on v2 (os-compute-2.wadl)
          with subtract many items with keeping images/image-metadata
          and adds image-size
       JSON sample files are not linked one
          but add image-size info

    P.S.
      Previously,
      images/image-metadata exists on v2.
      image-size exists on v2-ext.

    Change-Id: Ia4bd4304c11ebd7134b92c3d68e07dcde9aa4cff
    Partial-Bug: #1488144

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/222462
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=130016fecb6ce95dad678c505e43685a0ca4a39e
Submitter: Jenkins
Branch: master

commit 130016fecb6ce95dad678c505e43685a0ca4a39e
Author: Atsushi SAKAI <email address hidden>
Date: Fri Sep 11 14:02:31 2015 +0900

    Compute v2.1 docs clean up (part12) (os-attach-interfaces)

       Add os-attach-interfaces
          WADL file is based on v2 ext (os-interface)
          JSON files are not linked one (i.e no move operation)

       Fix response code 202 => 200
          POST /v2.1/{tenant_id}/servers/{server_id}/os-attach-interfaces
          GET /v2.1/{tenant_id}/servers/{server_id}/os-attach-interfaces/{attachment_id}

    Change-Id: I780fb378a8cc12a06ccaf62ddafd98f968d59195
    Partial-Bug: #1488144

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/218110
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=50983b3d5979a581343a0bcb3b58fc83d4a88260
Submitter: Jenkins
Branch: master

commit 50983b3d5979a581343a0bcb3b58fc83d4a88260
Author: daz <email address hidden>
Date: Fri Aug 28 16:06:06 2015 +1000

    Remove duplicated Compute API v2.1 server requests

    Removed Servers extended volumes section that is documented in the Servers usage (servers) section

    Change-Id: If7265aa6c0effd8e0d3498429a47b9edb7085614
    Partial-Bug: #1488144

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/222087
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=8dd4cee07fda31dfa57efe1a9a15906ca8f2579e
Submitter: Jenkins
Branch: master

commit 8dd4cee07fda31dfa57efe1a9a15906ca8f2579e
Author: Atsushi SAKAI <email address hidden>
Date: Thu Sep 10 18:16:44 2015 +0900

    Compute v2.1 docs clean up (part10) (os-volumes, os-snapshots)

    Add os-volumes, os-snapshots
      this file (WADL, JSON) is based on v2 ext files.
         Changes /v2 => /v2.1
                   Remove xml sample, keep JSON sample only

    p.s.
      os-snapshots are not listed in launchpad bug report.

    Change-Id: Ic28261a226d0f2765d811507443e762cf0233379
    Partial-Bug: #1488144

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/222047
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=20ff24c365528d2bda055e0abf067ca16fe33057
Submitter: Jenkins
Branch: master

commit 20ff24c365528d2bda055e0abf067ca16fe33057
Author: Atsushi SAKAI <email address hidden>
Date: Thu Sep 10 13:01:59 2015 +0900

    Compute v2.1 docs clean up (part 9) (os-assisted-volume-snapshots)

    Add os-assisted-volume-snapshots
      WADL file is created.
      JSON samples are not linked previously.

    Change-Id: I0d052563acfbb388fd2e7080825cc80daa272437
    Partial-Bug: #1488144

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/224712
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=5fa0cdfcc93692bf8dc45f212739356a2c49d65b
Submitter: Jenkins
Branch: master

commit 5fa0cdfcc93692bf8dc45f212739356a2c49d65b
Author: Atsushi SAKAI <email address hidden>
Date: Wed Sep 16 22:21:49 2015 +0900

    Compute v2.1 docs clean up (part14)(os-consoles, os-console-auth-token)

      WADL file is newly created.
      JSON files are not linked one.

    Partial-Bug: #1488144

    Change-Id: Ifecfadf57dc365a6335af7069ee2e72eb87d9253

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/224969
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=6dd32c6c92e3734c44fa39533eadabb148319062
Submitter: Jenkins
Branch: master

commit 6dd32c6c92e3734c44fa39533eadabb148319062
Author: Atsushi SAKAI <email address hidden>
Date: Fri Sep 18 09:59:57 2015 +0900

    Compute v2.1 docs clean up (part15) (os-block-device-mapping)

      WADL file and JSON files are from v2 ext.
        Removes listServers
           (since it does not exist on
           nova/nova/api/openstack/compute/block_device_mapping.py)
        Adds block-device-mapping-v1
        URL path is changed from /v2 to /v2.1
        Keep JSON sample files only (XML sample files are not included)

    P.S.
      All attributes of block-device mapping is in
        https://github.com/openstack/nova/blob/stable/kilo/nova/block_device.py
      (Both version)

    Change-Id: I5aa201102aabd4b7581002f6eccca0b67e070fcb
    Partial-Bug: #1488144

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/216056
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=7ab1c7669ca96c5bd3ac002e2488ca5f68d9b2ed
Submitter: Jenkins
Branch: master

commit 7ab1c7669ca96c5bd3ac002e2488ca5f68d9b2ed
Author: Diane Fleming <email address hidden>
Date: Sun Aug 23 17:17:44 2015 -0500

    Update rescue and unrescue operations

    Change-Id: I1f4e1bb105e6c6eb440e510276848369efdb9f33
    Closes-Bug: #1204356
    Partial-Bug: #1488144

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/227672
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=2c8cf8ea56f73bbf7e5148a1b045c5810066a83e
Submitter: Jenkins
Branch: master

commit 2c8cf8ea56f73bbf7e5148a1b045c5810066a83e
Author: Atsushi SAKAI <email address hidden>
Date: Fri Sep 25 14:29:54 2015 +0900

    Compute v2.1 docs clean up (part16) (os-hide-server-addresses)

      WADL file is a server usage one (just add description)
      JSON files are not changed.

      In my understanding, #1488144 is closed by this ticket.

    Change-Id: I087192a4c19f3752c3ee80d6bc3fe7fce90b606e
    Closes-Bug: #1488144