summaryrefslogtreecommitdiffstats
path: root/docs/xacml
AgeCommit message (Collapse)AuthorFilesLines
2023-04-04Update Policy Offered APIslapentafd1-2/+4
Swagger documentation rendered in ReDoc webpage. The html page is generated during the Sphinx build. The sphinx.builders.linkcheck reports as false positives the links that are generated dynamically, such as with the sphinxcontrib-redoc extension. Issue-ID: POLICY-4581 Change-Id: I9b720b961332689b144d5fe9d8be82be436d1c16 Signed-off-by: lapentafd <francesco.lapenta@est.tech>
2022-11-01Fix doc config files and dead linksliamfallon1-2/+2
Documentation config fixed as instructed. Configuration files have been copied from examples provided by the documentation project. Dead links are fixed as well, they cause build fails now. Issue-ID: POLICY-4426 Change-Id: Ied5ca5e5a24f7a625e5b2d94c46d0c2347c68ace Signed-off-by: liamfallon <liam.fallon@est.tech>
2022-10-07Updating documentation for Docker components in XACML Custom Application ↵isaac1-21/+2
Tutorial. Issue-ID: POLICY-4316 Signed-off-by: isaac <isaac.adorno@att.com> Change-Id: I7d4befac48cbf251ad9b1bae6f1e60f4a5c3b393
2021-10-12Fix warnings in PF documentation generationliamfallon1-2/+2
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>
2021-09-30Document removal of xacml-pdp API limitationliamfallon1-0/+4
In the Honolulu Maintenance release the decision API is always running In Istanbul the: REST server is always running (i.e., the port is always responsive), but the decision API is enabled/disabled by PDP-STATE-CHANGE messages from PAP. Jim Hahn asked me to document this. Issue-ID: POLICY-3556 Change-Id: I6eee0b2f3d1e03b09dda7e14e3fa528826dc0d2b Signed-off-by: liamfallon <liam.fallon@est.tech>
2021-07-21Update xacml docs returning attributesDragosh, Pamela (pd1248)2-5/+5
Update the documentation to refer to examples and tutorials regarding the use of attributes along with obligations and advice. Issue-ID: POLICY-2865 Change-Id: I048b2e19f9ca4fdbf50e18d2b64299023b4af2bb Signed-off-by: Dragosh, Pamela (pd1248) <pd1248@att.com>
2021-07-20Merge "Add profile for generating Swagger documents"Liam Fallon1-2/+2
2021-07-19Add profile for generating Swagger documentsliamfallon1-2/+2
This commit adds a profile for generating Swagger documents and creating a tarball containing the swagger.json, swagger.html, and swagger.pdf files. The profile is triggered in any module when tsts are enabled (In other words when the skipTests flag is off), and when the following proerty is set: <swagger.generation.phase>post-integration-test</swagger.generation.phase> This profile assumes that a unit test exists that creates the following file: target/swagger/swagger.json If this file does not exist, the build will fail if the profile is invoked. Therefore, to generate the Swagger documentation tarball, a module must set the swagger.generation.phase propety AND have a unit test that generates the swagger.json file. Issue-ID: POLICY-3424 Change-Id: I8ff769e7a28bf0e00969d1bc677fee6908951d8a Signed-off-by: liamfallon <liam.fallon@est.tech>
2021-07-19Add documentation on excluding xacml applicationsDragosh, Pamela (pd1248)1-0/+13
Issue-ID: POLICY-3326 Change-Id: If097e1f85f0e7b9d85bcff678c14ffa1644db407 Signed-off-by: Dragosh, Pamela (pd1248) <pd1248@att.com>
2020-10-29Update Tutorial DocumentationPamela Dragosh28-1623/+320
Point to actual code and remove the eclipse instructions as developers should look elsewhere for these instructions. Adding enforcement tutorial. Issue-ID: POLICY-2876 Change-Id: I793c1fae72f832afe7098be57a94f4929e9deb9a Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
2020-08-25Add Match documentationPamela Dragosh5-0/+91
Adding documentation for new Match Policy Type. Issue-ID: POLICY-2596 Change-Id: I97b033b345ae40e4684d5572d47132c304c735b9 Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
2020-08-21Add guard filter documentationPamela Dragosh5-0/+177
Added guard filter to documentation and expanded doc on the other filters. Issue-ID: POLICY-2590 Change-Id: I5683b1f8d6a1999f411c9eab5b538b8f2fb82664 Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
2020-08-20Change doc to new dcaegen2 policy typePamela Dragosh2-2/+5
Deprecated old cdpa.tca policy type. Fixed one example that had the policy type wrong. Issue-ID: POLICY-2772 Change-Id: I9d79b319240cf8654de833f183c84eafb4a8ffa1 Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
2020-08-12Update XACML TutorialPamela Dragosh18-125/+1064
More code fixes and pointing to src/test/resources artifacts vs separate yaml/json files. Added instructions on how to incorporate as Docker image. Can download the example and import into Eclipse or other tool. Made sure links point to Master branch. Added POSTMAN Collection Issue-ID: POLICY-2565 Change-Id: I65c596b8c89cd87a72660a3d4dfa1085a60a41d2 Signed-off-by: Pamela Dragosh <pdragosh@research.att.com> (cherry picked from commit 82c1a1040666d1ba33b37ae520076eb8b3bbaa41) Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
2020-07-28Update XACML tutorial codePamela Dragosh7-34/+127
Just updating the code to ensure it compiles. I will cherry-pick this to frankfurt branch. Later I will upload the code as a tar and add some extra documentation on how to test in a runtime environment. Issue-ID: POLICY-2565 Change-Id: I3f93aca71c88072c5f35de72e63736ebe49856f8 Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
2020-07-10Merge "Fix broken references in documents"Ram Krishna Verma1-0/+0
2020-07-10Fix broken references in documentsliamfallon1-0/+0
This patch fixes some broken references and some unreferenced files. Issue-ID: POLICY-2686 Change-Id: Iad0bfea705d39fe70e0017e7b4b9a503e5649530 Signed-off-by: liamfallon <liam.fallon@est.tech>
2020-07-09Add links to swaggerPamela Dragosh1-0/+2
API already has a table of links to the swagger JSON, the pap and decision api did not. Issue-ID: POLICY-2710 Change-Id: I7ef86864735ae1b1e47f7cf9d28ff0e14aa1355d Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
2020-06-19Fix guard application docPamela Dragosh3-1/+7
recipe -> operation added response example Will cherry pick to frankfurt. Issue-ID: POLICY-2656 Change-Id: Ia0e5c75d29edcecce54709f3659d3cd8f5bcfd15 Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
2020-05-04Design/api documentationPamela Dragosh2-4/+16
Updates and fixes. Issue-ID: POLICY-2500 Change-Id: I2d7a0c78d57edf8bd258f685b12ae31bf6d54735 Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
2020-04-23Fix documentation errorsPamela Dragosh6-88/+171
This also updates the XACML PDP documentation. Issue-ID: POLICY-2500 Change-Id: Ice086fa39040fbee899652faa0a079192a122f03 Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
2020-03-20Updated documentation for Frankfurt changes to api and xacml-pdpChenfei Gao3-65/+866
Issue-ID: POLICY-2412 Change-Id: I3a3d6ed436e307ef20b2a41c7512478cb9c09e2f Signed-off-by: Chenfei Gao <cgao@research.att.com>
2019-10-18Updated swagger documentation to reflect abbreviated Monitor decision ↵HOCKLA1-0/+6
results feature (Policy-2126) Issue-ID: POLICY-2166 Change-Id: Ie84f6184801114b1115ae35e34279e98dad83205 Signed-off-by: HOCKLA <ah999m@att.com>
2019-09-11Update Decision API and Optimization docPamela Dragosh2-8/+12
More examples for Decision API in the design document and also update the changes for Optimization application in XACML PDP. Issue-ID: POLICY-2071 Change-Id: I0880e40a428dd299c1b4c1f60ccf3f009c53e929 Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
2019-08-30Documentation - added offeredapis.rst in parentSaryu Shah1-0/+2
Added links for the API including legacy. This will be linked in the master API reference page. Issue-ID: POLICY-1984 Signed-off-by: Saryu Shah <ss3917@att.com> Change-Id: Ibab75f6c2077539ca16845053ded880ff05b8dd4
2019-06-19Fix comments3.0.0Pamela Dragosh5-120/+98
No license is needed since this is example code. Issue-ID: POLICY-1842 Change-Id: Ib03594ec303b945ad20285c6a0d94b7c2bd04755 Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
2019-06-12Fix documentation add tutorialPamela Dragosh24-3/+953
Fixed some headings that made index's look strange. Added xacml tutorial. Issue-ID: POLICY-1842 Change-Id: Id6ab56e5d5d2a6b2fe37c8df5d3d70aa04776878 Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
2019-06-05Add xacml PDP docPamela Dragosh5-0/+535
Add the XACML PDP documentation Issue-ID: POLICY-1679 Change-Id: I3f6078de35cae5402a3d0d901072fafb0f3129c8 Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>