128 Commits

Author SHA1 Message Date
Takashi NATSUME
9fbd7861dd api-ref: Add X-Openstack-Request-Id description
Add the description for the following items
in the API reference and the API guide.

* 'X-Openstack-Request-Id' header in request
* 'X-Openstack-Request-Id' header in response
* 'X-Compute-Request-Id' in response

Change-Id: Idd9181c1530eb9576da9941416b697a97c0cfb8d
Closes-Bug: #1693555
2017-07-10 14:03:14 +00:00
Matthew Treinish
acdc2da0e3 Remove cloudpipe APIs
This commit removes the cloudpipe API from nova. This has been
deprecated since change I415760ff634dd85974f0c3f79e788e633852efb5 and no
longer works without nova-cert and the pending removal of the deprecated
nova-network.

Implements bp remove-nova-cert
Change-Id: Ifd1fb13a5953cc66f9cc2561d30a9efcd3f4c92e
2017-05-04 16:13:45 +08:00
Matthew Treinish
2bcee77e3b
Remove nova-cert
This commit removes nova-cert which has been deprecated since change
Id7a1fc943cbe6d860a50d3cc776717b55351004b. The APIs have been hard coded
to return a 410 whenever they're called now. For the API ref a new
section for obsolete apis is added to the bottom of the page and the
certificates api ref is moved there.

Implements bp remove-nova-cert

Change-Id: I2c78a0c6599b92040146cf9f0042cff8fd2509c3
2017-04-27 22:28:01 -04:00
Cao Xuan Hoang
d99fd590b0 Removes unnecessary utf-8 encoding
trivialfix

Change-Id: I1294ecb5e85c9bf70a23992e92eeccfd35362551
2016-12-20 10:27:01 +07:00
Matt Riedemann
2f80a62005 docs: cleanup wording for 'SOFT_DELETED' in api-guide
The previous description of this status value was hard to
process. This cleans it up a bit.

Change-Id: I952bc712adf0dd7932da7eed460c10759ff3f9f2
2016-11-28 11:51:00 -05:00
Ianeta Hutchinson
e5f379f84b Fix small RST markup errors
Change-Id: Ie9f328ecaa5f6771538dec74572b6d06c0f19b02
2016-09-29 16:24:21 +00:00
Jenkins
d7062c714e Merge "Remove last sentence" 2016-09-26 13:12:57 +00:00
Nguyen Phuong An
146499fa43 Remove last sentence
This patchs removes last sentence because it contains wrong infomation.
Current we are using RST and YAML instead of WADL and it isn't
really a machine processable version any more.

Change-Id: I45251411be6afcba69800f198e0cc47df77e7626
2016-09-26 15:23:09 +07:00
Jenkins
ae82a01627 Merge "Fix a typo from ID to Id" 2016-09-21 03:04:47 +00:00
jichenjc
3e29e55fe8 Rate limit is removed , update doc accordingly
Rate limit is not support in v2.1 API any more, update doc to
remove that part.

Change-Id: I57742c10c6a6ad97f400db3c928fccf3d8f4733c
2016-09-10 18:51:12 +08:00
Jenkins
867b23a075 Merge "Doc fix for Nova API Guide, fixed wording" 2016-09-19 15:56:55 +00:00
Kurtis Cobb
58be202159 Doc fix for Nova API Guide, added missing word.
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
2016-09-14 12:15:51 +00:00
Kurtis Cobb
41aa2647e5 Doc fix for Nova API Guide, fixed wording
This patch updates the Nova API Guide: faults.rst. Modified wording
on line 94 for improved readability.

Change-Id: I622d64f7aa80c559fbf924adf1f9ce0ee82f3d81
Related-Bug: #1622758
2016-09-12 18:10:14 -07:00
jichenjc
9a5ec4bcb5 Fix a typo from ID to Id
this is in the doc and noticable by user,
it's X-Compute-Request-Id instead of X-Compute-Request-ID
so worthy change it

Change-Id: Ibb6f38e1694a9a3381ea8473cbe6d0e97e3266ec
2016-09-10 18:43:39 +08:00
Jenkins
b61cb28e98 Merge "Change api-site to v2.1 format" 2016-09-08 15:57:36 +00:00
Ken'ichi Ohmichi
7957b910dd Change api-site to v2.1 format
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
2016-08-16 16:17:03 -07:00
Jenkins
7ae987bfc4 Merge "Fix the broken links" 2016-07-27 02:00:49 +00:00
Jenkins
08c84ca7ab Merge "Cleaned up request and response formats page" 2016-07-26 13:20:10 +00:00
bhagyashris
a5581d8bf9 Fix the broken links
In nova.api-guide.source.limit, the link for limits is incorrect

TrivialFix

Change-Id: Ic9b95af9694c15138f0c635e74f9ba8a0249df93
2016-07-12 16:57:26 +05:30
Jenkins
220439fcd6 Merge "Make available to build docs with python3" 2016-05-26 17:24:03 +00:00
Chris Dent
bd199e3f9b Support for both microversion headers
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
2016-05-25 21:41:27 +00:00
Andrey Volkov
9053a4685b Make available to build docs with python3
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
2016-05-23 15:30:20 +03:00
Nguyen Phuong An
0cfc126bfd [api-guide]: Update reference links
This patch update reference links in
http://developer.openstack.org/api-guide/compute/.

Closes-Bug: #1615944

Change-Id: Ia794f6ae2b84620636e19f9460c5b2bd07f4522d
2016-08-23 14:16:10 +07:00
Gage Hugo
64cbefbe38 Cleaned up request and response formats page
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
2016-05-06 12:47:32 -05:00
Atsushi SAKAI
340b7e9404 [doc] fix 5 typos
tweek        => tweak
adminstrator => administrator
mulitple     => multiple
definied     => defined (2-locations)

Change-Id: Ibe2c04e1b225515f7a6c83b5a4a8d91e8385140a
2016-04-28 20:40:18 +09:00
Anh Tran
a2d0d65a29 Removes some redundant words
This patch removes some redundant words.

Change-Id: I1461ad1d98272b0d6223fd989861885902c12617
2016-03-25 09:10:36 +07:00
Jenkins
0ed6dc57f6 Merge "Fix JSON format of server_concepts" 2016-03-22 02:07:26 +00:00
Jenkins
c032ce47b6 Merge "Remove /v1.1 endpoint from api-guide" 2016-03-21 18:55:33 +00:00
Ken'ichi Ohmichi
6ee7d4413a Fix JSON format of server_concepts
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
2016-03-21 10:36:50 -07: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
Jenkins
235d1a3795 Merge "Error on API Guide warnings" 2016-03-18 22:28:07 +00: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
Abhishek Anand
5f4a60fc1a fixed typo in word "OpenStack"
Change-Id: Ia7af1834c12e775de736c7afeaa529c63758bbe7
2016-03-13 00:31:32 +00:00
Hironori Shiina
230958c002 Documentation fix regarding triggering crash dump
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
2016-03-04 13:04:44 +09:00
Jenkins
35033197c2 Merge "doc: all_tenants query option incorrectly identified as non-admin" 2016-02-26 13:05:16 +00: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
6ad6206e28 Merge "Fix some word spellings in messages" 2016-02-22 19:01:10 +00:00
Eoghan Glynn
f7c18c4393 doc: all_tenants query option incorrectly identified as non-admin
The all_tenants option was incorrectly described as being available
to general users.

Change-Id: I739da63b3d5460ff1ef8dcafd21d58829a3a4852
2016-02-06 14:03:25 +00:00
Jenkins
11dfd9def3 Merge "Trivial: Remove a duplicated word" 2016-02-03 09:15:58 +00:00
Jenkins
22810c4dd7 Merge "Add description for server query" 2016-02-03 07:03:30 +00:00
venkatamahesh
f86daf0607 Fix some word spellings in messages
Change-Id: I40e3c0f3b99ae853f84609c5334e6d230dfff867
2016-02-03 12:07:53 +05:30
Jenkins
22e0e06ec1 Merge "doc: remove detail about extensions" 2016-02-03 03:34:06 +00:00
xiexs
959b51f3d4 Trivial: Remove a duplicated word
s/there there is/there is/

Change-Id: I3c352b97ca9e191834c933bfd31261fefda12d59
2016-02-02 10:23:14 -05:00
Jenkins
befefa43b5 Merge "Add description for trigger crash dump" 2016-02-02 15:03:47 +00:00
He Jie Xu
d04f7f7e12 doc: remove detail about extensions
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
2016-02-02 12:03:49 +00:00
xiexs
2051e3b361 Add description for trigger crash dump
Add description for server trigger crash dump operation
into api-guide.

Change-Id: I20492dbf9eab4f7fcab0864bb250b20f98b762e4
blueprint complete-todo-in-api-concept-doc
2016-02-02 01:41:54 -05:00
Jenkins
ae8546c542 Merge "remove docs about format extensions" 2016-01-28 17:47:59 +00:00
Jenkins
2b1d5a9b36 Merge "doc: add client interactive guideline for microversions" 2016-01-25 02:36:48 +00:00
Jenkins
aa9db1ccef Merge "doc: add version discovery guideline in api concept doc" 2016-01-25 02:36:09 +00:00
Jenkins
1b3fa9d316 Merge "doc: completes microversion use-cases in api concept doc" 2016-01-25 02:35:26 +00:00