Comments (0)

Files changed (1)

File fom/api.py Modified

View file
  • Ignore whitespace
  • Hide word diff
 class UserApi(ApiBase):
     """API component for a single user.
 
-    http://api.fluidinfo.com/fluidDB/api/*/users/*
+    .. seealso:: `<http://api.fluidinfo.com/fluidDB/api/*/users/*>`_
     """
     root_path = '/users'
 
     def get(self):
         """Return information about the user.
 
-        http://api.fluidinfo.com/fluidDB/api/*/users/GET
+        .. seealso:: `<http://api.fluidinfo.com/fluidDB/api/*/users/GET>`_
         """
         return self('GET', self.username)
 
     def put(self, value, value_type=None):
         """Call PUT on an individual object's tag.
 
-        http://api.fluidinfo.com/fluidDB/api/*/objects/PUT
+        .. seealso:: `<http://api.fluidinfo.com/fluidDB/api/*/objects/PUT>`_
         """
         return self('PUT', self.path, payload=value, content_type=value_type)
 
 class ObjectApi(ApiBase):
     """API component for a single object.
 
-    http://api.fluidinfo.com/fluidDB/api/*/objects/*
+    .. seealso:: `<http://api.fluidinfo.com/fluidDB/api/*/objects/*>`_
     """
 
     root_path = '/objects'
     def get(self, showAbout=False):
         """Call GET on an individual object.
 
-        http://api.fluidinfo.com/fluidDB/api/*/objects/GET
+        .. seealso:: `<http://api.fluidinfo.com/fluidDB/api/*/objects/GET>`_
         """
         return self('GET', self.uid, urlargs={'showAbout':showAbout})
 
     def get(self, query):
         """Call GET on the /objects toplevel
 
-        http://api.fluidinfo.com/fluidDB/api/*/objects/GET
+        .. seealso:: `<http://api.fluidinfo.com/fluidDB/api/*/objects/GET>`_
         """
         return self('GET', urlargs={'query': query})
 
     >>> ns_api = NamespaceApi('fluiddb', db) # api for the fluiddb namespace
     >>> ns_api.get(returnDescription=True)
 
-    `<http://api.fluidinfo.com/fluidDB/api/*/namespaces/*>`_
+    .. seealso:: `<http://api.fluidinfo.com/fluidDB/api/*/namespaces/*>`_
     """
 
     root_path = '/namespaces'
         """
         Call GET on the namespaces to fetch information about it.
 
-        http://api.fluidinfo.com/fluidDB/api/*/namespaces/GET
+        .. seealso:: `<http://api.fluidinfo.com/fluidDB/api/*/namespaces/GET>`_
         """
         urlargs = {
             'returnDescription': returnDescription,
         """
         Call POST on the namespace to create a new child namespace.
 
-        http://api.fluidinfo.com/fluidDB/api/*/namespaces/POST
+        .. seealso:: `<http://api.fluidinfo.com/fluidDB/api/*/namespaces/POST>`_
         """
         return self('POST', self.path, {'name':name, 'description':description})
 
         """
         Call DELETE on the namespace to delete it.
 
-        http://api.fluidinfo.com/fluidDB/api/*/namespaces/DELETE
+        .. seealso:: `<http://api.fluidinfo.com/fluidDB/api/*/namespaces/DELETE>`_
         """
         return self('DELETE', self.path)
 
         """
         Call PUT on ther namespace to update its description.
 
-        http://api.fluidinfo.com/fluidDB/api/*/namespaces/PUT
+        .. seealso `<http://api.fluidinfo.com/fluidDB/api/*/namespaces/PUT>`_
         """
         return self('PUT', self.path, {u'description': description})
 
     .. attribute:: policies
 
         A bound instance of :class:`fom.api.PoliciesApi`
-
     """
 
     root_path = ''