openstack/ironic
Code Issues Proposed changes
1a07137118
ironic/api-ref/source/samples/port-create-request.json

12 lines
341 B
JSON
Raw Normal View History

Update the api-ref documentation for Ports This updates the API documentation for the Ports resource class, replacing many of the samples and adding more verbiage to each property. It's not perfect, but this is vastly more correct than the current docs. Co-Authored-By: Vladyslav Drok <vdrok@mirantis.com> Change-Id: I559ef1e921aa8e2f2f1a8bd6ed18e0a39ecc4687
2016-05-05 16:22:45 -07:00
{
Update api-ref for v1.22 This commit does several things, which were just easier to do together. - Adds a new "misc" page describing the /v1/lookup and /v1/heartbeat resources. - Adds descriptions of the node.resource_class and node.network_interface fields that were introduced into the API but not into the documentation. - Introduces a new script, api-ref/regenerate-samples.sh, which can be used with Ironic to automate the generation of most of the sample files used in the api-ref documententation. - Corrects several errors in the sample JSON files that rendered errors when using them with curl for POST, PUT, or PATCH. - Uses the aforementioned regenerate-samples.sh script to regenerate most of the JSON result samples, ensuring that they are all up to date with the v1.22 API microversion. - Removes a few old/incorrect "Error Code" listings. - Updates the index page to remove extraneous wording. Change-Id: I764cbb43be15f05ba681de6ce1be1ae7c022173d
2016-08-09 14:36:08 -07:00
"node_uuid": "6d85703a-565d-469a-96ce-30b6de53079d",
Add portgroup to api-ref This patch updates api-ref documentations to reflect portgroup changes. Related-Bug: #1618754 Co-Authored-By: Vladyslav Drok <vdrok@mirantis.com> Change-Id: Id34344df9d3e68efe891c2be4a0b362be6557202
2016-11-04 18:04:33 +02:00
"portgroup_uuid": "e43c722c-248e-4c6e-8ce8-0d8ff129387a",
Add api-ref for new port fields API microversions 1.18, 1.19 introduced new fields in Port resource, this change adds them to api-ref documentation. Partial-bug: #1526403 Change-Id: Ib7059fd1ec8ffc54fa34647cc558fb8c8e80f8d7
2016-06-03 16:32:55 +03:00
"address": "11:11:11:11:11:11",
"local_link_connection": {
"switch_id": "0a:1b:2c:3d:4e:5f",
"port_id": "Ethernet3/1",
"switch_info": "switch1"
Expose ports' physical network attribute in API In change Ib22753aa6ae0fedce7fb9ecf63f135fda0185c5b the port data model was updated to include a physical_network field, but this was not exposed to the user by the REST API. This change exposes the physical_network field in the REST API. The port CRUD notification object has been updated to include the physical_network field. The API reference and user guide have been updated to include information about the ports' physical network field. The API microversion has been bumped to 1.34. During a rolling upgrade from Ocata when the API service is pinned, the port physical network field is hidden from API responses, and API requests including the field are rejected. Change-Id: I7023a1d6618608c867c31396fa677d3016ca493e Partial-Bug: #1666009
2017-06-01 15:36:58 +01:00
},
"physical_network": "physnet1"
Add portgroup to api-ref This patch updates api-ref documentations to reflect portgroup changes. Related-Bug: #1618754 Co-Authored-By: Vladyslav Drok <vdrok@mirantis.com> Change-Id: Id34344df9d3e68efe891c2be4a0b362be6557202
2016-11-04 18:04:33 +02:00
}
Copy Permalink