starlingx/config
Code Issues Proposed changes

Modify Api-ref for max_tx_rate/max_rx_rate

Browse Source 
Interfaces APIs have been modified to handle max_tx_rate
and max_rx_rate params for rate-limiting platform traffic.

This commit ensures the same API params are mentioned in the
doc.

Test Plan:
PASSED: Render html docs with zuul and verify max_tx_rate/rx_rate
        are shown properly in relevant "iinterfaces" APIs.

Story: 2011350
Task: 52373

Change-Id: I860ed086c51ded3444ff5fba67b0057b5652070c
Signed-off-by: Aman Pandae <AmanPandae.Mothukuri@windriver.com>
This commit is contained in:
Aman Pandae
2025-06-11 06:20:23 -04:00
parent 271f611a2d
commit 0be7b290e5
3 changed files with 24 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
api-ref/source/api-ref-sysinv-v1-config.rst
View File

@@ -2600,7 +2600,8 @@ itemNotFound (404)
"updated_at (Optional)", "plain", "xsd:dateTime", "The time when the object was last updated." "updated_at (Optional)", "plain", "xsd:dateTime", "The time when the object was last updated."
"uses (Optional)", "plain", "xsd:list", "Interfaces which the current interface uses." "uses (Optional)", "plain", "xsd:list", "Interfaces which the current interface uses."
"used_by (Optional)", "plain", "xsd:list", "Interfaces which use the current interface." "used_by (Optional)", "plain", "xsd:list", "Interfaces which use the current interface."
"max_tx_rate (Optional)", "plain", "xsd:integer", "The Maximum Transmission Rate of the interface, in Mbps. Only applicable if ``ifclass : pci-sriov`` and ``iftype : vf``" "max_tx_rate (Optional)", "plain", "xsd:integer", "The Maximum Transmission Rate of the interface, in Mbps. Only applicable for combinations - ``ifclass : pci-sriov`` and ``iftype : vf`` or ``ifclass : platform`` and ``iftype : VLAN/AE/Ethernet``."
"max_rx_rate (Optional)", "plain", "xsd:integer", "The Maximum Reception Rate of the interface, in Mbps. Only applicable if ``ifclass : platform`` and ``iftype : VLAN/AE/Ethernet``."
:: ::
@@ -2629,8 +2630,10 @@ itemNotFound (404)
"vlan_id": null, "vlan_id": null,
"imtu": 1500, "imtu": 1500,
"aemode": null, "aemode": null,
"ifclass": "platform" "ifclass": "platform",
"ifname": "eth1" "ifname": "eth1",
"max_tx_rate": 30,
"max_rx_rate": 30,
}, },
{ {
"forihostid": 2, "forihostid": 2,
@@ -2716,7 +2719,8 @@ itemNotFound (404)
"ports (Optional)", "plain", "xsd:list", "URIs to the physical ports of this interface." "ports (Optional)", "plain", "xsd:list", "URIs to the physical ports of this interface."
"uses (Optional)", "plain", "xsd:list", "Interfaces which the current interface uses." "uses (Optional)", "plain", "xsd:list", "Interfaces which the current interface uses."
"used_by (Optional)", "plain", "xsd:list", "Interfaces which use the current interface." "used_by (Optional)", "plain", "xsd:list", "Interfaces which use the current interface."
"max_tx_rate (Optional)", "plain", "xsd:integer", "The Maximum Transmission Rate of the interface, in Mbps. Only applicable if ``ifclass : pci-sriov`` and ``iftype : vf``" "max_tx_rate (Optional)", "plain", "xsd:integer", "The Maximum Transmission Rate of the interface, in Mbps. Only applicable for combinations - ``ifclass : pci-sriov`` and ``iftype : vf`` or ``ifclass : platform`` and ``iftype : VLAN/AE/Ethernet``."
"max_rx_rate (Optional)", "plain", "xsd:integer", "The Maximum Reception Rate of the interface, in Mbps. Only applicable if ``ifclass : platform`` and ``iftype : VLAN/AE/Ethernet``."
"uuid (Optional)", "plain", "csapi:UUID", "The universally unique identifier for this object." "uuid (Optional)", "plain", "csapi:UUID", "The universally unique identifier for this object."
"links (Optional)", "plain", "xsd:list", "For convenience, resources contain links to themselves. This allows a client to easily obtain rather than construct resource URIs. The following types of link relations are associated with resources: a self link containing a versioned link to the resource, and a bookmark link containing a permanent link to a resource that is appropriate for long term storage." "links (Optional)", "plain", "xsd:list", "For convenience, resources contain links to themselves. This allows a client to easily obtain rather than construct resource URIs. The following types of link relations are associated with resources: a self link containing a versioned link to the resource, and a bookmark link containing a permanent link to a resource that is appropriate for long term storage."
"created_at (Optional)", "plain", "xsd:dateTime", "The time when the object was created." "created_at (Optional)", "plain", "xsd:dateTime", "The time when the object was created."
@@ -2806,7 +2810,8 @@ badMediaType (415)
"used_by (Optional)", "plain", "xsd:list", "This attribute specifies a comma-separated list of interfaces that use this interface." "used_by (Optional)", "plain", "xsd:list", "This attribute specifies a comma-separated list of interfaces that use this interface."
"imtu (Optional)", "plain", "xsd:integer", "This attribute specifies the interface's Maximum Transmit Unit." "imtu (Optional)", "plain", "xsd:integer", "This attribute specifies the interface's Maximum Transmit Unit."
"sriov_numvfs (Optional)", "plain", "xsd:integer", "The number of VFs to configure on the interface's port; only applicable if ``ifclass : pci-sriov`` where only a single port is associated with the interface." "sriov_numvfs (Optional)", "plain", "xsd:integer", "The number of VFs to configure on the interface's port; only applicable if ``ifclass : pci-sriov`` where only a single port is associated with the interface."
"max_tx_rate (Optional)", "plain", "xsd:integer", "The Maximum Transmission Rate of the interface, in Mbps. Only applicable if ``ifclass : pci-sriov`` and ``iftype : vf``" "max_tx_rate (Optional)", "plain", "xsd:integer", "The Maximum Transmission Rate of the interface, in Mbps. Only applicable for combinations - ``ifclass : pci-sriov`` and ``iftype : vf`` or ``ifclass : platform`` and ``iftype : VLAN/AE/Ethernet``."
"max_rx_rate (Optional)", "plain", "xsd:integer", "The Maximum Reception Rate of the interface, in Mbps. Only applicable if ``ifclass : platform`` and ``iftype : VLAN/AE/Ethernet``."
"ihost_uuid (Optional)", "plain", "csapi:UUID", "The UUID of the host to create the interface on." "ihost_uuid (Optional)", "plain", "csapi:UUID", "The UUID of the host to create the interface on."
**Response parameters** **Response parameters**
@@ -2832,7 +2837,8 @@ badMediaType (415)
"ports (Optional)", "plain", "xsd:list", "URIs to the physical ports of this interface." "ports (Optional)", "plain", "xsd:list", "URIs to the physical ports of this interface."
"uses (Optional)", "plain", "xsd:list", "Interfaces which the current interface uses." "uses (Optional)", "plain", "xsd:list", "Interfaces which the current interface uses."
"used_by (Optional)", "plain", "xsd:list", "Interfaces which use the current interface." "used_by (Optional)", "plain", "xsd:list", "Interfaces which use the current interface."
"max_tx_rate (Optional)", "plain", "xsd:integer", "The Maximum Transmission Rate of the interface, in Mbps. Only applicable if ``ifclass : pci-sriov`` and ``iftype : vf``" "max_tx_rate (Optional)", "plain", "xsd:integer", "The Maximum Transmission Rate of the interface, in Mbps. Only applicable for combinations - ``ifclass : pci-sriov`` and ``iftype : vf`` or ``ifclass : platform`` and ``iftype : VLAN/AE/Ethernet``."
"max_rx_rate (Optional)", "plain", "xsd:integer", "The Maximum Reception Rate of the interface, in Mbps. Only applicable if ``ifclass : platform`` and ``iftype : VLAN/AE/Ethernet``."
"uuid (Optional)", "plain", "csapi:UUID", "The universally unique identifier for this object." "uuid (Optional)", "plain", "csapi:UUID", "The universally unique identifier for this object."
"links (Optional)", "plain", "xsd:list", "For convenience, resources contain links to themselves. This allows a client to easily obtain rather than construct resource URIs. The following types of link relations are associated with resources: a self link containing a versioned link to the resource, and a bookmark link containing a permanent link to a resource that is appropriate for long term storage." "links (Optional)", "plain", "xsd:list", "For convenience, resources contain links to themselves. This allows a client to easily obtain rather than construct resource URIs. The following types of link relations are associated with resources: a self link containing a versioned link to the resource, and a bookmark link containing a permanent link to a resource that is appropriate for long term storage."
"created_at (Optional)", "plain", "xsd:dateTime", "The time when the object was created." "created_at (Optional)", "plain", "xsd:dateTime", "The time when the object was created."
@@ -2939,7 +2945,8 @@ badMediaType (415)
"used_by (Optional)", "plain", "xsd:list", "This attribute specifies a comma-separated list of interfaces that use this interface." "used_by (Optional)", "plain", "xsd:list", "This attribute specifies a comma-separated list of interfaces that use this interface."
"imtu (Optional)", "plain", "xsd:integer", "This attribute specifies the interface's Maximum Transmit Unit." "imtu (Optional)", "plain", "xsd:integer", "This attribute specifies the interface's Maximum Transmit Unit."
"sriov_numvfs (Optional)", "plain", "xsd:integer", "The number of VFs to configure on the interface's port; only applicable if ``ifclass : pci-sriov`` where only a single port is associated with the interface." "sriov_numvfs (Optional)", "plain", "xsd:integer", "The number of VFs to configure on the interface's port; only applicable if ``ifclass : pci-sriov`` where only a single port is associated with the interface."
"max_tx_rate (Optional)", "plain", "xsd:integer", "The Maximum Transmission Rate of the interface, in Mbps. Only applicable if ``ifclass : pci-sriov`` and ``iftype : vf``" "max_tx_rate (Optional)", "plain", "xsd:integer", "The Maximum Transmission Rate of the interface, in Mbps. Only applicable for combinations - ``ifclass : pci-sriov`` and ``iftype : vf`` or ``ifclass : platform`` and ``iftype : VLAN/AE/Ethernet``."
"max_rx_rate (Optional)", "plain", "xsd:integer", "The Maximum Reception Rate of the interface, in Mbps. Only applicable if ``ifclass : platform`` and ``iftype : VLAN/AE/Ethernet``."
**Response parameters** **Response parameters**
@@ -2964,7 +2971,8 @@ badMediaType (415)
"ports (Optional)", "plain", "xsd:list", "URIs to the physical ports of this interface." "ports (Optional)", "plain", "xsd:list", "URIs to the physical ports of this interface."
"uses (Optional)", "plain", "xsd:list", "Interfaces which the current interface uses." "uses (Optional)", "plain", "xsd:list", "Interfaces which the current interface uses."
"used_by (Optional)", "plain", "xsd:list", "Interfaces which use the current interface." "used_by (Optional)", "plain", "xsd:list", "Interfaces which use the current interface."
"max_tx_rate (Optional)", "plain", "xsd:integer", "The Maximum Transmission Rate of the interface, in Mbps. Only applicable if ``ifclass : pci-sriov`` and ``iftype : vf``" "max_tx_rate (Optional)", "plain", "xsd:integer", "The Maximum Transmission Rate of the interface, in Mbps. Only applicable for combinations - ``ifclass : pci-sriov`` and ``iftype : vf`` or ``ifclass : platform`` and ``iftype : VLAN/AE/Ethernet``."
"max_rx_rate (Optional)", "plain", "xsd:integer", "The Maximum Reception Rate of the interface, in Mbps. Only applicable if ``ifclass : platform`` and ``iftype : VLAN/AE/Ethernet``."
"uuid (Optional)", "plain", "csapi:UUID", "The universally unique identifier for this object." "uuid (Optional)", "plain", "csapi:UUID", "The universally unique identifier for this object."
"links (Optional)", "plain", "xsd:list", "For convenience, resources contain links to themselves. This allows a client to easily obtain rather than construct resource URIs. The following types of link relations are associated with resources: a self link containing a versioned link to the resource, and a bookmark link containing a permanent link to a resource that is appropriate for long term storage." "links (Optional)", "plain", "xsd:list", "For convenience, resources contain links to themselves. This allows a client to easily obtain rather than construct resource URIs. The following types of link relations are associated with resources: a self link containing a versioned link to the resource, and a bookmark link containing a permanent link to a resource that is appropriate for long term storage."
"created_at (Optional)", "plain", "xsd:dateTime", "The time when the object was created." "created_at (Optional)", "plain", "xsd:dateTime", "The time when the object was created."

2
api-ref/source/conf.py
View File

@@ -50,7 +50,7 @@ source_suffix = '.rst'
master_doc = 'index' master_doc = 'index'
# General information about the project. # General information about the project.
openstackdocs_repo_name = 'openstack/stx-config' openstackdocs_repo_name = 'starlingx/stx-config'
openstackdocs_auto_name = False openstackdocs_auto_name = False
project = u'StarlingX Configuration' project = u'StarlingX Configuration'
openstackdocs_bug_project = 'starlingx' openstackdocs_bug_project = 'starlingx'

9
doc/requirements.txt
View File

@@ -1,3 +1,8 @@
openstackdocstheme>=2.2.1,<3.4 # Apache-2.0 sphinx>=2.0.0,!=2.1.0 # BSD
os-api-ref>=1.4.0 # Apache-2.0 openstackdocstheme>=2.2.1 # Apache-2.0
# Release Notes
reno>=3.1.0 # Apache-2.0 reno>=3.1.0 # Apache-2.0
# API Reference Guide
os-api-ref>=1.4.0 # Apache-2.0