fd1ad4d582e97aa8cca59635f940946a7654ed5b
21 Commits
| Author | SHA1 | Message | Date | |
|---|---|---|---|---|
|
Matt Riedemann
|
a4966b8ee9 |
api-guide: flesh out the server actions section
The API guide on faults has a section on server actions but just links to the API reference. There is also the "Asynchronous faults" section at the bottom which refers to the server actions API but does not go into details. This fleshes that section on server actions out a bit more and includes a walkthrough on the command line of a failed resize due to NoValidHost. I chose this example since the server status does not change to ERROR so there is no fault to see in the server details when the resize action fails. Change-Id: I95130eeeac1ef8f4676925fe6c0e2d386d88259c |
||
|
Matt Riedemann
|
b7c6da3074 |
api-guide: flesh out todos in user doc
This is pretty basic. As for the todo about using named personas I've just removed that since I don't think at this point anyone is going to work on assigning names like Bob and Sally to roles in the guide and consistently use them. Change-Id: I88dfb23c0e2750dc37d32dfc431b62baed7238b6 |
||
|
Matt Riedemann
|
163482e0e1 |
doc: fix links for server actions in api guide
The section about server actions is talking about the os-instance-actions API but linking to the server actions section in the API reference. This retains the link to the server actions section but changes the "for more details" link to the actual os-instance-actions reference. Change-Id: Icb5c4cadd1c552f44bfadefd055c07ea38df0eaa |
||
|
Andreas Jaeger
|
dbe6321537 |
Update api-ref location
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 |
||
|
zhufl
|
84afd12589 |
Change some URLs to point to better targets
This is to change some URLs to point to better or more accurate targets. Change-Id: I1d450ba8bd2271a69f9380cc4d2b36ae3eefe09a |
||
|
zhufl
|
fbc86f8844 |
Fix none-ascii char in doc
There exist some none-ascii chars in doc, which may cause trouble in displaying. Change-Id: I1ebf83fb4e8cc853fd7f3065ecf420a064c9983f |
||
|
Matt Riedemann
|
88f86e24e1 |
doc: cleanup API guide about instance faults
The compute API guide section on instance faults is updated to point out that server details contain fault information for servers in ERROR or DELETED status along with a simple non-admin scenario example. Change-Id: Idc725a594b67b5f6e45c6f161f6e92c0601761a8 Closes-Bug: #1762842 |
||
|
zhangbailin
|
110b499b6a |
Update links in documents
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 |
||
|
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 |
||
|
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 |
||
|
Jenkins
|
867b23a075 | Merge "Doc fix for Nova API Guide, fixed wording" | ||
|
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 |
||
|
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 |
||
|
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 |
||
|
Waldemar Znoinski
|
fdd8f0f91e |
Fix API Guide doc
* typos * reduntant words * reworded sentences for clarity Closes-bug: #1545748 Change-Id: I0700d04de38b34cf13988490873b8c34dad1005b |
||
|
Ken'ichi Ohmichi
|
da3001bc80 |
Make admin consistent
There are variety like "admin" or "administrator" on api-guide, so this patch makes these words consistent for the readability. Partially implements blueprint complete-todo-in-api-concept-doc Change-Id: Id0a9444e5d48f62d6d02114f8668761647c2dae0 |
||
|
Jenkins
|
c0be3f0479 | Merge "Remove description about image from faults section" | ||
|
He Jie Xu
|
10559e91e1 |
docs: using the correct format and real world example for fault message
This patch corrects the fault message format, and use an example which existed in the real world. blueprint complete-todo-in-api-concept-doc Change-Id: I76706cca5a9fdcfa6c3e2c9d08aa8f94fb9471d8 |
||
|
He Jie Xu
|
2ee6ddf686 |
Remove description about image from faults section
There isn't 'fault' field in the response of image API. So remove image stuff from the faults section. blueprint complete-todo-in-api-concept-doc Change-Id: I79d2b4a3dc492b8410b649756057c2d824f19989 |
||
|
John Garbutt
|
c9f0adc12a |
docs: update the API faults concept guide
This updates the API concept guide to talk about request-ids and the Server Actions API, while keeping the existing content on sync and async errors. blueprint complete-todo-in-api-concept-doc Change-Id: Icbc4a3a3559552f7d210838536897e411a9d4ce4 |
||
|
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 |