80 Commits

Author SHA1 Message Date
Jenkins
1aa1462b98 Merge "[placement] api-ref GET /traits name:startswith" 2017-09-08 21:29:24 +00:00
Matt Riedemann
84360f693f api-ref: note the microversions for GET /resource_providers query params
The member_of query parameter was new in 1.3.

The resources query parameter was new in 1.4.

As a result, the 'resources' parameter description used for
allocation_candidates has to be decoupled since the entire
allocation_candidates API was new in 1.10 and is not specified
per parameter.

Change-Id: I6e0688b4a12212ace98a6876132735094df84b77
Closes-Bug: #1716046
2017-09-08 16:02:27 -04:00
Jenkins
28cf7b167f Merge "Typo error about help resource_classes.inc" 2017-09-08 14:28:09 +00:00
kangyufei
2b63c14e52 Typo error about help resource_classes.inc
Change-Id: I6e61aadecc80f87cd75c1331ab2f725583e9966b
2017-09-08 11:03:00 +08:00
Andreas Jaeger
4e6eec5c9b Fix broken URLs
Fix broken nova URLs that linked to the old developer/nova places and
use the new link instead.

Change-Id: Ideb50626e140201dded19fc82584440f1a407e47
2017-09-07 15:42:31 +02:00
Eric Fried
3c4843beaf [placement] api-ref GET /traits name:startswith
In the Placement API reference, the GET /traits [1] query parameter
'name' says it accepts a key called 'starts_with'. The actual API
accepts 'startswith' (no underscore).

[1] https://developer.openstack.org/api-ref/placement/#list-traits

Change-Id: I5a1fa51fc751f2492ae6aa2b38893a9e06a26ed1
Closes-Bug: #1714283
2017-08-31 10:27:39 -05:00
Andrey Volkov
d0af9820e1 [placement] Add api-ref for allocation_candidates
Change-Id: Id89d7c16ca53938e2bc18e904e8d13477ceb15f7
2017-08-10 11:26:19 +00:00
jichenjc
4db481592d [placement] Add api-ref for RP usages
Add placement-api-ref for resource provider usages.

Co-Authored-by: Andrey Volkov <avolkov@gmail.com>

Change-Id: I6ba8765a427f654dafb32fc3fbf5492b0e1b426a
2017-08-10 09:37:27 +00:00
Andrey Volkov
032a1d0a3b [placement] Add api-ref for usages
Change-Id: I50954991f80725dc22be95eeecded2ee1e005e97
2017-08-09 15:54:48 +00:00
Andrey Volkov
5f3e136e25 [placement] Add api-ref for RP allocations
This provides simple documentation of the path and response
body parameters when listing resource provider allocations.

Co-Authored-by: Andrey Volkov <avolkov@gmail.com>

Change-Id: I40fcbc3077151227f33c6a021229b5c549889bbe
2017-08-07 12:06:53 +03:00
Andrey Volkov
64ae6832db [placement] Add api-ref for allocations
This provides simple documentation of the path, request and response
body parameters when listing, creating, updating and deleting allocations.

Change-Id: I58e9dfcb62a2f485addeab98dcd835568ba792cf
2017-07-18 13:06:12 +03:00
Andrey Volkov
9bb4565d2b [placement] Add api-ref for RP traits
This provides simple documentation of the path, request and response
body parameters when managing the association between traits and
resource_providers.

Change-Id: I2ef25313db89a2fd58d11dc023d2d9755d0a86ed
2017-07-18 12:44:08 +03:00
Andrey Volkov
67028cb732 [placement] Add api-ref for traits
This provides simple documentation of the path, request and response
body parameters when listing, creating, updating and deleting traits.

Change-Id: If377b725e0910de2e1768666184a0212c8c9fdbc
2017-07-18 12:44:04 +03:00
Jenkins
ba3b1204bb Merge "[placement] Add api-ref for aggregates" 2017-06-12 16:38:26 +00:00
Andrey Volkov
1f6bddd74d [placement] Add api-ref for aggregates
This provides simple documentation of the path, request and response
body parameters when listing and updating aggregates.

Change-Id: Ife94d22e87a73fc26c4dcbda9545a9f59680f44f
2017-06-08 15:32:33 +00:00
Vu Cong Tuan
0808398487 Fix html_last_updated_fmt for Python3
html_last_updated_fmt option is interpreted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.

Changing Popen to .check_output because of 3 reasons:
1. check_output() will raise CalledProcessError if
the called process returns a non-zero return code.
2. For consistency with keystone [1] and cinder [2]
3. It makes the code look much better.

[1] https://review.openstack.org/#/c/457142/
[2] https://review.openstack.org/#/c/433081

Change-Id: Ia3e792c512da46c2b92d3ad9ec1657849d379052
2017-06-07 21:05:12 +00:00
Andrey Volkov
60a844cc4d [placement] Add api-ref for resource classes
This provides simple documentation of the path, request and response
body parameters when listing, creating, updating and deleting a resource
class.

Change-Id: I4038d116d53b68344282ef59f9f01753766d2ef8
2017-06-05 14:39:29 +03:00
Andrey Volkov
422d58b1dc [placement] Add api-ref for DELETE resource provider
This provides simple documentation of the path parameters when deleting
a resource provider.

Change-Id: I8cf3f1482450765d3e1daf83b6f595303d191a28
2017-05-29 09:18:32 +03:00
Andrey Volkov
f5c6af7619 [placement] Add api-ref for PUT resource provider
This provides simple documentation of the request and response body
parameters when setting or replacing a resource provider.

Change-Id: Ifa3c0bad0ec3f9d85f0f18bfd6f90e0bcb52773d
2017-05-29 09:18:32 +03:00
Andrey Volkov
06141e2064 [placement] Add api-ref for GET resource provider
This provides simple documentation of the response body and path
parameters when listing a single resource provider.

Change-Id: I84d472067e4365d59cab4863f87df9d24718701f
2017-05-29 09:18:32 +03:00
Andrey Volkov
c676d72594 [placement] Add api-ref for POST resource provider
This provides simple documentation of the request
parameters when creating a resource provider.

Change-Id: I1fd189503f33da4febcd2e4dc5132f4c240c19b0
2017-05-29 09:18:32 +03:00
Andrey Volkov
5cd44bf2d1 [placement] Add api-ref for DELETE RP inventory
This provides simple documentation of the path parameters when deleting
a single inventory record for a resource provider.

Change-Id: Ie7eeb426744bccf5e976ed304fa6f0a58b38ac01
2017-05-29 09:18:32 +03:00
Andrey Volkov
f31c79f961 [placement] Add api-ref for PUT RP inventory
This provides simple documentation of the response body and path
parameters when setting or replacing an inventory record for a resource
provider.

Change-Id: I77d99c174b50eef5d2b72e226ff31f03807e69aa
2017-05-29 09:18:32 +03:00
Andrey Volkov
59c02f48ee [placement] Add api-ref for GET RP inventory
This provides simple documentation of the response body and path
parameters when showing a single class of inventory for a resource
provider.

Change-Id: Ic562baa3e74445c8f6dbeb416c1ec183cc2ad14d
2017-05-29 09:18:32 +03:00
Andrey Volkov
b22f64a8a2 [placement] Add api-ref for DELETE RP inventories
This provides simple documentation of the path
parameters when deleting resource provider inventories.

Change-Id: Ia1f787fb9def8473a9698a9bf1ab1990a1c21f48
2017-05-29 09:18:32 +03:00
Andrey Volkov
4e1d732f4c [placement] Add api-ref for PUT RP inventories
This provides simple documentation of the request and response body
parameters when setting or replacing all inventories for a resource provider.

Change-Id: I720f5b6792b9f4ced905aef31715a835b07be504
2017-05-29 09:18:32 +03:00
Andrey Volkov
adf28fb842 [placement] Add api-ref for GET RP inventories
This provides simple documentation of the response body and path
parameters when listing resource provider inventories.

Change-Id: Id4ed2450ab70fc63d47dabb21c4a9b21f25d85b1
2017-05-27 10:15:12 +00:00
Andrey Volkov
cd95b4d63f [placement] Split api-ref topics per file
For more convinient text management each ROUTE_DECLARATIONS
has its own inc file in api-ref.

Change-Id: Ia2fd62ae7f401cad34ee7c2b355c9a5ab1c93f6b
2017-03-24 20:09:17 +03:00
Chris Dent
8ab4b7a1ed [placement] add api-ref for GET /resource_providers
This provides simple documentation of the response body and query
parameters when listing resource providers.

Change-Id: Ic8db81b5f17d4c380b64b3da24e525297db18584
2017-03-24 15:16:16 +03:00
Chris Dent
8c59991363 Structure for simply managing placement-api-ref
This consists of a duplicate of the [nova-]api-ref setup and
conf.py along with tooling to fail the tox -edocs target when
a route that is defined in
nova.api.openstack.placement.handler.ROUTE_DECLARATIONS is not
present in placement-api-ref/source/index.rst.
tools/placement_api_docs.py will report which routes are missing.

Though completely gameable (as demonstrated in the current lame
index.rst) it's better than nothing and provides some useful
structuring on what to do next. It's also the case that the 'docs'
target in tox is not part of gating.

The response for GET / is in place with the necessary
parameters.yaml for it to be correctly described. The 'get-root.json'
file provides the JSON of the expected response. The expectation is
that later commits will add information for other urls and their
JSON files will be named method-path-separated-by-dash.json with a
request/response qualifier as necessary.

Followup patches will add other routes.

A new parameters.yaml is used instead of reusing the one from
api-ref as there isn't a lot of expected overlap and having a
separate file will ease eventual extraction.

Running tox -eplacement-api-ref will generate the docs for review,
with output in placement-api-ref/build/html/index.html.

This will be hooked up with CI to deploy the generated docs,
eventually.

Change-Id: Ifb4d91d39db0e49b55952e37cdfc9f63dcd37aa3
2017-03-24 15:15:53 +03:00