swagger, Path Item Objects vendor extension, copy operation

Bug #1535139 reported by Karen Bradshaw
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
openstackdocstheme
Fix Released
Medium
Karen Bradshaw

Bug Description

The object storage service has an operation, 'copy'. This needs to be listed as a vendor extension in order to create valid
swagger. The name of the accepted Path Item Objects are: get, post, patch, head, delete, put ...
See generated file, objectstorage-v1-swagger.json, operation /v1/{account}/{container}/{object}.
To fix, the migration tool could check whether the operation name is one of the accepted operation names. Prefix the operation with x-, such as x-copy. Another possibility is to simply update the swagger file for this one operation, post-migration.

description: updated
Revision history for this message
Anne Gentle (annegentle) wrote :

I think it's good to make x-copy the vendor extension for this API.

Changed in openstack-doc-tools:
status: New → Confirmed
importance: Undecided → Medium
Changed in openstack-doc-tools:
assignee: nobody → Karen Bradshaw (kbhawkey)
Changed in openstack-doc-tools:
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to fairy-slipper (master)

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

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

Reviewed: https://review.openstack.org/280890
Committed: https://git.openstack.org/cgit/openstack/fairy-slipper/commit/?id=a364fc3b1bb01cc13135fe145af52740f12a37c8
Submitter: Jenkins
Branch: master

commit a364fc3b1bb01cc13135fe145af52740f12a37c8
Author: Karen Bradshaw <email address hidden>
Date: Tue Feb 16 14:11:00 2016 -0500

    Update method names with x- prefix

    -Provides extension field for non standard
     operations such as COPY.
    -Makes action methods unique by re-naming
     to x-<method_name>-<operationId>.
    -Updates basic tests for wadl2swaggervalid and adds
     test for extension operation field.
    -Updates swagger_to_rst to publish standard
     method names (get, post ...) to rst files.

    Change-Id: Ifb7a975797b392b1431cc9ee742898bce8f89313
    Closes-Bug: #1535139
    Closes-Bug: #1534715

Changed in openstack-doc-tools:
status: In Progress → Fix Released
Revision history for this message
Doug Hellmann (doug-hellmann) wrote : Fix included in openstack/fairy-slipper 0.2.0

This issue was fixed in the openstack/fairy-slipper 0.2.0 release.

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.