From 11c23cb7b0f3d6df2885c329735a706cff51fe0b Mon Sep 17 00:00:00 2001 From: Kyrylo Romanenko Date: Fri, 7 Jul 2017 18:03:36 +0300 Subject: [PATCH] [trivial] Fix argument descriptions Fix description of arguments for nodes, port, chassis. Change-Id: I9b0c97163ce3a84215309f34f16074140f90f8d1 --- ironic/api/controllers/v1/node.py | 2 +- ironic/objects/chassis.py | 1 + ironic/objects/node.py | 1 + ironic/objects/port.py | 1 + 4 files changed, 4 insertions(+), 1 deletion(-) diff --git a/ironic/api/controllers/v1/node.py b/ironic/api/controllers/v1/node.py index 5f0bcc6195..de0f4abbb2 100644 --- a/ironic/api/controllers/v1/node.py +++ b/ironic/api/controllers/v1/node.py @@ -1197,7 +1197,7 @@ class NodeVIFController(rest.RestController): def post(self, vif): """Attach a VIF to this node - :param vif_info: a dictionary of information about a VIF. + :param vif: a dictionary of information about a VIF. It must have an 'id' key, whose value is a unique identifier for that VIF. """ diff --git a/ironic/objects/chassis.py b/ironic/objects/chassis.py index 3279dceb28..714fb83729 100644 --- a/ironic/objects/chassis.py +++ b/ironic/objects/chassis.py @@ -50,6 +50,7 @@ class Chassis(base.IronicObject, object_base.VersionedObjectDictCompat): def get(cls, context, chassis_id): """Find a chassis based on its id or uuid and return a Chassis object. + :param context: Security context :param chassis_id: the id *or* uuid of a chassis. :returns: a :class:`Chassis` object. """ diff --git a/ironic/objects/node.py b/ironic/objects/node.py index 08ee649834..65f8198a2a 100644 --- a/ironic/objects/node.py +++ b/ironic/objects/node.py @@ -162,6 +162,7 @@ class Node(base.IronicObject, object_base.VersionedObjectDictCompat): def get(cls, context, node_id): """Find a node based on its id or uuid and return a Node object. + :param context: Security context :param node_id: the id *or* uuid of a node. :returns: a :class:`Node` object. """ diff --git a/ironic/objects/port.py b/ironic/objects/port.py index 6e13844150..16c577bacf 100644 --- a/ironic/objects/port.py +++ b/ironic/objects/port.py @@ -66,6 +66,7 @@ class Port(base.IronicObject, object_base.VersionedObjectDictCompat): Find a port based on its id or uuid or MAC address and return a Port object. + :param context: Security context :param port_id: the id *or* uuid *or* MAC address of a port. :returns: a :class:`Port` object. :raises: InvalidIdentity