14 Commits

Author SHA1 Message Date
Hamdy Khader
6325b6c13c Expose is_smartnic in port API
Changes are made to support ironic handling is_smarting port attribute
that was added in this change Ic2ffbd6f1035907ea5a18bda6d2b21e617194195

This change expose is_smartnic port field in REST API, updated API
reference to include is_smartnic field and relevent documentations.

API version updated to 1.53.

Story: #2003346
Change-Id: I89ce54a0c034f2a5f82ff961ab06cfcc6d853bd4
2019-02-10 12:10:00 +02:00
Zuul
231cef47fb Merge "Modify the Ironic api-ref's parameters in parameters.yaml" 2018-06-22 01:39:06 +00:00
Sam Betts
233d7d5727 Add detail=[True, False] query string to API list endpoints
We currently support /[nodes, ports, portgroups, chassis]/detail as an
API endpoint for getting a detailed list of each object. This does not
fit the RESTful and resourceful API design principles of <resource
type>/<resource id> and makes it hard to consume the API from frameworks
that expect that structure. We can't remove the old endpoint, so that is
safeguarded by the restricted node names list. This patch adds a
?detail=[True, False] query string to the list API endpoints to allow
those consuming the API to use the expected URL form.

Change-Id: I694919b4a4eaa3419318bbee1cde79de15e19afa
Story: #1662921
Task: #10176
2018-06-18 19:40:07 +00:00
shuangyang.qian
d0dca903df Modify the Ironic api-ref's parameters in parameters.yaml
Separate parameter identifiers in case when a parameter
is required in the request or response.
This patch adjusts the relevant *.nic file to fix the problem.

Change-Id: Ie2c8cae2280fc1e92a5e6f3fef4f2783a12a2c3f
Story: #1651775
Task: #10160
2018-06-14 10:45:48 +08:00
Sam Betts
bca44bcefc Switch API ref to use versionadded syntax throughout
Sphinx provides the versionadded syntax for indicating version related
changes in documentation, the OpenStack doc theme is designed to handle
this and render it nicely. This patch switches our inconsistent
references to API version related change in the API ref to use this
syntax so that it standardised through out the docs, and is more obvious
in the documentation itself.

Change-Id: Ied6f22deecebd71042d2230b81e057543db3d3f4
2017-09-05 17:27:24 +01:00
Mark Goddard
2e51f95263 Improve ports API reference
Currently there are a few missing fields and API microversion notes
in the ports API reference. This change resolves those issues. All
ports microversion notes have been changed to use the active voice.

Change-Id: If16c8e311e439e88fbbdd693c12e0f7992af5044
2017-07-20 09:13:17 +01:00
Mark Goddard
02fff930fb 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-07-19 17:29:20 +01:00
Vasyl Saienko
0335e81a87 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-16 12:13:53 +02:00
Vladyslav Drok
395069cbef 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-07-27 18:24:25 +00:00
Devananda van der Veen
6d846590bc Follow-up fixes to 206244
This commit is a collection of follow-up fixes to the nits/comments on
https://review.openstack.org/#/c/206244/116

Change-Id: I5631f5df3c0b6a3baa386da8b93b1e888c1f8d3c
2016-07-13 18:12:35 -07:00
Vladyslav Drok
1fbbd14485 Fix nits related to Ports api-ref
This is the followup of 14e48ec273ffb57c1db333f387f5df9d49fa4077.

Change-Id: I8d9ce2807d697ef694af9b8fc2b700cb47bc8d91
2016-06-08 13:25:32 +03:00
Devananda van der Veen
14e48ec273 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-31 18:11:52 +03:00
Devananda van der Veen
6e82b2118a Update the api-ref documentation for Root and Nodes
This updates the API root documentation, which was non-existent,
and the Node documentation significantly, 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.

Change-Id: Iaeb1c80ac0655fc0d73fa495ed43e3c02b345495
2016-05-20 08:35:29 -07:00
Jim Rollenhagen
fa098f69e4 Migrate api-ref into our tree
Per this email[0], it's time to migrate our API docs into our tree.

This copies the sphinx extension from nova into our tree as well, which
will be later split into its own python module. At that time we can cut
over to the module and drop it from our tree.

The conf.py and the tox environment are also cribbed from nova.

[0] http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html

Change-Id: I683cc4d6459d77c42951a06247b6f9ff8f8456bd
2016-05-03 21:39:42 +00:00