This adds high level details and links to more detailed docs
in both nova and glance.
This also un-hides the document so it shows up in the table of
contents on the main page. Previously it was being linked from
the general info page and some typos in there are fixed as well.
Change-Id: I495b9ae7855d36cb2597272bcae7ec00360bbed4
The api documentation is now published on docs.openstack.org instead
of developer.openstack.org. Update all links that are changed to the
new location.
Note that Neutron publishes to api-ref/network, not networking anymore.
Note that redirects will be set up as well but let's point now to the
new location.
For details, see:
http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007828.html
Change-Id: Id2cf3aa252df6db46575b5988e4937ecfc6792bb
This patch adds the documentation around the work regarding
handling down cells that was introduced in v2.69.
Related to blueprint handling-down-cell
Change-Id: I78ed924a802307a992ff90e61ae7ff07c2cc39d1
Replace the 'NOTE' and 'TODO' words with
the note and todo directives in the Compute API guide.
Improve some format in the guide.
e.g. Fix unnecessary bold characters.
Change-Id: I7e9d6b8a5228886fd5de03d12482481d2b652666
Closes-Bug: #1558459
In order to record the update history, use "git mv" to rename the
api-guide doc.
Depends-On: https://review.openstack.org/599276/
Part of bp support-to-query-nova-resources-filter-by-changes-before
Change-Id: I594dcead5edc222cb040cf11675fc76358e93ef8
Due to the migration of the OpenStack document library, some outdated
links were found during use, using https instead of http and pointing
to the right place.
Change-Id: I1e37e15643b4ff7a7b22b2c7c39eba76d0cbdb39
The extensions are already removed from Nova API. So remove the
old section about the extensions from the API concept doc.
Change-Id: I29d6e85c23dd45e9f2452e58efb0feba70fb3ef4
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
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
As the folloing content of etc/nova/api-paste.ini, legacy v2
endpoint is /v2, not /v2.1.
/v1.1: openstack_compute_api_v21_legacy_v2_compatible
/v2: openstack_compute_api_v21_legacy_v2_compatible
/v2.1: openstack_compute_api_v21
So this patch fixes the endpoint.
Partially implements blueprint complete-todo-in-api-concept-doc
Change-Id: I6d9346ced38f522c516778cadae217d1d5c9cff1
Most parts contain "ReSTful HTTP service" instead of "ReSTful web
service". So this patch changes "ReSTful web service" for the word
consistency.
Partially implements blueprint complete-todo-in-api-concept-doc
Change-Id: I642ae649adad8f886bdb6bce979a1dd7d2430a80
In the introduction to the guide, note that there is a single API for
both end users and operators.
blueprint complete-todo-in-api-concept-doc
Change-Id: I726d1f230c0090ca8890195f56167e19a18e4665
The current navigation bar includes a strange gap in it due to how the
toctrees are currently arranged in the document. This moves them into a
single list.
blueprint complete-todo-in-api-concept-doc
Change-Id: I3c6c68bafb589887e32a990e0cccf1bff9e68518
Uses openstackdocstheme to match other content
Has a dependent change in project-config also so that
file will build to developer.openstack.org/compute
at https://review.openstack.org/#/c/231000/
Change-Id: Ic060a1e79e4b2f8695cb788ff4df018e0cfd3286
This moves material from 2.0_general_info into the index to make an
improved index page.
Some details from the general_info have been moved into the server
concepts, where that information is a better fit.
The general_info page has been expanded with TODOs so we are clear
about some the missing details.
Co-Authored-By: Ed Leafe <ed@leafe.com>
Change-Id: I2a878586d6a073026d1f997e6f0f7ee87a01f726
The toctree was globbing a nonexistent directory, and not producing
useful output. This patch lists the contents correctly.
Change-Id: I414120d948bd3eeeec84ac279bab11c276ef5eee
Sundar Nadathur
Matt Riedemann
Andreas Jaeger
Balazs Gibizer
Surya Seetharaman
Takashi NATSUME
zhangbailin
He Jie Xu
Nguyen Phuong An
Ken'ichi Ohmichi
Waldemar Znoinski
John Garbutt
Felix Li
Anne Gentle
Matthew Gilliard