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
This document previously existed to explain how to use either
application/json or application/xml with Nova. It's mostly confusing
in it's current state, and we're correctly defaulting to
application/json on request and response now.
Just remove most of what's confusing, users don't need to send
headers, we only do one thing now.
Change-Id: I597aeab73f1075f400f053016b4ea7bda01893a5
XML API interface has been already removed from Nova completely,
and its description of the extension concept becomes meaningless now.
So this patch removes it.
A small amount of the JSON description is left. The details are
trimmed down, as we're actually trying to get people away from
extensions as a concept.
A big warning to that effect is added into the document.
Partially implements blueprint complete-todo-in-api-concept-doc
Change-Id: Icf8bf87f38733ba03cf5ce1225594b0b282fde56
