In the api ref most of our references to the status parameter are wrong,
since they are all referencing `status`, which in most cases is:
status:
description: |
The ``status`` of the consistency group snapshot.
This patch fixes this by referencing the right status parameter.
TrivialFix
Change-Id: I3f76ad10bacd8c75f742efc3ff3395a7effc31b5
Our Api-ref CI job failed due to the change[1] in os-api-ref.
This patch fixed the issue.
[1]: I8686006339b82ed5465dd8e4d3a8b15f85ee897c
Change-Id: I00458bef8729e9ff877b4e38563f5d133de47cf5
This commit fixes the response bootable parameter type in the api
document. The type is string not boolean in the current code. And
the request parameter's type is boolean. I think this is an
inconsistency but we shouldn't change it to keep the backward
compatibility.
Change-Id: Ia0c70341f595580d12888e1f517e314fb98d4a6b
Current capabilities api-ref explains that the API takes
{hostname}, but this is not accurate.
Actually this api takes hostname@volume_backend_name format.
To avoid confusion, this explanation should be updated.
Change-Id: I0d9e9925a1b011f49cefc9867f617e8b51ec7437
This patch allows scheduler to work with clustered hosts to support A/A
operations.
Reporting capabilities of clustered hosts will be grouped by the
cluster_name instead of the host, and non clustered hosts will still be
stored by host.
To avoid replacing a newer capability report with an older version we
timestamp capabilities on the volumes (it's backward compatible) and
only replace currently stored values in scheduler when they are newer.
Following actions now support A/A operation:
- manage_existing
- manage_existing_snapshot
- get_pools
- create_volume
- retype
- migrate_volume_to_host
- create_consistencygroup
- create_group
- update_service_capabilities
- extend_volume
And Affinity and Driver filters have been updated.
The new functionality to notify service capabilities has not been
changed to Active/Active and will be done in another patch.
APIImpact: Added microversion 3.16
Specs: https://review.openstack.org/327283
Implements: blueprint cinder-volume-active-active-support
Change-Id: I611e75500f3d5281188c5aae287c62e5810e6b72
Current doc states "Error repsonse codes:204". This should actually
by "Normal response code" and be 202 (Accepted) vs 204 (No Content).
Change-Id: I6e3855b2d1280de3e0fe6b5638feb54e9dfa4c10
Closes-bug: #1598237
Updates v2 and v3 documentation to reflect admin-only status of
API within volume actions.
- Edited to add bug reference
Change-Id: Ib7eff37bbbc05fedd2d9c9349ca500b20875e64e
Closes-Bug: #1501752
This fixes several things:
1. The consistencygroup_id and metadata parameters are optional.
2. Several parameters used were for non-volume types, this changes
the api-ref to use the proper parameters that have the correct
descriptions for creating a volume.
At some point the parameter names in parameters.yaml need to have
more descriptive names than the lazy *_1, *_2, etc names so it's
easier to know what a parameter is for,
e.g. volume_description_body_required, but that's for a later
cleanup.
Change-Id: I1fb8ca507c85bfbf0add41b507c014ae995e17d0
Closes-Bug: #1642983
We have already removed xml support from cinder code
in previous release.
As per previous discussions, xml references are required
to eliminate to sync code and api-ref.
Implements : blueprint eliminate-xml-references
Change-Id: I0cb7da56306e29cff8385c784bfc3f49cd9cfddd
'replication_targets' is always returned in Response of GET/v2/
{tenant_id}/capabilities/{hostname} API, but it is not written
in either Response parameters table or JSON example.
'display_name' is listed in JSON example but not described in
Response parameter table.
This patch adds the above two missing information.
Change-Id: Ib3bf54df7c5c400cfec64dd9c7df136c87cd6376
Closes-Bug: #1603306
The Cinder v3 API was marked CURRENT in Mitaka, but there no API ref
was ever created. This is problematic for end users and would hinder
the v3 API from being included in DefCore Interoperability Guidelines
somewhere down the line (since one of DefCore's Criteria[1] is that a
Capability be well documented). This patch creates an API ref for v3.
It also adds a header to the v2 index to show that it is SUPPORTED,
whereas v3 is CURRENT.
[1]
http://git.openstack.org/cgit/openstack/defcore/tree/doc/source/process/CoreCriteria.rst#n77
Change-Id: Ia3a8050cd04ad3a487a79d80acf9691feee6182e
Closes-Bug: #1616072
user_id, project_id and status were listed as request parameters when
they are actually response parameters.
Change-Id: I5ff464c6aae853929b2b10ba62898913977016b0
Closes-Bug: 1603177
Currently, the API reference is showing a blank sample response
for the v2 "List API Versions" call [1]. That appears to be because
the sample file it includes is "versions-resp.json" which exists, but
is 0 bytes (completely empty). There is also a
"versions-response.json" file present in the samples directory, which
appears to contain a valid JSON reply.
This patch fixes the problem by removing the 0-byte sample file and
pointing to the correct one.
[1]
http://developer.openstack.org/api-ref/block-storage/v2/#list-api-versions
Change-Id: If2c1b486229681f68ba4ab0c13307de4599d9b72
Closes-Bug: #1623744
Because of the underlying SQLAlchemy qos-specs functionality, which is
the only in-tree DB implementation, requiring context.is_admin to be
True, it's not technically correct to say "Administrators only,
depending on policy settings." Even if the associated
volume_extension:qos_specs_manage policy doesn't require an
"administrator", the @requires_admin_context decorator on the
underlying functionality definitely will.
ERROR: User does not have admin privileges (HTTP 403)
Change-Id: I0bc6a59c612b6c4ff7dcaff36dad712d8e3e03c2
Partial-Bug: #1621715
Currently, Cinder api-ref is configured with logABug feature.
When users click "Report bug" button,
it leads to "bugs.launchpad.net/openstack-manuals" which is default.
We should change it to "bugs.launchpad.net/cinder/".
Change-Id: Iabd97f92a9cdc64513fc572630ef223762794f95
Remove useage of old os-api-ref version and replace with current version.
Follow other repositories and merge v1 and v2 in a single document.
Note that we need to have a single document so that preview of the
document works properly in our CI.
Change-Id: I82c8b9ca317298b3dc1f7133ce8c0e9b3503730d