The descriptions of inspection_started_at and inspection_finished_at
node fields in api-ref are incorrect, this change fixes them.
Change-Id: I2e9e036f1dec0e6f34cae6780d5855b3295ae3c5
API microversions 1.18, 1.19 introduced new fields in Port resource,
this change adds them to api-ref documentation.
Partial-bug: #1526403
Change-Id: Ib7059fd1ec8ffc54fa34647cc558fb8c8e80f8d7
The max_limit option in the [api] section of ironic.conf is not
obviously pointed out in API documentation. This may mislead a user into
believing that using the "limit" parameter when listing resources from
the API may return more resources than the API configuration actually
allows.
This change adds documentation regarding how the max_limit option
affects API usage.
Change-Id: Ic55b31758b144aa8ef8b048f3dd90a4ffeee6fa4
Closes-Bug: 1597834
This updates the API documentation for the Drivers resource class,
replacing many of the samples and adding more verbiage to each property.
It's not perfect, but this is vastly more correct than the current docs.
Co-Authored-By: Vladyslav Drok <vdrok@mirantis.com>
Change-Id: Ibe045bea539b8fd2f02d7be37e09cc74f09b8df1
This updates the API documentation for the Ports resource class,
replacing many of the samples and adding more verbiage to each property.
It's not perfect, but this is vastly more correct than the current docs.
Co-Authored-By: Vladyslav Drok <vdrok@mirantis.com>
Change-Id: I559ef1e921aa8e2f2f1a8bd6ed18e0a39ecc4687
Currently, there is a node_uuid parameter that describes specifically
a node UUID in response body. Let's use just uuid.
Change-Id: I43ffe017188c1f15a0c6d8007d4bd463e867b774
This updates the API root documentation, which was non-existent,
and the Node documentation significantly, replacing many of the samples
and adding more verbiage to each property.
It's not perfect, but this is vastly more correct than the current docs.
Change-Id: Iaeb1c80ac0655fc0d73fa495ed43e3c02b345495
The html_last_updated_fmt option is the output of a shell command, which
is interpeted as a byte string in python 3 and subsequently breaks
Sphinx.
This change converts it to a utf-8 string.
Incidentally, this also removes the quotation marks to make the
formatted output cleaner.
Change-Id: I9aa6446a24d2f340246458dea0c34d456b3eade3
Closes-bug: #1583721
os-api-ref is released on pypi now, so we can move to using it instead
of our in tree version.
Change-Id: If353f4a2e553fa3da3b2a4c920e233f51365b77c
Depends-On: I0e615d36a2e5a8fa0d83f20bdcc2c33ad868ebd5
Per this email[0], it's time to migrate our API docs into our tree.
This copies the sphinx extension from nova into our tree as well, which
will be later split into its own python module. At that time we can cut
over to the module and drop it from our tree.
The conf.py and the tox environment are also cribbed from nova.
[0] http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html
Change-Id: I683cc4d6459d77c42951a06247b6f9ff8f8456bd
