summaryrefslogtreecommitdiffstats
path: root/docs/development/devtools/devtools.rst
AgeCommit message (Collapse)AuthorFilesLines
2021-07-19Add profile for generating Swagger documentsliamfallon1-0/+49
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>
2020-05-21Fix last documentation warningsPamela Dragosh1-0/+2
Had to add toctree to remove warnings. Do not seem to like the fact that an .rst is referenced via a label. Removed amsterdam controller and added frankfurt controller. Issue-ID: POLICY-2511 Change-Id: I5fb887b3a1d26a543c844d6baa34b3fa0e506f0a Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
2020-04-23Fix documentation errorsPamela Dragosh1-1/+2
This also updates the XACML PDP documentation. Issue-ID: POLICY-2500 Change-Id: Ice086fa39040fbee899652faa0a079192a122f03 Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
2020-04-16Update developer and s3p docsPamela Dragosh1-1166/+50
Add in policy/gui and re-org the repo build order. Add doc and links on how to setup mariadb and the simulators. Move s3p documentation into individual rst. Issue-ID: POLICY-2500 Change-Id: I8c781817cbfb13b55e6225cf86143bb67fca5f70 Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
2019-12-16Document Policy API to create operational policy for CDS actorRashmi Pujar1-0/+1398
- Restructured the development directory to include devtools, and actors Issue-ID: POLICY-2294 Signed-off-by: Rashmi Pujar <rashmi.pujar@bell.ca> Change-Id: Ifdb1a9f3b8fa4a2ff34a7c8edf29783d2de803b7