27 Commits

Author SHA1 Message Date
Takashi NATSUME
cfaf8e571f api-ref: Move the evacuate action to admin action
The evacuate action can be performed by administrators only by default.
But there is the description of the evacuate action in
the "Servers - run an action (servers, action)" section.

It should be in the "Servers - run an administrative action
(servers, action)" section.
So move to the description of the evacuate action
into the administrative action section.

Change-Id: Iafdd77c14c702af24dbb3f5a3adecc45b3014c48
Closes-Bug: #1796054
2018-10-04 19:20:22 +09:00
tianhui
55c8616632 Fix bug to api-ref
The API reference for the server 'migrate' (cold migrate) action
doesn't mention any asynchronous post conditions. We should have
something similar to what's in the 'resize' action API reference.

Change-Id: I596b95cbd276e8d16a1cc8ce20d77f0ff6985317
Closes-bug: #1774234
2018-06-22 12:05:26 +00:00
Takashi NATSUME
d2ce4ca9ec Enable cold migration with target host(2/2)
This function enables users to specify a target host
when cold migrating a VM instance.

This patch modifies the migration API.

APIImpact
    Add an optional parameter 'host' in cold migration action.

Change-Id: Iee356c4dd097c846b6ca8617ead6a061300c83f8
Implements: blueprint cold-migration-with-target-queens
2017-11-29 20:48:16 -05:00
Andreas Jaeger
4e6eec5c9b Fix broken URLs
Fix broken nova URLs that linked to the old developer/nova places and
use the new link instead.

Change-Id: Ideb50626e140201dded19fc82584440f1a407e47
2017-09-07 15:42:31 +02:00
Takashi NATSUME
9d6913d9f0 api-ref: Fix unnecessary description in servers-admin-action
The action to change the administrative password is not
included in servers-admin-action.inc.
So the description related to the action is removed.

Change-Id: I942aaea755375822e9f5ac9e29287de0c08dc573
Implements: blueprint api-ref-in-rst-pike
Closes-Bug: #1686917
2017-05-01 04:28:58 +00:00
Matt Riedemann
0a03f0123c api-ref: move createBackup to server-actions
The createBackup API is by default an admin-or-owner API, so it
should live in server-actions rather than server-admin-actions.

Change-Id: Ifdc08a1df39f30944d45e2001d590b34a963d062
Closes-Bug: #1679314
2017-04-25 12:05:48 -04:00
Matt Riedemann
b98d9e1d4f Document and provide useful error message for volume-backed backup
The createBackup API does not support backing up volume-backed
instances. The error message the user gets is not useful about
why the request was invalid, and the API reference docs do not
mention the limitation. This change addresses both of those issues.

Change-Id: I04fd8ab4f8818d9d0ccccb6f6fcb34965b15b8f3
Partial-Bug: #1679314
2017-04-10 16:24:28 -04:00
jichenjc
72081ded4d Add description for Image location in snapshot
snapshot action nova will return image URL in response header
better to provide this info to end user for their reference.

Also, the backup header description is changed as well.

Change-Id: I15cf228b4a5a2d0dbae5fa76ec6821487e7808ed
Closes-Bug: 1657998
2017-03-13 19:09:08 +08:00
Jenkins
f98006f8a4 Merge "correct misleading wording" 2017-01-06 17:48:23 +00:00
jichenjc
e4ae7e91dc correct misleading wording
this schema tells us host is required
https://github.com/openstack/nova/blob/master/nova/api/
openstack/compute/schemas/migrate_server.py#L33
and also param say it's required, but the doc says 'if you omit'
will misleading user ,actually, user can't omit it, they need
to input null to let scheduler decide

Implements: blueprint api-ref-in-rst-ocata

Change-Id: I2661c85f32eff8e199856635a4c40a494a5decb6
2017-01-06 14:38:40 +00:00
Takashi NATSUME
e7f5f02f7d api-ref: Fix parameter type in servers-admin-action.inc
Fix parameter type and add a missing parameter
in servers-admin-action.inc.

Change-Id: I8ad9227b49ad8148098a8658647bb4a9216d15ba
Closes-Bug: #1651441
2016-12-26 05:30:47 +00:00
Pavel Kholkin
df6e2d37f2 [proxy-api] microversion 2.39 deprecates image-metadata proxy API
Almost all proxy APIs were deprecated in microversion 2.36.
But the sub-resource image-metadata of image was forgotten to deprecate.
This patch deprecates the image-metdata API from 2.39.

Implements blueprint deprecate-image-meta-proxy-api
Closes-bug: #1614578

Change-Id: I5507337ab6fe4a377f66dec3fe275d75618cd7b4
2016-12-07 19:22:43 +03:00
Karen Bradshaw
168a500570 API Ref: update server_id params
- Update server_id params to be of type path.
- Cleaned up os-getConsoleOutput action string.
- Made empty response body description more consistent.
  Review and change as needed.

Implements: bp/api-ref-in-rst-ocata

Change-Id: Ie1e299d2b93188240b18138eba9f5b908a1078a4
2016-11-11 14:01:51 -05:00
Pushkar Umaranikar
d6d41bf888 Api-ref: Improve os-migrateLive input parameters
Modified type of block_migration from input params
of os-migrateLive API based on API version 2.25

Change-Id: I82c6537d137b462dbe6d05c07a9b3afb5a1501d5
Closes-Bug: #1551782
2016-08-30 11:35:30 +00:00
Timofey Durakov
452be384cd rest api version bumped for async pre live migration checks
pre live-migration checks now are done in async way. This patch
updates rest api version to keep this tracked.

bp: async-live-migration-rest-check

Change-Id: I9fed3079d0f1b7de3ad1b3ecd309c93785fd11fe
2016-07-11 14:57:54 -07:00
ghanshyam
a41d396152 api-ref: verify images.inc
This completes the verification of images.inc for
all required area(parameter, example, body)

Part of bp:api-ref-in-rst

Change-Id: I47ed4d0b4446a0b45a1df312b84ec6bfdaa134b6
2016-06-24 14:35:23 +00:00
Jenkins
df9e74ca35 Merge "Fix white spaces in api-ref" 2016-06-06 20:55:37 +00:00
Sylvain Bauza
7aa2285e72 API change for verifying the scheduler when live migrating
After modifying the evacuate action, we now add a new microversion
change for modifying the live-migrate call so that the scheduler is
called when the admin user provides an hostname unless the force
field is provided.

APIImpact

Implements: blueprint check-destination-on-migrations-newton

Change-Id: I212cbb44f46d7cb36b5d8c74a79065d38fc526d8
2016-06-06 11:44:06 +02:00
Takashi NATSUME
9d41696515 Fix white spaces in api-ref
TrivialFix
Change-Id: Icd7cd923522b6d97e19c89ad417eb5560649f6ba
2016-06-06 12:04:54 +09:00
Sean Dague
c9f5ad3bcf remove /v2.1/{tenant_id} from all urls
As discussed at summit, the version part of the URL is not really
relevant, or a thing a user should be filling out themselves, this
should instead be set by the service catalog and extracted from the
token.

This removes it's reference in all documented REST urls, and adds a
new section describing how one gets the base URL for all calls.

Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c
2016-06-03 08:47:33 -04:00
jichenjc
49c9947c4f api-ref verify of servers-admin-action.inc
verified the API doc for server admin actions,
adjus the wording for default policy,
Also, remove some common error code like 500, 503 etc

The 'backup' action actually is enabled to owner
of the server, follow up patch may move to server
actions.

Part of bp:api-ref-in-rst

Change-Id: I69900f4697bd5b71f0b8f8908037a49eff51b7c6
2016-04-30 20:08:17 +08:00
He Jie Xu
e3b0edbbe3 Compelete method verification of os-servers-admin
Corrects the error status responses for os-servers-admin

Part of bp:api-ref-in-rst

Change-Id: I3385834ed13104b49fbc4d2a566f9553da046c4b
2016-05-09 11:21:57 +08:00
Sean Dague
d929b9fc76 add tags to files for the content verification phase
This adds a set of tags in comments to the beginning of files so that
we can process them according to the documentation here:
https://wiki.openstack.org/wiki/NovaAPIRef

Part of bp:api-ref-in-rst

Change-Id: I17cf584dafb5bd969c12f51b7e7185d92365bf93
2016-04-20 16:21:58 -04:00
jichenjc
dfcd3a3c91 change host to host_migration
host param in migration refer to wrong link.

Part of bp:api-ref-in-rst

Change-Id: I7bf2459dace2cf0a90ae32f75ed734f533219c63
2016-03-24 04:39:50 +08:00
ghanshyam
24d380b4d0 Fix all remaining sample file path
This patch fix sample file path in all remaining api ref files.

Part of bp:api-ref-in-rst

Change-Id: I214b3a5bedea44cdfeba644ef3796938b709f4bf
2016-04-20 16:56:47 +09:00
Sean Dague
9526462326 move sphinx h3 to '-' instead of '^'
In the sphinx document h3 is supposed to be '-' not '^':

=, for sections
-, for subsections
^, for subsubsections

We have to enforce consistency here because we're processing included
files which all have to agree, otherwise it's a sphinx error.

Part of bp:api-ref-in-rst

Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc
2016-04-15 07:43:06 -04:00
Sean Dague
d4e2771440 Import RST files for documentation
This is the results of the RST conversion from WADL. It creates a
single index plus a bunch of included files which represent sections
of the API document. This is the starting point for fixing the
documentation.

Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-13 07:34:45 -04:00