Commit Graph

7 Commits

Author SHA1 Message Date
Sean Mooney df0a99a29a fix sphinx-lint issues in api guide
as with the previous commit this change is simply correcting the
usage of backticks for inline literals

Change-Id: Icbfd168266dc1348ee15f7347ed673d220989ceb
2023-10-02 22:20:01 +01:00
Takashi NATSUME ddf7c6e370 Improve formats of the Compute API guide
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
2018-11-07 04:01:40 +00:00
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
2018-08-07 00:13:00 +00:00
chenxing 22ab1b62b3 Fix the incorrect description and sample
This patch fixes the following:
 * The description says, "Here, a subset of metadata items
   are presented within the image." This is a server sample,
   not an image.

 * The sample itself has the wrong id in the "self" link and
   there are no metadata_links with a server object (probably
   a carry over from an image docs sample).

Change-Id: Idb1e5243d6d072e020e1532bec603e5cd219702e
Closes-Bug: #1737854
2018-07-18 06:54:29 +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
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
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