From bb1ef12d93f390e157dc06686f75ea507e2c2856 Mon Sep 17 00:00:00 2001 From: Marc Fiuczynski Date: Tue, 26 May 2009 15:13:35 +0000 Subject: [PATCH] Needed to add documentation for the class definition --- PLC/Methods/GetNodes.py | 1 - PLC/Methods/GetSlices.py | 12 ++++++++++++ 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/PLC/Methods/GetNodes.py b/PLC/Methods/GetNodes.py index f817841e..89812aca 100644 --- a/PLC/Methods/GetNodes.py +++ b/PLC/Methods/GetNodes.py @@ -87,7 +87,6 @@ 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 diff --git a/PLC/Methods/GetSlices.py b/PLC/Methods/GetSlices.py index 22095264..f41dde36 100644 --- a/PLC/Methods/GetSlices.py +++ b/PLC/Methods/GetSlices.py @@ -76,6 +76,18 @@ class v43GetSlices(Method): return slices class v42GetSlices(v43GetSlices): + """ + Returns an array of structs containing details about slices. If + slice_filter is specified and is an array of slice identifiers or + slice names, or a struct of slice attributes, only slices matching + the filter will be returned. If return_fields is specified, only the + specified details will be returned. + + Users may only query slices of which they are members. PIs may + query any of the slices at their sites. Admins and nodes may query + any slice. If a slice that cannot be queried is specified in + slice_filter, details about that slice will not be returned. + """ def call(self, auth, slice_filter = None, return_fields = None): # convert nodenetwork_ids -> interface_ids -- 2.47.0