12 Commits

Author SHA1 Message Date
Jenkins
c032ce47b6 Merge "Remove /v1.1 endpoint from api-guide" 2016-03-21 18:55:33 +00:00
Ken'ichi Ohmichi
e5b0b06d18 Remove /v1.1 endpoint from api-guide
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
2016-03-21 09:30:05 -07:00
Andreas Jaeger
f25648a963 Error on API Guide warnings
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
2016-03-17 07:57:23 +01:00
Waldemar Znoinski
fdd8f0f91e Fix API Guide doc
* typos
* reduntant words
* reworded sentences for clarity

Closes-bug: #1545748

Change-Id: I0700d04de38b34cf13988490873b8c34dad1005b
2016-02-23 11:00:18 +00:00
Jenkins
0b7904eb64 Merge "api-guide: add a doc on users" 2016-01-12 15:02:03 +00:00
John Garbutt
e7106c3e75 api-guide: add a doc on users
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
2016-01-05 13:46:29 +00:00
Felix Li
f78030a8ad Fix typo, ReST -> REST
Common usage is REST, and most in project are written as REST.
Change ReST to REST to comply with it.

Change-Id: I2c87f4c811f7dd64a3f5807a45eba2a82373da36
2016-01-04 16:13:32 -05:00
Ken'ichi Ohmichi
1c6076a2fb Fix the endpoint of /v2 on concept doc
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
2015-12-08 12:50:54 +00:00
Ken'ichi Ohmichi
4ce28e5c2b Make "ReSTful service" consistent
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
2015-12-08 01:44:13 +00:00
John Garbutt
dbf5dfa4dc api-guide: add note about users
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
2015-12-02 10:04:39 +00:00
John Garbutt
fa602a3ff5 api-guide: fix up navigation bar
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
2015-11-25 12:56:29 +00:00
Anne Gentle
17961c41a3 Rearranges to create new Compute API Guide
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
2015-11-12 10:47:23 +00:00