Design and Public API documentation completed.

The draw.io diagrams are in Gerrit. If the page is ever deleted, they
will be lost. They ae now saved in XML format in gerrit.

The design documentation links to the examples in github rather than
quoting them in the document. General tidy up and cleaning of links,
rewording, and reformatting of desgin document.

Added missing diagram to the Design document.

Updated and tidied up the internal PAP/PDP document.

General improvement of documentation.

Issue-ID: POLICY-1676
Change-Id: Ie5c9f32693f047beafe14a3e412a32cdf9ed6fde
Signed-off-by: liamfallon <liam.fallon@est.tech>

1 files changed, 2 insertions, 0 deletions

diff --git a/docs/architecture/images/TOSCAPolicyConcepts.svg b/docs/architecture/images/TOSCAPolicyConcepts.svg
new file mode 100644
index 00000000..fd8f18e6
--- /dev/null
+++ b/docs/architecture/images/TOSCAPolicyConcepts.svg
@@ -0,0 +1,2 @@
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg xmlns="http://www.w3.org/2000/svg" style="background-color: rgb(255, 255, 255);" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="751px" height="404px" viewBox="-0.5 -0.5 751 404" content="&lt;mxfile modified=&quot;2019-05-29T11:50:25.562Z&quot; host=&quot;wiki.onap.org&quot; agent=&quot;Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:67.0) Gecko/20100101 Firefox/67.0&quot; version=&quot;10.6.3&quot; etag=&quot;HIMId35ezUBr_5G7AN1h&quot; type=&quot;atlas&quot;&gt;&lt;mxAtlasLibraries/&gt;&lt;diagram id=&quot;04337635-102b-1824-bf5a-1496629f81aa&quot; name=&quot;Page-1&quot;&gt;7VttT+M4EP41le4+UOW1Lx9pYfdOYiV0IB18WrmJm1jrxpHrQru//saJnfewKWQD6IKQiMfjsT3PeGY8CRN7vTt+5SgOvzEf04ll+MeJfTWxLNNeuvBHUk4pZWEsUkLAia+YcsId+YkV0VDUA/HxvsQoGKOCxGWix6IIe6JEQ5yz5zLbltHyrDEK1IxGTrjzEMU1tn+JL0K1C7fA/RcmQahnNg3Vs0Hej4CzQ6Tmm1j2NvlJu3dIy1L8+xD57LlAsq8n9pozJtKn3XGNqdStVls67ktLb7ZujiPRZYBexxOiB7X3W0aJd1LLEyetkv0z2VEUQWu1ZZG4Uz0GtL2QUP8GndhBzrkXoAPdWoWMk5/Ajyh0mUCAbi4U4tZMSiOUrhllPJlHqsvyvNLIOylRzcXxHsbe6g2aFdI3dCwx3qC90KtklKJ4TzbJuuXAHeIBiVZMCLZTTHvB2Q9cWI4/28xcucy6ZpWynzAX+FggKU1/xWyHBQdNGrp3rrStToXpzNP2c25jlq14wqJ9GY6ybWXXQSY7xxYeFLwtUJs1qCfWSu6Jsxj2QOSBu1QNuWofb0lEBGERNCgBRVZtAvYtXlRaG7aIkiACGsVbKUCqkMDpu1RkwWIpNkYeiYKbhOfKySn/KM1IEoOxW5ocoZD4Po4k9EwggTaZfcaMRCLRnLuCX1Dw2pi6ExeWtIa2mbfhV7JzsWYR7AqRBGsMRvSMpSE1WEF2gn5tBgp2sPpOqGu+N4FutYAOpzDAUimXCaQc1Jpo52oEuReQXWtAkO02kDkJAswVyqo1HuY+cZ4vhsPZbgvW96cYjwG7/4B9sSgH7CHDtd0pXOftMWJ3PeT2h47Y9hix3wfkISO2PUbsd8N5yIjt1CN2DUVZLoi7B6us6KE0PCkWDhqDmO2+8tppzYy3q8Csx7F7bdZjxvKLjMXpbt2DJCVmW3DCT7Dm70LmocX4ZBl/JD3wEKEd/nN0YU1pafe89B3yEbMtVO29EPsHqgC/Jzv8dyQwB74R5V5QHjIhMZ0Xs87vABBgm0KtT7SijWD3AfagdYQ2sCGz8NPrYwK0l+8XGhQd9vUqw4j2WVFap2A6GA8Ct9sOd7bDEe/firfGdhC8Zy14x5gT5qsEDXSP+MUhImIqIHaPQPcDtDtkqWjemo0DBUlHrgoJsFfcdOMaQX4VyIshS0WLFpBBUpidZnXdGuHtAV7LGDIXW7bAi7w8Ectu00zWAmW5H6VF/hHvPvC2B0zGnKbce0blXnzyBI9BgmCMPbIFCFKY034QXWBpGMW2bawVO8GRfym/koJWxJJ6Wyh2unoGnap2Zlq6mFbhLhbYTEcTvhC56wRh7AdYl+8AvZAFLEL0Oqeu8JGIBz0jPD/KkVNjOUtXUJQVgYofkm5XNx91H4y8hawGYJC304TWcBtTCmAH7ikNaHjT660+9ylNLv5Fu9GFVWNqm4Yqj3BMAawnXJqxyVCUuFuWptlZkXZZLtI6i0rtNV29GpbbW01SVZBpVQSlW35BkGZk2+0el3gS484U0c3e65cPDUduj0khteAgCtbYyTNRtMF0lX16V/Zw8uM7VVBWFttsJfpkNpfXz3ptbJ5pE52dRz2zN6bTehzooE+eurXPodBz9VkxaHUSLiyrPKQfA29Kwmuu2UPylfwGd/bl6tUf9uWw0yfy62f57ofC82PG1s2D23UPrstuZ3hwuJk7/Xjw7BtgXdGrWFtXB36RBadq8eCdPHj9AvJapzOAE5+/mxNvC+xlMC+qSWQ/GNVvER85MPQGUk8YWRWInN8AkX4JX4Ao+9jj8/hxc2oYTsmTT03TLXpzYFiWPLppZa6/mqq/On23GtL3c50/rNTUN/0M+Xk/BlX90F/Pc34ssNyyJHd+ZixQkqpyKgvqx8Trn3p83Eihz+P/LFLol8qfI1L0B1I/GFnLCkTLt0MEzfz/vVL2/J/q7Ov/AA==&lt;/diagram&gt;&lt;/mxfile&gt;"><defs><clipPath id="mx-clip-525-174-220-24-0"><rect x="525" y="174" width="220" height="24"/></clipPath><clipPath id="mx-clip-525-200-220-24-0"><rect x="525" y="200" width="220" height="24"/></clipPath><clipPath id="mx-clip-525-226-220-24-0"><rect x="525" y="226" width="220" height="24"/></clipPath><clipPath id="mx-clip-275-34-220-24-0"><rect x="275" y="34" width="220" height="24"/></clipPath><clipPath id="mx-clip-275-60-220-24-0"><rect x="275" y="60" width="220" height="24"/></clipPath><clipPath id="mx-clip-275-86-220-24-0"><rect x="275" y="86" width="220" height="24"/></clipPath><clipPath id="mx-clip-5-174-220-24-0"><rect x="5" y="174" width="220" height="24"/></clipPath><clipPath id="mx-clip-5-200-220-24-0"><rect x="5" y="200" width="220" height="24"/></clipPath><clipPath id="mx-clip-5-226-220-24-0"><rect x="5" y="226" width="220" height="24"/></clipPath><clipPath id="mx-clip-5-252-220-24-0"><rect x="5" y="252" width="220" height="24"/></clipPath><clipPath id="mx-clip-5-278-220-24-0"><rect x="5" y="278" width="220" height="24"/></clipPath><clipPath id="mx-clip-5-304-220-24-0"><rect x="5" y="304" width="220" height="24"/></clipPath><clipPath id="mx-clip-5-330-220-24-0"><rect x="5" y="330" width="220" height="24"/></clipPath><clipPath id="mx-clip-5-356-220-24-0"><rect x="5" y="356" width="220" height="24"/></clipPath><clipPath id="mx-clip-5-382-220-24-0"><rect x="5" y="382" width="220" height="24"/></clipPath></defs><g><path d="M 520 168 L 520 142 L 750 142 L 750 168" fill="#fff2cc" stroke="#d6b656" stroke-miterlimit="10" pointer-events="none"/><path d="M 520 168 L 520 246 L 750 246 L 750 168" fill="none" stroke="#d6b656" stroke-miterlimit="10" pointer-events="none"/><path d="M 520 168 L 750 168" fill="none" stroke="#d6b656" stroke-miterlimit="10" pointer-events="none"/><g fill="#000000" font-family="Helvetica" text-anchor="middle" font-size="12px"><text x="634.5" y="159.5">Policy</text></g><rect x="520" y="168" width="230" height="26" fill="#fff2cc" stroke="#d6b656" pointer-events="none"/><g fill="#000000" font-family="Helvetica" clip-path="url(#mx-clip-525-174-220-24-0)" font-size="12px"><text x="526.5" y="186.5">+ properties:property definition list</text></g><rect x="520" y="194" width="230" height="26" fill="#fff2cc" stroke="#d6b656" pointer-events="none"/><g fill="#000000" font-family="Helvetica" clip-path="url(#mx-clip-525-200-220-24-0)" font-size="12px"><text x="526.5" y="212.5">+ targets: string[]</text></g><rect x="520" y="220" width="230" height="26" fill="#fff2cc" stroke="#d6b656" pointer-events="none"/><g fill="#000000" font-family="Helvetica" clip-path="url(#mx-clip-525-226-220-24-0)" font-size="12px"><text x="526.5" y="238.5">+ triggers: trigger list</text></g><path d="M 270 28 L 270 2 L 500 2 L 500 28" fill="#fff2cc" stroke="#d6b656" stroke-miterlimit="10" pointer-events="none"/><path d="M 270 28 L 270 106 L 500 106 L 500 28" fill="none" stroke="#d6b656" stroke-miterlimit="10" pointer-events="none"/><path d="M 270 28 L 500 28" fill="none" stroke="#d6b656" stroke-miterlimit="10" pointer-events="none"/><g fill="#000000" font-family="Helvetica" text-anchor="middle" font-size="12px"><text x="384.5" y="19.5">PolicyType</text></g><rect x="270" y="28" width="230" height="26" fill="#fff2cc" stroke="#d6b656" pointer-events="none"/><g fill="#000000" font-family="Helvetica" clip-path="url(#mx-clip-275-34-220-24-0)" font-size="12px"><text x="276.5" y="46.5">+ properties: property definition list</text></g><rect x="270" y="54" width="230" height="26" fill="#fff2cc" stroke="#d6b656" pointer-events="none"/><g fill="#000000" font-family="Helvetica" clip-path="url(#mx-clip-275-60-220-24-0)" font-size="12px"><text x="276.5" y="72.5">+ targets: string[]</text></g><rect x="270" y="80" width="230" height="26" fill="#fff2cc" stroke="#d6b656" pointer-events="none"/><g fill="#000000" font-family="Helvetica" clip-path="url(#mx-clip-275-86-220-24-0)" font-size="12px"><text x="276.5" y="98.5">+ triggers: trigger list</text></g><path d="M 0 168 L 0 142 L 230 142 L 230 168" fill="#fff2cc" stroke="#d6b656" stroke-miterlimit="10" pointer-events="none"/><path d="M 0 168 L 0 246 L 230 246 L 230 168" fill="none" stroke="#d6b656" stroke-miterlimit="10" pointer-events="none"/><path d="M 0 168 L 230 168" fill="none" stroke="#d6b656" stroke-miterlimit="10" pointer-events="none"/><g fill="#000000" font-family="Helvetica" text-anchor="middle" font-size="12px"><text x="114.5" y="159.5">Trigger</text></g><rect x="0" y="168" width="230" height="26" fill="#fff2cc" stroke="#d6b656" pointer-events="none"/><g fill="#000000" font-family="Helvetica" clip-path="url(#mx-clip-5-174-220-24-0)" font-size="12px"><text x="6.5" y="186.5">+ event_type: string (event name)</text></g><rect x="0" y="194" width="230" height="26" fill="#fff2cc" stroke="#d6b656" pointer-events="none"/><g fill="#000000" font-family="Helvetica" clip-path="url(#mx-clip-5-200-220-24-0)" font-size="12px"><text x="6.5" y="212.5">+ schedule: TimeInterval</text></g><rect x="0" y="220" width="230" height="26" fill="#fff2cc" stroke="#d6b656" pointer-events="none"/><g fill="#000000" font-family="Helvetica" clip-path="url(#mx-clip-5-226-220-24-0)" font-size="12px"><text x="6.5" y="238.5">+ target_filter: event filter</text></g><rect x="0" y="246" width="230" height="26" fill="#fff2cc" stroke="#d6b656" pointer-events="none"/><g fill="#000000" font-family="Helvetica" clip-path="url(#mx-clip-5-252-220-24-0)" font-size="12px"><text x="6.5" y="264.5">+ condition: constraint clause</text></g><rect x="0" y="272" width="230" height="26" fill="#fff2cc" stroke="#d6b656" pointer-events="none"/><g fill="#000000" font-family="Helvetica" clip-path="url(#mx-clip-5-278-220-24-0)" font-size="12px"><text x="6.5" y="290.5">+ constraint: constraint clause</text></g><rect x="0" y="298" width="230" height="26" fill="#fff2cc" stroke="#d6b656" pointer-events="none"/><g fill="#000000" font-family="Helvetica" clip-path="url(#mx-clip-5-304-220-24-0)" font-size="12px"><text x="6.5" y="316.5">+ period: scalar-unit.time</text></g><rect x="0" y="324" width="230" height="26" fill="#fff2cc" stroke="#d6b656" pointer-events="none"/><g fill="#000000" font-family="Helvetica" clip-path="url(#mx-clip-5-330-220-24-0)" font-size="12px"><text x="6.5" y="342.5">+ evaluations: integer</text></g><rect x="0" y="350" width="230" height="26" fill="#fff2cc" stroke="#d6b656" pointer-events="none"/><g fill="#000000" font-family="Helvetica" clip-path="url(#mx-clip-5-356-220-24-0)" font-size="12px"><text x="6.5" y="368.5">+ method: string</text></g><rect x="0" y="376" width="230" height="26" fill="#fff2cc" stroke="#d6b656" pointer-events="none"/><g fill="#000000" font-family="Helvetica" clip-path="url(#mx-clip-5-382-220-24-0)" font-size="12px"><text x="6.5" y="394.5">+ action: string or operation</text></g><path d="M 500 12 L 625 12 Q 635 12 635 22 L 635 142" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="none"/><g transform="translate(560.5,-0.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="61" height="24" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 11px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; white-space: nowrap; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;background-color:#ffffff;"><div>specification</div><div>of</div></div></div></foreignObject><text x="31" y="18" fill="#000000" text-anchor="middle" font-size="11px" font-family="Helvetica">[Not supported by viewer]</text></switch></g><g transform="translate(502.5,19.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; white-space: nowrap;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;background-color:#ffffff;">1</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica">1</text></switch></g><g transform="translate(614.5,127.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="18" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; white-space: nowrap; text-align: right;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;background-color:#ffffff;">0..n</div></div></foreignObject><text x="9" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica">0..n</text></switch></g><path d="M 270 93 L 125 93 Q 115 93 115 103 L 115 142" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="none"/><g transform="translate(151.5,80.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="58" height="24" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 11px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; white-space: nowrap; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;background-color:#ffffff;"><div>can be</div><div>triggered by</div></div></div></foreignObject><text x="29" y="18" fill="#000000" text-anchor="middle" font-size="11px" font-family="Helvetica">[Not supported by viewer]</text></switch></g><g transform="translate(242.5,74.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="18" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; white-space: nowrap;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;background-color:#ffffff;">0..n</div></div></foreignObject><text x="9" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica">0..n</text></switch></g><g transform="translate(92.5,125.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="18" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; white-space: nowrap; text-align: right;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;background-color:#ffffff;">0..n</div></div></foreignObject><text x="9" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica">0..n</text></switch></g><path d="M 522 155 L 385 155 Q 375 155 375 154.5 L 375 154.25 Q 375 154 365 154 L 231 154" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="none"/><g transform="translate(381.5,139.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="37" height="11" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 11px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; white-space: nowrap; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;background-color:#ffffff;">triggers</div></div></foreignObject><text x="19" y="11" fill="#000000" text-anchor="middle" font-size="11px" font-family="Helvetica">triggers</text></switch></g><g transform="translate(494.5,136.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="18" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; white-space: nowrap;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;background-color:#ffffff;">0..n</div></div></foreignObject><text x="9" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica">0..n</text></switch></g><g transform="translate(239.5,132.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="18" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; white-space: nowrap; text-align: right;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;background-color:#ffffff;">0..n</div></div></foreignObject><text x="9" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica">0..n</text></switch></g></g></svg>
\ No newline at end of file