summaryrefslogtreecommitdiffstats
path: root/docs/pap
AgeCommit message (Collapse)AuthorFilesLines
2021-06-01Update PAP documentationwaynedunican1-27/+19
Update documentation to align with PAP-PDP communication changes. PDP_UPDATE message now stores lists of policiesToBeDeployed and policiesToBeUndeployed. Removed any references to the policies field as this has been removed from PDP_UPDATE and added the new lists to the documentation. Issue-ID: POLICY-3339 Change-Id: Ib5bafffdb5ccd4ee5edbf861132b4dd8b088f5e4 Signed-off-by: waynedunican <wayne.dunican@est.tech> Signed-off-by: WayneDunican <wayne.dunican@est.tech>
2021-02-23Update swagger tags and response codeRam Krishna Verma1-4/+13
Issue-ID: POLICY-2526 Change-Id: I447a0f62b279b42fd10de15d886bcfa3fee07f2e Signed-off-by: Ram Krishna Verma <ram_krishna.verma@bell.ca>
2021-02-22Fixing a formatting issue in PAP Deployment API changes documentationa.sreekumar2-2/+3
Change-Id: I330a1c551a95b7c798cea76cd886bb2afbd064e3 Issue-ID: POLICY-2526 Signed-off-by: a.sreekumar <ajith.sreekumar@bell.ca>
2021-02-19Doc updates for PAP Deployment API changesa.sreekumar7-9/+477
Change-Id: I23b8778c599a0fd3cc659f677018d866a68a2489 Issue-ID: POLICY-2526 Signed-off-by: a.sreekumar <ajith.sreekumar@bell.ca>
2020-10-13Document "desiredInstanceCount" in PAP APIJim Hahn1-0/+6
Issue-ID: POLICY-2728 Change-Id: I0d22431e20fc21569a1e47f7f4dfb96d4293cf48 Signed-off-by: Jim Hahn <jrh3@att.com>
2020-08-20Change doc to new dcaegen2 policy typePamela Dragosh4-9/+9
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-07Removing legacy operational policy from documentsRam Krishna Verma4-15/+18
Removing legacy operational policy from design, api & pap documents. Removing HpaDecoder from distribution document. Issue-ID: POLICY-2430 Change-Id: Iba769d5e336218a00a77371ee8a3b480e0bb3eb5 Signed-off-by: Ram Krishna Verma <ram_krishna.verma@bell.ca>
2020-07-09Add links to swaggerPamela Dragosh1-1/+24
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-05-21Fix last documentation warningsPamela Dragosh2-0/+431
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-05-04Design/api documentationPamela Dragosh2-0/+60
Updates and fixes. Issue-ID: POLICY-2500 Change-Id: I2d7a0c78d57edf8bd258f685b12ae31bf6d54735 Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
2020-04-30Update pap documentsRam Krishna Verma14-44/+986
Adding all the api's introduced in Frankfurt release. Issue-ID: POLICY-2515 Change-Id: I62b3cf3194b2cb88b25b568f91973a1d71ec6b4a Signed-off-by: Ram Krishna Verma <ram_krishna.verma@bell.ca>
2020-04-27Updating group update request json in PAP documentationa.sreekumar1-3/+4
Issue-ID: POLICY-2515 Change-Id: I2861d81d58acbf88ecb8e7d2b51bb95c52ce20c5 Signed-off-by: a.sreekumar <ajith.sreekumar@bell.ca>
2020-01-28Updating documentation for supported policy type changes during PdpGroup updatea.sreekumar1-2/+9
Change-Id: I9efe9dd118fb0ec1a81fe37deb94fda9a86a9e65 Issue-ID: POLICY-2023 Signed-off-by: a.sreekumar <ajith.sreekumar@est.tech>
2019-12-17Update PAP docs per review comments.Jim Hahn1-1/+1
Issue-ID: POLICY-2281 Signed-off-by: Jim Hahn <jrh3@att.com> Change-Id: Ia8ddf2dddd3a6cd605efea360cbf47b03bb93c10
2019-12-12Document new PAP REST APIsJim Hahn5-40/+216
Includes the Pdp Group create/update API and the Deployment API. Issue-ID: POLICY-2281 Signed-off-by: Jim Hahn <jrh3@att.com> Change-Id: Ifde0491b029eb377c4f3083c784663df968b9d1b
2019-12-05Document PAP policy notificationsSaryu Shah2-0/+31
Document PAP policy notifications Issue-ID: POLICY-2270 Signed-off-by: Saryu Shah <ss3917@att.com> Change-Id: Ia2106165c3fa30951c36d1050e4db07835458589
2019-11-25Documentation - wild card suffixes for PDP supported policy typesSaryu Shah1-9/+1
Updated documentation to include wilcard suffixes for PDP supported policy types Issue-ID: POLICY-2247 Signed-off-by: Saryu Shah <ss3917@att.com> Change-Id: Ibbd030d569616b1e7a5b3f1ca0deb3ecf642aea3
2019-08-01Add sample requests and responses to PAP docsJim Hahn6-0/+289
Change-Id: I8f2643216bcc8fb2f64dd50296570ab41ea6423c Issue-ID: POLICY-1865 Signed-off-by: Jim Hahn <jrh3@att.com>
2019-05-30Design and Public API documentation completed.liamfallon1-46/+103
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>
2019-05-30Add documentation for PAPJim Hahn9-2/+1188
Included updates per Ram. Change-Id: Ib09c9b7e39aab566ebd3eae813fde6bc3e2fabd7 Issue-ID: POLICY-1681 Signed-off-by: Jim Hahn <jrh3@att.com>
2019-05-21Initial set of documentationPamela Dragosh1-0/+13
This is where I am at with documentation, getting it up so Chenfei and Liam can help me with it. Issue-ID: POLICY-1676 Change-Id: I19e2bd794c65bfd05de0b3a732e005029267d690 Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>