Merge "Expose is_smartnic in port API"

11 files changed, 53 insertions, 1 deletions

diff --git a/api-ref/regenerate-samples.sh b/api-ref/regenerate-samples.sh
index aebcd5f78..7fad46fed 100755
--- a/api-ref/regenerate-samples.sh
+++ b/api-ref/regenerate-samples.sh
@@ -11,7 +11,7 @@ fi
 OS_AUTH_TOKEN=$(openstack token issue | grep ' id ' | awk '{print $4}')
 IRONIC_URL="http://127.0.0.1:6385"
 
-IRONIC_API_VERSION="1.37"
+IRONIC_API_VERSION="1.53"
 
 export OS_AUTH_TOKEN IRONIC_URL
 
diff --git a/api-ref/source/baremetal-api-v1-nodes-ports.inc b/api-ref/source/baremetal-api-v1-nodes-ports.inc
index 40a7d5e9d..9c8a0386d 100644
--- a/api-ref/source/baremetal-api-v1-nodes-ports.inc
+++ b/api-ref/source/baremetal-api-v1-nodes-ports.inc
@@ -32,6 +32,9 @@ Return a list of bare metal Ports associated with ``node_ident``.
 .. versionadded:: 1.34
   Added the ``physical_network`` field.
 
+.. versionadded:: 1.53
+  Added the ``is_smartnic`` response fields.
+
 Normal response code: 200
 
 Error codes: TBD
@@ -79,6 +82,9 @@ Return a detailed list of bare metal Ports associated with ``node_ident``.
 .. versionadded:: 1.34
   Added the ``physical_network`` field.
 
+.. versionadded:: 1.53
+  Added the ``is_smartnic`` response fields.
+
 Normal response code: 200
 
 Error codes: TBD
@@ -112,6 +118,7 @@ Response
     - created_at: created_at
     - updated_at: updated_at
     - links: links
+    - is_smartnic: is_smartnic
 
 **Example details of a Node's Ports:**
 
diff --git a/api-ref/source/baremetal-api-v1-portgroups-ports.inc b/api-ref/source/baremetal-api-v1-portgroups-ports.inc
index 1f4f2ed36..073bdfde1 100644
--- a/api-ref/source/baremetal-api-v1-portgroups-ports.inc
+++ b/api-ref/source/baremetal-api-v1-portgroups-ports.inc
@@ -25,6 +25,9 @@ Response to include only the specified fields, rather than the default set.
 .. versionadded:: 1.34
   Added the ``physical_network`` field.
 
+.. versionadded:: 1.53
+  Added the ``is_smartnic`` response fields.
+
 Normal response code: 200
 
 Error codes: 400,401,403,404
@@ -66,6 +69,9 @@ Return a detailed list of bare metal Ports associated with ``portgroup_ident``.
 .. versionadded:: 1.34
   Added the ``physical_network`` field.
 
+.. versionadded:: 1.53
+  Added the ``is_smartnic`` response fields.
+
 Normal response code: 200
 
 Error codes: 400,401,403,404
@@ -99,6 +105,7 @@ Response
     - created_at: created_at
     - updated_at: updated_at
     - links: links
+    - is_smartnic: is_smartnic
 
 **Example details of a Portgroup's Ports:**
 
diff --git a/api-ref/source/baremetal-api-v1-ports.inc b/api-ref/source/baremetal-api-v1-ports.inc
index de93d15e5..b7ea31c90 100644
--- a/api-ref/source/baremetal-api-v1-ports.inc
+++ b/api-ref/source/baremetal-api-v1-ports.inc
@@ -46,6 +46,9 @@ By default, this query will return the uuid and address for each Port.
   Added the ``detail`` boolean request parameter. When specified ``True`` this
   causes the response to include complete details about each port.
 
+.. versionadded:: 1.53
+  Added the ``is_smartnic`` field.
+
 Normal response code: 200
 
 Request
@@ -100,6 +103,9 @@ This method requires a Node UUID and the physical hardware address for the Port
 .. versionadded:: 1.34
   Added the ``physical_network`` request and response fields.
 
+.. versionadded:: 1.53
+  Added the ``is_smartnic`` request and response fields.
+
 Normal response code: 201
 
 Request
@@ -114,6 +120,7 @@ Request
     - pxe_enabled: req_pxe_enabled
     - physical_network: req_physical_network
     - extra: req_extra
+    - is_smartnic: req_is_smartnic
 
 **Example Port creation request:**
 
@@ -137,6 +144,7 @@ Response
     - created_at: created_at
     - updated_at: updated_at
     - links: links
+    - is_smartnic: is_smartnic
 
 **Example Port creation response:**
 
@@ -165,6 +173,9 @@ Return a list of bare metal Ports, with detailed information.
 .. versionadded:: 1.34
   Added the ``physical_network`` response field.
 
+.. versionadded:: 1.53
+  Added the ``is_smartnic`` response fields.
+
 Normal response code: 200
 
 Request
@@ -199,6 +210,7 @@ Response
     - created_at: created_at
     - updated_at: updated_at
     - links: links
+    - is_smartnic: is_smartnic
 
 **Example detailed Port list response:**
 
@@ -227,6 +239,9 @@ Show details for the given Port.
 .. versionadded:: 1.34
   Added the ``physical_network`` response field.
 
+.. versionadded:: 1.53
+  Added the ``is_smartnic`` response fields.
+
 Normal response code: 200
 
 Request
@@ -254,6 +269,7 @@ Response
     - created_at: created_at
     - updated_at: updated_at
     - links: links
+    - is_smartnic: is_smartnic
 
 **Example Port details:**
 
@@ -277,6 +293,9 @@ Update a Port.
 .. versionadded:: 1.34
   Added the ``physical_network`` field.
 
+.. versionadded:: 1.53
+  Added the ``is_smartnic`` fields.
+
 Normal response code: 200
 
 Request
@@ -311,6 +330,7 @@ Response
     - created_at: created_at
     - updated_at: updated_at
     - links: links
+    - is_smartnic: is_smartnic
 
 **Example Port update response:**
 
diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml
index 2a4637733..c5f9b80c9 100644
--- a/api-ref/source/parameters.yaml
+++ b/api-ref/source/parameters.yaml
@@ -772,6 +772,12 @@ internal_info:
   in: body
   required: true
   type: JSON
+is_smartnic:
+  description: |
+    Indicates whether the Port is a Smart NIC port.
+  in: body
+  required: false
+  type: boolean
 last_error:
   description: |
     Any error from the most recent (last) transaction that started but failed to finish.
@@ -1178,6 +1184,12 @@ req_inspect_interface:
   in: body
   required: false
   type: string
+req_is_smartnic:
+  description: |
+    Indicates whether the Port is a Smart NIC port.
+  in: body
+  required: false
+  type: boolean
 req_local_link_connection:
   description: |
     The Port binding profile. If specified, must contain ``switch_id`` (only
diff --git a/api-ref/source/samples/node-port-detail-response.json b/api-ref/source/samples/node-port-detail-response.json
index e0f4292bd..4b7a65799 100644
--- a/api-ref/source/samples/node-port-detail-response.json
+++ b/api-ref/source/samples/node-port-detail-response.json
@@ -5,6 +5,7 @@
       "created_at": "2016-08-18T22:28:48.643434+11:11",
       "extra": {},
       "internal_info": {},
+      "is_smartnic": true,
       "links": [
         {
           "href": "http://127.0.0.1:6385/v1/ports/d2b30520-907d-46c8-bfee-c5586e6fb3a1",
diff --git a/api-ref/source/samples/port-create-request.json b/api-ref/source/samples/port-create-request.json
index 8018f8dec..22b6c7ef0 100644
--- a/api-ref/source/samples/port-create-request.json
+++ b/api-ref/source/samples/port-create-request.json
@@ -2,6 +2,7 @@
     "node_uuid": "6d85703a-565d-469a-96ce-30b6de53079d",
     "portgroup_uuid": "e43c722c-248e-4c6e-8ce8-0d8ff129387a",
     "address": "11:11:11:11:11:11",
+    "is_smartnic": true,
     "local_link_connection": {
         "switch_id": "0a:1b:2c:3d:4e:5f",
         "port_id": "Ethernet3/1",
diff --git a/api-ref/source/samples/port-create-response.json b/api-ref/source/samples/port-create-response.json
index ef88e965f..67c5cfd16 100644
--- a/api-ref/source/samples/port-create-response.json
+++ b/api-ref/source/samples/port-create-response.json
@@ -3,6 +3,7 @@
   "created_at": "2016-08-18T22:28:48.643434+11:11",
   "extra": {},
   "internal_info": {},
+  "is_smartnic": true,
   "links": [
     {
       "href": "http://127.0.0.1:6385/v1/ports/d2b30520-907d-46c8-bfee-c5586e6fb3a1",
diff --git a/api-ref/source/samples/port-list-detail-response.json b/api-ref/source/samples/port-list-detail-response.json
index aa99ef743..b62d6bda7 100644
--- a/api-ref/source/samples/port-list-detail-response.json
+++ b/api-ref/source/samples/port-list-detail-response.json
@@ -5,6 +5,7 @@
       "created_at": "2016-08-18T22:28:48.643434+11:11",
       "extra": {},
       "internal_info": {},
+      "is_smartnic": true,
       "links": [
         {
           "href": "http://127.0.0.1:6385/v1/ports/d2b30520-907d-46c8-bfee-c5586e6fb3a1",
diff --git a/api-ref/source/samples/port-update-response.json b/api-ref/source/samples/port-update-response.json
index e0a1e0744..5aacd1b76 100644
--- a/api-ref/source/samples/port-update-response.json
+++ b/api-ref/source/samples/port-update-response.json
@@ -3,6 +3,7 @@
   "created_at": "2016-08-18T22:28:48.643434+11:11",
   "extra": {},
   "internal_info": {},
+  "is_smartnic": true,
   "links": [
     {
       "href": "http://127.0.0.1:6385/v1/ports/d2b30520-907d-46c8-bfee-c5586e6fb3a1",
diff --git a/api-ref/source/samples/portgroup-port-detail-response.json b/api-ref/source/samples/portgroup-port-detail-response.json
index e0f4292bd..4b7a65799 100644
--- a/api-ref/source/samples/portgroup-port-detail-response.json
+++ b/api-ref/source/samples/portgroup-port-detail-response.json
@@ -5,6 +5,7 @@
       "created_at": "2016-08-18T22:28:48.643434+11:11",
       "extra": {},
       "internal_info": {},
+      "is_smartnic": true,
       "links": [
         {
           "href": "http://127.0.0.1:6385/v1/ports/d2b30520-907d-46c8-bfee-c5586e6fb3a1",