Skip to content

Commit

Permalink
Conversion fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Brett Wooldridge committed May 21, 2016
1 parent 8d4bb2f commit 404c354
Show file tree
Hide file tree
Showing 15 changed files with 438 additions and 227 deletions.
3 changes: 0 additions & 3 deletions autogenerated_rst_docs/Appendix_A.rst
Expand Up @@ -74,6 +74,3 @@ Device Adapter IDs
| Paloalto::PA500 \|
| Vyatta::OFR \|
| YAMAHA::RT107e \|
--------------

99 changes: 66 additions & 33 deletions autogenerated_rst_docs/Compliance.rst
@@ -1,19 +1,25 @@
Overview
--------
Compliance
----------

The compliance API provides access to compliance policies, rules, and
violation information.

Compliance Service Methods
--------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~

``Compliance.getRuleSet``
~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^

Get the compliance ruleset for the given ID

Parameters
''''''''''

Get the compliance ruleset for the given ID ##### Parameters \|
Parameter \| Type \| Description \| \| --------- \| ------- \|
----------- \| \| ruleSetId \| Integer \| The ID of the desired RuleSet
object \|
+-------------+-----------+----------------------------------------+
| Parameter | Type | Description |
+=============+===========+========================================+
| ruleSetId | Integer | The ID of the desired RuleSet object |
+-------------+-----------+----------------------------------------+

Return: the ``RuleSet`` object or ``null``
''''''''''''''''''''''''''''''''''''''''''
Expand All @@ -23,11 +29,18 @@ Return: the ``RuleSet`` object or ``null``
<p class="vspacer"></p>

``Compliance.getPolicies``
~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^

Get the list of policies in a given managed networks.

Parameters
''''''''''

Get the list of policies in a given managed networks. ##### Parameters
\| Parameter \| Type \| Description \| \| --------- \| ------------ \|
----------- \| \| network \| UTF-8 String \| The managed network \|
+-------------+----------------+-----------------------+
| Parameter | Type | Description |
+=============+================+=======================+
| network | UTF-8 String | The managed network |
+-------------+----------------+-----------------------+

Return: an array of ``PolicyInfo`` objects
''''''''''''''''''''''''''''''''''''''''''
Expand All @@ -37,11 +50,18 @@ Return: an array of ``PolicyInfo`` objects
<p class="vspacer"></p>

``Compliance.getPolicy``
~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^

Get the policy definition by ID. ##### Parameters \| Parameter \| Type
\| Description \| \| --------- \| ------- \| ----------- \| \| policyId
\| Integer \| The ID of the desired policy \|
Get the policy definition by ID.

Parameters
''''''''''

+-------------+-----------+--------------------------------+
| Parameter | Type | Description |
+=============+===========+================================+
| policyId | Integer | The ID of the desired policy |
+-------------+-----------+--------------------------------+

Return: a ``Policy`` object or ``null``
'''''''''''''''''''''''''''''''''''''''
Expand All @@ -51,13 +71,20 @@ Return: a ``Policy`` object or ``null``
<p class="vspacer"></p>

``Compliance.getViolationsForDevice``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Get the list of current violations for a given device.

Get the list of current violations for a given device. ##### Parameters
\| Parameter \| Type \| Description \| \| --------- \| ------------ \|
----------- \| \| network \| UTF-8 String \| The managed network of the
device \| \| ipAddress \| UTF-8 String \| The IP address of the device
\|
Parameters
''''''''''

+-------------+----------------+-------------------------------------+
| Parameter | Type | Description |
+=============+================+=====================================+
| network | UTF-8 String | The managed network of the device |
+-------------+----------------+-------------------------------------+
| ipAddress | UTF-8 String | The IP address of the device |
+-------------+----------------+-------------------------------------+

Return: an array of ``Violation`` objects
'''''''''''''''''''''''''''''''''''''''''
Expand All @@ -67,12 +94,18 @@ Return: an array of ``Violation`` objects
<p class="vspacer"></p>

``Compliance.getViolationsForPolicy``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Get the list of current violations for a given policy.

Parameters
''''''''''

Get the list of current violations for a given policy. ##### Parameters
\| Parameter \| Type \| Description \| \| --------- \| ------- \|
----------- \| \| policyId \| Integer \| The ID of the desired
violations' policy \|
+-------------+-----------+-------------------------------------------+
| Parameter | Type | Description |
+=============+===========+===========================================+
| policyId | Integer | The ID of the desired violations policy |
+-------------+-----------+-------------------------------------------+

Return: an array of ``Violation`` objects
'''''''''''''''''''''''''''''''''''''''''
Expand All @@ -82,15 +115,15 @@ Return: an array of ``Violation`` objects
<p class="vspacer"></p>

Compliance Objects
------------------
~~~~~~~~~~~~~~~~~~

RuleSet
~~~~~~~
^^^^^^^

+---------------+----------------+----------------------------------------------------------------------+
| Field | Type | Description |
+===============+================+======================================================================+
| ruleSetId | Integer | The rule set's ID |
| ruleSetId | Integer | The rule set ID |
+---------------+----------------+----------------------------------------------------------------------+
| ruleSetName | UTF-8 String | The name of the rule set |
+---------------+----------------+----------------------------------------------------------------------+
Expand All @@ -106,7 +139,7 @@ RuleSet
+---------------+----------------+----------------------------------------------------------------------+

PolicyInfo
~~~~~~~~~~
^^^^^^^^^^

+--------------------+----------------+-------------------------------------------------------------------+
| Field | Type | Description |
Expand All @@ -125,7 +158,7 @@ PolicyInfo
+--------------------+----------------+-------------------------------------------------------------------+

Policy
~~~~~~
^^^^^^

+--------------------+----------------+----------------------------------------------------------------+
| Field | Type | Description |
Expand All @@ -146,7 +179,7 @@ Policy
+--------------------+----------------+----------------------------------------------------------------+

Violation
~~~~~~~~~
^^^^^^^^^

+-------------+----------------+------------------------------------------------------+
| Field | Type | Description |
Expand Down
7 changes: 4 additions & 3 deletions autogenerated_rst_docs/Configuration.rst
@@ -1,5 +1,5 @@
Overview
--------
Configuration
-------------

The configuration API provides the core functionality of retrieving
configuration history and managing draft configurations.
Expand Down Expand Up @@ -305,7 +305,8 @@ Sample Response JSON:

<p class="vspacer"></p>

<!-- ### ``Configuration.retrieveRevisionWordDiff``
Configuration.retrieveRevisionWordDiff
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Retrieve an XML string containing differences marked up in such a way as
to provide simple implementation of highlighting word-level differences.
Expand Down
10 changes: 2 additions & 8 deletions autogenerated_rst_docs/Credentials.rst
@@ -1,5 +1,5 @@
Overview
--------
Credentials
-----------

The credentials API provides the core functionality for device
authentication credentials in Net LineDancer.
Expand Down Expand Up @@ -536,9 +536,3 @@ Sample Request JSON:
"id": 1
}
.. raw:: html

<p class="vspacer"></p>

--------------

0 comments on commit 404c354

Please sign in to comment.