diff options
| author |   liamfallon <liam.fallon@est.tech> | 2021-10-11 11:57:31 +0100 |
|---|---|---|
| committer | liamfallon <liam.fallon@est.tech> | 2021-10-12 13:53:44 +0100 |
| commit | 40f09542ef0fcbb652a96ac8bd3f691c5a72cc83 (patch) | |
| tree | 1360a91aa1e1ee5d8866c32e87d55c6ae1de9296 /docs/development/pdp | |
| parent | 196eb6f1bb30ae7820815e3fa1e574da4e3d1554 (diff) | |
Fix warnings in PF documentation generation
Geeneration of documents in the Policy Framework issued many warnings,
for example missing links, hanging references, unreferenced pages and
missing swagger, as well as bad formatting for code blocks.
This commit cleans up all the warnings.
Issue-ID: POLICY-3337
Change-Id: I20db6ff76cfb58a603317f5faf20c7479b77c13b
Signed-off-by: liamfallon <liam.fallon@est.tech>
Diffstat (limited to 'docs/development/pdp')
| -rw-r--r-- | docs/development/pdp/pdp-pap-interaction.rst | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/development/pdp/pdp-pap-interaction.rst b/docs/development/pdp/pdp-pap-interaction.rst index 45988192..14a92517 100644 --- a/docs/development/pdp/pdp-pap-interaction.rst +++ b/docs/development/pdp/pdp-pap-interaction.rst @@ -37,7 +37,7 @@ Some of the information included in the message are: - *name* a name that is unique to the PDP instance. -.. code-block:: json +.. code-block:: :caption: Sample PDP_STATUS Registration message (from APEX-PDP) :linenos: @@ -86,7 +86,7 @@ If so, it updates itself with the information in PDP_UPDATE message from PAP suc *pdpHeartbeatIntervalMs* and *policiesToBeDeployed* (if any). After handling the PDP_UPDATE message, the PDP sends a response message back to PAP with the current status of the PDP along with the result of the PDP_UPDATE operation. -.. code-block:: json +.. code-block:: :caption: Sample PDP_STATUS response message (from APEX-PDP) :linenos: @@ -144,7 +144,7 @@ then it waits in ACTIVE state, ready to execute any policies as and when they ar to them from PAP. After handling the PDP_STATE_CHANGE message, the PDP sends a response message back to PAP with the current status of the PDP along with the result of the PDP_STATE_CHANGE operation. -.. code-block:: json +.. code-block:: :caption: Sample PDP_STATUS response message (from APEX-PDP) :linenos: @@ -178,7 +178,7 @@ with the data in the database, PAP sends out a PDP_UPDATE message to update the PAP considers a PDP as expired if three consecutive heartbeats are missing from the PDP, and removes the PDP instance details from the database. -.. code-block:: json +.. code-block:: :caption: Sample PDP_STATUS response message (from APEX-PDP) :linenos: @@ -212,7 +212,7 @@ PAP sends a PDP_UPDATE message with information about policies to be deployed an undeployed. If there are some policies that are already deployed, then only the new ones are sent under the *policiesToBeDeployed* field. -.. code-block:: json +.. code-block:: :caption: Sample PDP_STATUS response message (from APEX-PDP) :linenos: |