api-site - Sync WADL files between API ref site and OpenStack Object Storage API v1 Reference

Bug #1187119 reported by Diane Fleming on 2013-06-03
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
openstack-api-site
High
Diane Fleming
openstack-manuals
High
Diane Fleming

Bug Description

Currently, the api-site (API Reference page) uses WADLs to generate output. However, the API references (the specs) do not consistently use WADL files. I plan to update the API references (specs) to use the same WADL files used in the api site. This bug is for Object Storage API v1.

affects: openstack-manuals → openstack-api-site
Changed in openstack-api-site:
importance: Undecided → High
assignee: nobody → Diane Fleming (diane-fleming)
milestone: none → havana
status: New → Confirmed
Changed in openstack-api-site:
milestone: havana → icehouse
summary: - api-site - Synchronize use of WADL files between the API ref site and
- the API References (specs)
+ api-site - Sync WADL files between API ref site and OpenStack Object
+ Storage API v1 Reference
description: updated
Changed in openstack-api-site:
status: Confirmed → In Progress
Tom Fifield (fifieldt) on 2013-12-17
no longer affects: openstack-manuals

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

commit bbc3f01a31526cbc14bf6f6b2932b4ae2bac12cd
Author: Diane Fleming <email address hidden>
Date: Tue Dec 31 13:27:25 2013 -0600

    Update object-api WADL with information from book version of API

    Partial-Bug: #1187119

    Change-Id: I357f01a008e11414d6124e16dcc94ba0daf9496e
    author: diane fleming

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

commit b1fe44c73393283e8c4b04a78c4bc508695650f1
Author: Diane Fleming <email address hidden>
Date: Tue Dec 31 14:00:26 2013 -0600

    Update object-api wadl to use it in book version for the api

    Partial-Bug: #1187119

    Change-Id: Ib7a9781abec89f72c62445c8ae4f22e9890e41a0
    author: diane fleming

Changed in openstack-manuals:
status: New → In Progress
importance: Undecided → High
assignee: nobody → Diane Fleming (diane-fleming)
milestone: none → icehouse

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

commit 8ae1e64b40388ee08a3309b622098c151b13277e
Author: Diane Fleming <email address hidden>
Date: Thu Jan 2 12:17:52 2014 -0600

    Fix object-api wadl for use in the dev guide

    Partial-Bug: #1187119

    Change-Id: I8feeb1dbc6ed9a25be1fc42cbfc79af2ab29bbcd
    author: diane fleming

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

commit 9d568fd03083e11a164db17d0358f03112cfa519
Author: Diane Fleming <email address hidden>
Date: Thu Jan 2 12:23:37 2014 -0600

    Fix object-api wadl

    Partial-Bug: #1187119

    Change-Id: Ic979d39b2aaa9fb34037d03af4668a9decc7ae57
    author: diane fleming

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

commit d997cbfa2f1be5e252edfb229bb8a7a2aef82ec0
Author: Diane Fleming <email address hidden>
Date: Thu Jan 2 15:35:15 2014 -0600

    fix object-api wadl to use in dev guide

    Partial-Bug: #1187119

    Change-Id: I61285a4e1525a1bd0b664aaf4a8a8d8e1dd1e461
    author: diane fleming

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

commit 0cdb02b15016fb17ed56761059e284c3415a819f
Author: Diane Fleming <email address hidden>
Date: Thu Jan 2 16:31:04 2014 -0600

    fix object-api wadl

    Partial-Bug: #1187119

    Change-Id: I6329596aeb30e9b24aaaaf79c35b8c0f67d01069
    author: diane fleming

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

commit 3da3bfd65f7b6617181e827f4ae8b78eb5800bee
Author: Diane Fleming <email address hidden>
Date: Tue Jan 7 15:43:06 2014 -0600

    Update object-api wadl for completeness and accuracy

    The point of this change is to ensure that
    these two docs are in sync and are complete with regards
    to the descriptions of each method and their request
    and response parameters:
    http://api.openstack.org/api-ref-objectstorage.html
      (API Reference page for Object Storage)
    http://docs.openstack.org/api/openstack-object-storage/1.0/content/
      (API Reference (or spec) for Object Storage)
    In addition, the current documents don’t describe ACLs, FormPOST, TempURLs,
    StaticWeb, Bulk Upload, Bulk Delete, the OPTIONS operation
    (though this is implicit in CORS support) and maybe a couple of other things.
    These items should be part of the https://review.openstack.org/#/c/64579/
    review, which I'm still working on.
    updated to add {name} for variables in metadata

    Co-Author: Donagh McCabe

    Partial-Bug: #1187119
    Partial-Bug: #1214139

    Change-Id: I82331b1c3cfc5b19f91f7ac1379476e6a9e6806d
    author: diane fleming

Reviewed: https://review.openstack.org/64579
Committed: https://git.openstack.org/cgit/openstack/object-api/commit/?id=ed4f3c4db9ba6b597d12925279c47868998238de
Submitter: Jenkins
Branch: master

commit ed4f3c4db9ba6b597d12925279c47868998238de
Author: Diane Fleming <email address hidden>
Date: Tue Dec 31 14:05:11 2013 -0600

    Update Object Storage API Reference

    Point to WADL files that generate the API Reference
      page so that the method descriptions and request
      and response parameters are consistent between
      these two docs:
        http://api.openstack.org/api-ref-objectstorage.html
          (API Reference page for Object Storage)
        http://docs.openstack.org/api/openstack-object-storage/1.0/
          (API Reference (or spec) for Object Storage)

    Add descriptions of ACLs, FormPOST, TempURLs,
      StaticWeb, Bulk Upload, Bulk Delete, the OPTIONS operation
      (though this is implicit in CORS support)

    Validate all code examples

    Remove duplication.

    Co-Author: Donagh McCabe

    Closes-Bug: #1187119
    Closes-Bug: #1214139
    Closes-Bug: #1074198
    Partial-Bug: #1255770

    Change-Id: I94054b046a94260ba8825bdb42439adfcaf9fdce
    author: diane fleming

Changed in openstack-api-site:
status: In Progress → Fix Committed
Changed in openstack-manuals:
status: In Progress → Fix Committed
Changed in openstack-api-site:
status: Fix Committed → Fix Released
Changed in openstack-manuals:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers

Related blueprints