api-ref: Example verification for servers.inc

This patch verifies request and response bodies in servers.inc.

Change-Id: I9266e7513ed6eb00599dc766081ce81014a209bb
Closes-Bug: #1739573
This commit is contained in:
Takashi NATSUME 2018-03-28 16:31:16 +09:00
parent c0350da4a1
commit 3b01a728ce
46 changed files with 284 additions and 35 deletions

View File

@ -1,5 +1,4 @@
.. -*- rst -*-
.. needs:example_verification
.. needs:body_verification
===================
@ -388,6 +387,11 @@ Request
.. literalinclude:: ../../doc/api_samples/servers/server-create-req.json
:language: javascript
**Example Create Server With Networks(array) and Block Device Mapping V2 (v2.32)**
.. literalinclude:: ../../doc/api_samples/servers/v2.32/server-create-req.json
:language: javascript
**Example Create Server With Automatic Networking (v2.37)**
.. literalinclude:: ../../doc/api_samples/servers/v2.37/server-create-req.json
@ -755,25 +759,14 @@ Request
- OS-DCF:diskConfig: OS-DCF:diskConfig
- description: server_description
**Example Update server name (2.47)**
.. note:: You can specify parameters to update independently.
e.g. ``name`` only, ``description`` only, ``name`` and ``description``, etc.
.. literalinclude:: ../../doc/api_samples/servers/v2.47/server-update-req.json
**Example Update Server (2.63)**
.. literalinclude:: ../../doc/api_samples/servers/v2.63/server-update-req.json
:language: javascript
..
TODO(sdague): split up the update examples to show them being used
separately.
**Example Update server IP addresses: JSON request**
.. literalinclude:: ../../doc/api_samples/servers/server-update-address-req.json
:language: javascript
**Example Update server OS-DCF:diskConfig parameter: JSON request**
.. literalinclude:: ../../doc/api_samples/servers/server-update-diskconfig-req.json
:language: javascript
Response
--------
@ -818,7 +811,7 @@ Response
- tags: tags
- trusted_image_certificates: server_trusted_image_certificates_resp
**Example Update server name (2.63)**
**Example Update Server (2.63)**
.. literalinclude:: ../../doc/api_samples/servers/v2.63/server-update-resp.json
:language: javascript

View File

@ -66,5 +66,11 @@
"updated": "2013-09-24T14:44:01Z",
"user_id": "fake"
}
],
"servers_links": [
{
"href": "http://openstack.example.com/v2.1/6f70656e737461636b20342065766572/servers/detail?limit=1&marker=a747eac1-e3ed-446c-935a-c2a2853f919c",
"rel": "next"
}
]
}

View File

@ -14,5 +14,11 @@
],
"name": "new-server-test"
}
],
"servers_links": [
{
"href": "http://openstack.example.com/v2.1/6f70656e737461636b20342065766572/servers?limit=1&marker=b2a7068b-8aed-41a4-aa74-af8feb984bae",
"rel": "next"
}
]
}

View File

@ -79,5 +79,11 @@
"updated": "2013-09-03T04:01:32Z",
"user_id": "fake"
}
],
"servers_links": [
{
"href": "http://openstack.example.com/v2.1/6f70656e737461636b20342065766572/servers/detail?limit=1&marker=f5dc173b-6804-445a-a6d8-c705dad5b5eb",
"rel": "next"
}
]
}

View File

@ -14,5 +14,11 @@
],
"name": "new-server-test"
}
],
"servers_links": [
{
"href": "http://openstack.example.com/v2.1/6f70656e737461636b20342065766572/servers?limit=1&marker=22c91117-08de-4894-9aa9-6ef382400985",
"rel": "next"
}
]
}

View File

@ -0,0 +1,24 @@
{
"servers": [
{
"id": "22c91117-08de-4894-9aa9-6ef382400985",
"links": [
{
"href": "http://openstack.example.com/v2/6f70656e737461636b20342065766572/servers/22c91117-08de-4894-9aa9-6ef382400985",
"rel": "self"
},
{
"href": "http://openstack.example.com/6f70656e737461636b20342065766572/servers/22c91117-08de-4894-9aa9-6ef382400985",
"rel": "bookmark"
}
],
"name": "new-server-test"
}
],
"servers_links": [
{
"href": "http://openstack.example.com/v2.1/6f70656e737461636b20342065766572/servers?limit=1&status=error&marker=22c91117-08de-4894-9aa9-6ef382400985",
"rel": "next"
}
]
}

View File

@ -90,5 +90,11 @@
"updated": "2013-09-16T02:55:05Z",
"user_id": "fake"
}
],
"servers_links": [
{
"href": "http://openstack.example.com/v2.1/6f70656e737461636b20342065766572/servers/detail?limit=1&marker=a8c1c13d-ec7e-47c7-b4ff-077f72c1ca46",
"rel": "next"
}
]
}

View File

@ -14,5 +14,11 @@
],
"name": "new-server-test"
}
],
"servers_links": [
{
"href": "http://openstack.example.com/v2.1/6f70656e737461636b20342065766572/servers?limit=1&marker=22c91117-08de-4894-9aa9-6ef382400985",
"rel": "next"
}
]
}

View File

@ -91,5 +91,11 @@
"updated": "2015-12-07T19:54:49Z",
"user_id": "fake"
}
],
"servers_links": [
{
"href": "http://openstack.example.com/v2.1/6f70656e737461636b20342065766572/servers/detail?limit=1&marker=91965362-fd86-4543-8ce1-c17074d2984d",
"rel": "next"
}
]
}

View File

@ -14,5 +14,11 @@
],
"name": "new-server-test"
}
],
"servers_links": [
{
"href": "http://openstack.example.com/v2.1/6f70656e737461636b20342065766572/servers?limit=1&marker=22c91117-08de-4894-9aa9-6ef382400985",
"rel": "next"
}
]
}

View File

@ -88,5 +88,11 @@
"updated": "2013-09-03T04:01:32Z",
"user_id": "fake"
}
],
"servers_links": [
{
"href": "http://openstack.example.com/v2.1/6f70656e737461636b20342065766572/servers/detail?limit=1&marker=f5dc173b-6804-445a-a6d8-c705dad5b5eb",
"rel": "next"
}
]
}

View File

@ -14,5 +14,11 @@
],
"name": "new-server-test"
}
],
"servers_links": [
{
"href": "http://openstack.example.com/v2.1/6f70656e737461636b20342065766572/servers?limit=1&marker=22c91117-08de-4894-9aa9-6ef382400985",
"rel": "next"
}
]
}

View File

@ -3,6 +3,7 @@
"accessIPv4": "1.2.3.4",
"accessIPv6": "80fe::",
"OS-DCF:diskConfig": "AUTO",
"name" : "new-server-test"
"name": "new-server-test",
"description": "Sample description"
}
}
}

View File

@ -12,7 +12,7 @@
]
},
"created": "2012-12-02T02:11:57Z",
"description": null,
"description": "Sample description",
"flavor": {
"disk": 1,
"ephemeral": 0,

View File

@ -96,5 +96,11 @@
"updated": "2017-02-14T19:24:43Z",
"user_id": "fake"
}
],
"servers_links": [
{
"href": "http://openstack.example.com/v2.1/6f70656e737461636b20342065766572/servers/detail?limit=1&marker=764e369e-a874-4401-b7ce-43e4760888da",
"rel": "next"
}
]
}

View File

@ -14,5 +14,11 @@
],
"name": "new-server-test"
}
],
"servers_links": [
{
"href": "http://openstack.example.com/v2.1/6f70656e737461636b20342065766572/servers?limit=1&marker=6e3a87e6-a133-452e-86e1-a31291c1b1c8",
"rel": "next"
}
]
}

View File

@ -92,5 +92,11 @@
"updated": "2017-02-14T19:24:43Z",
"user_id": "fake"
}
],
"servers_links": [
{
"href": "http://openstack.example.com/v2.1/6f70656e737461636b20342065766572/servers/detail?limit=1&marker=764e369e-a874-4401-b7ce-43e4760888da",
"rel": "next"
}
]
}

View File

@ -14,5 +14,11 @@
],
"name": "new-server-test"
}
],
"servers_links": [
{
"href": "http://openstack.example.com/v2.1/6f70656e737461636b20342065766572/servers?limit=1&marker=6e3a87e6-a133-452e-86e1-a31291c1b1c8",
"rel": "next"
}
]
}

View File

@ -3,6 +3,7 @@
"accessIPv4": "1.2.3.4",
"accessIPv6": "80fe::",
"OS-DCF:diskConfig": "AUTO",
"name" : "new-server-test"
"name": "new-server-test",
"description": "Sample description"
}
}
}

View File

@ -12,7 +12,7 @@
]
},
"created": "2012-12-02T02:11:57Z",
"description": null,
"description": "Sample description",
"flavor": {
"disk": 1,
"ephemeral": 0,

View File

@ -91,5 +91,11 @@
"updated": "2017-10-10T15:49:09Z",
"user_id": "fake"
}
],
"servers_links": [
{
"href": "http://openstack.example.com/v2.1/6f70656e737461636b20342065766572/servers/detail?limit=1&marker=569f39f9-7c76-42a1-9c2d-8394e2638a6d",
"rel": "next"
}
]
}
}

View File

@ -89,5 +89,11 @@
"user_id": "fake",
"locked": false
}
],
"servers_links": [
{
"href": "http://openstack.example.com/v2.1/6f70656e737461636b20342065766572/servers/detail?limit=1&marker=f5dc173b-6804-445a-a6d8-c705dad5b5eb",
"rel": "next"
}
]
}

View File

@ -14,5 +14,11 @@
],
"name": "new-server-test"
}
],
"servers_links": [
{
"href": "http://openstack.example.com/v2.1/6f70656e737461636b20342065766572/servers?limit=1&marker=22c91117-08de-4894-9aa9-6ef382400985",
"rel": "next"
}
]
}

View File

@ -66,5 +66,11 @@
"updated": "%(isotime)s",
"user_id": "fake"
}
],
"servers_links": [
{
"href": "%(versioned_compute_endpoint)s/servers/detail?limit=1&marker=%(id)s",
"rel": "next"
}
]
}

View File

@ -14,5 +14,11 @@
],
"name": "new-server-test"
}
],
"servers_links": [
{
"href": "%(versioned_compute_endpoint)s/servers?limit=1&marker=%(id)s",
"rel": "next"
}
]
}

View File

@ -75,5 +75,11 @@
"updated": "%(isotime)s",
"user_id": "fake"
}
],
"servers_links": [
{
"href": "%(versioned_compute_endpoint)s/servers/detail?limit=1&marker=%(id)s",
"rel": "next"
}
]
}

View File

@ -14,5 +14,11 @@
],
"name": "new-server-test"
}
],
"servers_links": [
{
"href": "%(versioned_compute_endpoint)s/servers?limit=1&marker=%(id)s",
"rel": "next"
}
]
}

View File

@ -0,0 +1,24 @@
{
"servers": [
{
"id": "%(id)s",
"links": [
{
"href": "%(versioned_compute_endpoint)s/servers/%(id)s",
"rel": "self"
},
{
"href": "%(compute_endpoint)s/servers/%(id)s",
"rel": "bookmark"
}
],
"name": "new-server-test"
}
],
"servers_links": [
{
"href": "%(versioned_compute_endpoint)s/servers?limit=1&status=%(status)s&marker=%(id)s",
"rel": "next"
}
]
}

View File

@ -84,5 +84,11 @@
"user_id": "fake",
"locked": false
}
],
"servers_links": [
{
"href": "%(versioned_compute_endpoint)s/servers/detail?limit=1&marker=%(id)s",
"rel": "next"
}
]
}

View File

@ -14,5 +14,11 @@
],
"name": "new-server-test"
}
],
"servers_links": [
{
"href": "%(versioned_compute_endpoint)s/servers?limit=1&marker=%(id)s",
"rel": "next"
}
]
}

View File

@ -85,5 +85,11 @@
"user_id": "fake",
"locked": false
}
],
"servers_links": [
{
"href": "%(versioned_compute_endpoint)s/servers/detail?limit=1&marker=%(id)s",
"rel": "next"
}
]
}

View File

@ -14,5 +14,11 @@
],
"name": "new-server-test"
}
],
"servers_links": [
{
"href": "%(versioned_compute_endpoint)s/servers?limit=1&marker=%(id)s",
"rel": "next"
}
]
}

View File

@ -82,5 +82,11 @@
"updated": "%(isotime)s",
"user_id": "fake"
}
],
"servers_links": [
{
"href": "%(versioned_compute_endpoint)s/servers/detail?limit=1&marker=%(id)s",
"rel": "next"
}
]
}

View File

@ -14,5 +14,11 @@
],
"name": "new-server-test"
}
],
"servers_links": [
{
"href": "%(versioned_compute_endpoint)s/servers?limit=1&marker=%(id)s",
"rel": "next"
}
]
}

View File

@ -3,6 +3,7 @@
"accessIPv4": "%(access_ip_v4)s",
"accessIPv6": "%(access_ip_v6)s",
"OS-DCF:diskConfig": "AUTO",
"name" : "new-server-test"
"name": "new-server-test",
"description": "Sample description"
}
}

View File

@ -12,7 +12,7 @@
]
},
"created": "%(isotime)s",
"description": null,
"description": "Sample description",
"flavor": {
"disk": 1,
"ephemeral": 0,

View File

@ -90,5 +90,11 @@
"updated": "%(isotime)s",
"user_id": "fake"
}
],
"servers_links": [
{
"href": "%(versioned_compute_endpoint)s/servers/detail?limit=1&marker=%(id)s",
"rel": "next"
}
]
}

View File

@ -14,5 +14,11 @@
],
"name": "new-server-test"
}
],
"servers_links": [
{
"href": "%(versioned_compute_endpoint)s/servers?limit=1&marker=%(id)s",
"rel": "next"
}
]
}

View File

@ -86,5 +86,11 @@
"updated": "%(isotime)s",
"user_id": "fake"
}
],
"servers_links": [
{
"href": "%(versioned_compute_endpoint)s/servers/detail?limit=1&marker=%(id)s",
"rel": "next"
}
]
}

View File

@ -14,5 +14,11 @@
],
"name": "new-server-test"
}
],
"servers_links": [
{
"href": "%(versioned_compute_endpoint)s/servers?limit=1&marker=%(id)s",
"rel": "next"
}
]
}

View File

@ -3,6 +3,7 @@
"accessIPv4": "%(access_ip_v4)s",
"accessIPv6": "%(access_ip_v6)s",
"OS-DCF:diskConfig": "AUTO",
"name" : "new-server-test"
"name": "new-server-test",
"description": "Sample description"
}
}

View File

@ -12,7 +12,7 @@
]
},
"created": "%(isotime)s",
"description": null,
"description": "Sample description",
"flavor": {
"disk": 1,
"ephemeral": 0,

View File

@ -91,5 +91,11 @@
"updated": "%(isotime)s",
"user_id": "fake"
}
],
"servers_links": [
{
"href": "%(versioned_compute_endpoint)s/servers/detail?limit=1&marker=%(id)s",
"rel": "next"
}
]
}

View File

@ -83,5 +83,11 @@
"user_id": "fake",
"locked": false
}
],
"servers_links": [
{
"href": "%(versioned_compute_endpoint)s/servers/detail?limit=1&marker=%(id)s",
"rel": "next"
}
]
}

View File

@ -14,5 +14,11 @@
],
"name": "new-server-test"
}
],
"servers_links": [
{
"href": "%(versioned_compute_endpoint)s/servers?limit=1&marker=%(id)s",
"rel": "next"
}
]
}

View File

@ -120,7 +120,7 @@ class ServersSampleJsonTest(ServersSampleBase):
def test_servers_list(self):
uuid = self._post_server()
response = self._do_get('servers')
response = self._do_get('servers?limit=1')
subs = {'id': uuid}
self._verify_response('servers-list-resp', subs, response, 200)
@ -128,7 +128,7 @@ class ServersSampleJsonTest(ServersSampleBase):
self.stub_out('nova.db.block_device_mapping_get_all_by_instance_uuids',
fakes.stub_bdm_get_all_by_instance_uuids)
uuid = self.test_servers_post()
response = self._do_get('servers/detail')
response = self._do_get('servers/detail?limit=1')
subs = {}
subs['hostid'] = '[a-f0-9]+'
subs['id'] = uuid
@ -288,7 +288,7 @@ class ServersSampleJson263Test(ServersSampleBase):
def test_servers_details(self):
uuid = self._post_server(use_common_server_api_samples=False)
response = self._do_get('servers/detail')
response = self._do_get('servers/detail?limit=1')
subs = self.common_subs.copy()
subs['id'] = uuid
self._verify_response('servers-details-resp', subs, response, 200)
@ -621,9 +621,9 @@ class ServersSampleMultiStatusJsonTest(ServersSampleBase):
def test_servers_list(self):
uuid = self._post_server()
response = self._do_get('servers?status=active&status=error')
subs = {'id': uuid}
self._verify_response('servers-list-resp', subs, response, 200)
response = self._do_get('servers?limit=1&status=active&status=error')
subs = {'id': uuid, 'status': 'error'}
self._verify_response('servers-list-status-resp', subs, response, 200)
class ServerTriggerCrashDumpJsonTest(ServersSampleBase):