make sure GetNodes has a doc section
authorMarc Fiuczynski <mef@cs.princeton.edu>
Fri, 22 May 2009 03:54:35 +0000 (03:54 +0000)
committerMarc Fiuczynski <mef@cs.princeton.edu>
Fri, 22 May 2009 03:54:35 +0000 (03:54 +0000)
PLC/Methods/GetNodes.py

index d36b3ca..29c4ccb 100644 (file)
@@ -87,6 +87,17 @@ node_fields = Node.fields.copy()
 node_fields['nodenetwork_ids']=Parameter([int], "Legacy version of interface_ids")
 
 class v42GetNodes(v43GetNodes):
+    # XXX is there a way to inherit the doc from v43GetNodes?
+    """
+    Returns an array of structs containing details about nodes. If
+    node_filter is specified and is an array of node identifiers or
+    hostnames, or a struct of node attributes, only nodes matching the
+    filter will be returned. If return_fields is specified, only the
+    specified details will be returned.
+
+    Some fields may only be viewed by admins.
+    """
+
     accepts = [
         Auth(),
         Mixed([Mixed(Node.fields['node_id'],