This patch updates the Nova API Guide: faults.rst. Insert missing word
"call" on line 7 to improve readability.
Change-Id: Ia48870daff3d5f0ff0716ff716dfcc31f5ff6021
Closes-Bug: #1622758
The endpoint of v2.1 API is CURRENT now.
On v2.1 API, a tenant-id is not necessary to be specified on the
URL, that is good for making API calls simple for users.
In addition, the endpoint is different from old v2.0 API.
Then this patch makes the api-site fit for v2.1 format.
Partially implements blueprint api-ref-in-rst
Change-Id: I99224dfa77d64f7800733c1af69a55b3b5c761ac
In this change the new OpenStack-API-Version headers is allowed,
but not required, for requesting a microversion.
Both headers are accepted in the request and both headers are sent in
the response (both the header and its value, and the addition to the Vary
header).
Many tests which explicitly use a microversion header have been
updated to use both. This change is not 100% as most of the tests
are testing the handling of the value of the header, not which
header is involved.
Partially-Implements: blueprint modern-microversions
Change-Id: I68da13b5ba0c2f3357523e765a5b9db81899daf1
On Ubuntu 16.04 a tox package is for python3 by default
and this causes errors in building docs in tox enviroment.
In these changes iterators are replaced with lists where it's needed.
Also external command calls result are decoded from bytes to unicode.
Change-Id: I88ef54405b4bc13c269bdda55ae8289676311ee1
Cleaned up the request_and_response_formats.rst page by putting the
POST, host, and auth token values into their own block. Fixed
examples to example since there is currently only one.
Change-Id: I5d5e84c9e92e6770e6d413e90c66e0f4bfec20bf
server_concepts.rst contains some invalid JSON formats as samples.
This patch fixes them and improves the readability by adding some
spaces.
Change-Id: Ib51f9e1351fca51c15ffdcb98f42311b999f22f5
Since Id695f60e30b14f939973e3610c7750b83a14d0d0 , the endpoint /v1.1
has been removed. So it is nice to remove it from api-guide also to
avoid unnecessary confusions.
Change-Id: I1a70fec5568468c088f60986b9edd8bd1bf97314
Error on warnings in building the API guide and fix any problem
encountered:
* tox.ini: Enable tread warnings as errors
* index.rst: Add unreferenced file extra_specs_and_properties as
hidden file so that it does not show up in index. It is still
built and will be referenced from other files.
* general_info.rst: Remove reference to non-existing file
* server_concept: Add missing empty line after code directives
Also fix a typo and remove extra EOL whitespace.
Change-Id: Ie766f8d2f7d82b7b5b02541b342f9829ca4550a0
How to trigger crash dump depends on hypervisors. NMI is not the only way to
implement the feature. This patch modifies description regarding this feature.
Change-Id: I77d10551650776c06ee4b413f1b027abf6620e83
As extensions are already deprecated in Nova, this patch removes
all of the details about extensions, adds a note about the deprecation
of extensions, and points to documentation about microversions for
discovering API changes.
blueprint complete-todo-in-api-concept-doc
Co-Author: Ed Leafe <ed@leafe.com>
Change-Id: I56acfeac5b8b3312547c06d79962a79991c5c8f3
Add description for server trigger crash dump operation
into api-guide.
Change-Id: I20492dbf9eab4f7fcab0864bb250b20f98b762e4
blueprint complete-todo-in-api-concept-doc
Add descriptions for server query options and add some
samples for the query options.
Implement blueprint complete-todo-in-api-concept-doc
Change-Id: Id23a19ecc30f1837f4755ec898ef0389dcf23a8f
The format extensions concept (adding .json / .xml) is no longer
really a thing. The router supports it, but we only have json
responses, so there is no reason to advertise it.
Change-Id: I07ba13a98ce55c215c6b676b5ff41d7d60babfde
This patch adds basic guideline how to discover microversion with
version API.
blueprint complete-todo-in-api-concept-doc
Change-Id: I55b50e8300c67b9ec94587a2bdccac55a9c115a0
os.popen() is deprecated since version 2.6. Resolved with use of
subprocess module.
Change-Id: Iea9c0501f46c57d809217912fb0f40eb2bc4f111
Closes-Bug: #1529836
To help add color to the API doc, we use a common set of persona when
talking about the use cases behind each API.
This is really just a quick sketch that adds TODOs for others to follow
up on, in order to complete the guide.
blueprint complete-todo-in-api-concept-doc
Change-Id: I71a07caa27f1b17d3256a5439e867c40fc9d0abd
Common usage is REST, and most in project are written as REST.
Change ReST to REST to comply with it.
Change-Id: I2c87f4c811f7dd64a3f5807a45eba2a82373da36
