Skip to content

Commit

Permalink
Merge pull request #9 from vnitinv/doc-fix-rbac
Browse files Browse the repository at this point in the history
fix indentation for doc generation
  • Loading branch information
Nitin Kr authored May 13, 2020
2 parents 1eea3cf + f938ed1 commit bb81452
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 11 deletions.
11 changes: 8 additions & 3 deletions lib/jnpr/healthbot/modules/administration.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@ def get(self, userid: str = None, user_name: str = None):
:param user_name: Can pass user name if user id is not known
Example:
::
::
from jnpr.healthbot import HealthBotClient
with HealthBotClient('xx.xxx.x.xx', 'xxxx', 'xxxx') as hb:
Expand Down Expand Up @@ -121,6 +122,7 @@ def delete(self, userid: str = None, user_name: str = None):
Example:
::
hb.administration.user.delete(userid ='425453652efwfer')
hb.administration.user.delete(user_name='dummy')
Expand Down Expand Up @@ -216,7 +218,8 @@ def get(self, groupid: str = None, group_name: str = None):
:param group_name: Can pass group name if group id is not known
Example:
::
::
from jnpr.healthbot import HealthBotClient
with HealthBotClient('xx.xxx.x.xx', 'xxxx', 'xxxx') as hb:
Expand Down Expand Up @@ -302,6 +305,7 @@ def delete(self, groupid: str = None, group_name: str = None):
Example:
::
hb.administration.group.delete(groupid ='425453652efwfer')
hb.administration.group.delete(group_name='test')
Expand Down Expand Up @@ -399,7 +403,8 @@ def get(self, role_id: str = None, role_name: str = None):
:param role_name: Can pass role name if role id is not known
Example:
::
::
from jnpr.healthbot import HealthBotClient
with HealthBotClient('xx.xxx.x.xx', 'xxxx', 'xxxx') as hb:
Expand Down
24 changes: 16 additions & 8 deletions lib/jnpr/healthbot/modules/settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,8 @@ def get(self, notification_name: str = None, uncommitted: bool = True):
False restricts data set to only committed changes
Example:
::
::
from jnpr.healthbot import HealthBotClient
with HealthBotClient('xx.xxx.x.xx', 'xxxx', 'xxxx') as hb:
Expand Down Expand Up @@ -205,7 +206,7 @@ def get(
False restricts data set to only committed changes
Example:
::
::
from jnpr.healthbot import HealthBotClient
with HealthBotClient('xx.xxx.x.xx', 'xxxx', 'xxxx') as hb:
Expand Down Expand Up @@ -364,7 +365,7 @@ def get(self, name: str = None, uncommitted: bool = True):
False restricts data set to only committed changes
Example:
::
::
from jnpr.healthbot import HealthBotClient
with HealthBotClient('xx.xxx.x.xx', 'xxxx', 'xxxx') as hb:
Expand Down Expand Up @@ -516,7 +517,8 @@ def get(self, name: str = None, uncommitted: bool = True):
False restricts data set to only committed changes
Example:
::
::
from jnpr.healthbot import HealthBotClient
with HealthBotClient('xx.xxx.x.xx', 'xxxx', 'xxxx') as hb:
Expand Down Expand Up @@ -668,7 +670,8 @@ def get(self, name: str = None, uncommitted: bool = True):
False restricts data set to only committed changes
Example:
::
::
from jnpr.healthbot import HealthBotClient
with HealthBotClient('xx.xxx.x.xx', 'xxxx', 'xxxx') as hb:
Expand Down Expand Up @@ -760,6 +763,7 @@ def delete(self, name: str):
Example:
::
hb.settings.report.delete('xyz')
hb.commit()
Expand Down Expand Up @@ -832,7 +836,8 @@ def get_features(self):
:param license_id: License ID
Example:
::
::
from jnpr.healthbot import HealthBotClient
with HealthBotClient('xx.xxx.x.xx', 'xxxx', 'xxxx') as hb:
Expand All @@ -850,7 +855,8 @@ def get_ids(self):
List of all licence id
Example:
::
::
from jnpr.healthbot import HealthBotClient
with HealthBotClient('xx.xxx.x.xx', 'xxxx', 'xxxx') as hb:
Expand All @@ -870,7 +876,8 @@ def get(self, license_id: str = None):
:param license_id: License ID
Example:
::
::
from jnpr.healthbot import HealthBotClient
with HealthBotClient('xx.xxx.x.xx', 'xxxx', 'xxxx') as hb:
Expand Down Expand Up @@ -918,6 +925,7 @@ def delete(self, license_id: str):
Example:
::
hb.settings.license.delete('xx-xxx-xxx-xxx-xx')
:returns: True when OK
Expand Down

0 comments on commit bb81452

Please sign in to comment.