summaryrefslogtreecommitdiffstats
path: root/docs/api/api.rst
AgeCommit message (Collapse)AuthorFilesLines
2023-04-04Update Policy Offered APIslapentafd1-19/+27
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-04-21Document changes for API springboot migrationRashmi Pujar1-10/+27
Issue-ID: POLICY-3925 Signed-off-by: Rashmi Pujar <rashmi.pujar1@bell.ca> Change-Id: Ie517af1fd40c3eafcc758d3fd421a5ce8ca22517
2022-03-25Add documentation for toscaNodeTemplate apis in onap docrameshiyer271-0/+30
Issue-ID: POLICY-3934 Signed-off-by: zrrmmua <ramesh.murugan.iyer@est.tech> Change-Id: I62338fd2306c601e758a84a090411af114382dd4
2021-11-03Rename username for API operations.adheli.tavares1-10/+10
Use an account other than healthcheck in API for provisioning of policies. Issue-ID: POLICY-2744 Change-Id: Ia8c943aa20dc4080f7e8f9c121f0d1384471a3aa Signed-off-by: adheli.tavares <adheli.tavares@est.tech>
2020-08-21Add guard filter documentationPamela Dragosh1-0/+1
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 Dragosh1-4/+4
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-18Correct documentation issues for Policy projectEric Debeau1-1/+1
Add _static repo with css file, onap logo and favicon Correct bad link Issue-ID: DOC-622 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: I8963dc35059fbe0c746cfe1bfd3463153b1e2279
2020-08-07Removing legacy operational policy from documentsRam Krishna Verma1-4/+0
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-27Documentation for 'Fetch and Delete policy API with PolicyName and ↵puthuparambil.aditya1-0/+9
PolicyVersion' Issue-ID: POLICY-2585 Signed-off-by: puthuparambil.aditya <aditya.puthuparambil@bell.ca> Change-Id: I76c41dd139b3d41e1cadc61108682ff4bdc6f6a0
2020-05-21Fix last documentation warningsPamela Dragosh1-3/+0
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-13Fix labels that generated warningsPamela Dragosh1-0/+4
Restoring these labels even though they produce warnings. Issue-ID: POLICY-2511 Change-Id: I02ac81acf97d56b89470c287a36371bac4ae84a9 Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
2020-05-06Update API documentationliamfallon1-22/+63
API documentation updated to clarify and explain how TOSCA checks are carried out, warnings added to the docuemtation to explain how the policy type and data type hierarchy and policy to policy type references are checked and under what circumstances errors are reported. Issue-ID: POLICY-2500 Change-Id: I3cbb7d45ed9997b04b523a4b3cfe32950df71262 Signed-off-by: liamfallon <liam.fallon@est.tech>
2020-05-04Design/api documentationPamela Dragosh1-6/+45
Updates and fixes. Issue-ID: POLICY-2500 Change-Id: I2d7a0c78d57edf8bd258f685b12ae31bf6d54735 Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
2020-03-27Fixing error in policy-api readthedocs pagea.sreekumar1-0/+1
Change-Id: Id8c0db99d9c9437a82bface507cbc9d257ecd4b6 Issue-ID: POLICY-2399 Signed-off-by: a.sreekumar <ajith.sreekumar@est.tech>
2020-03-20Updated documentation for Frankfurt changes to api and xacml-pdpChenfei Gao1-61/+63
Issue-ID: POLICY-2412 Change-Id: I3a3d6ed436e307ef20b2a41c7512478cb9c09e2f Signed-off-by: Chenfei Gao <cgao@research.att.com>
2020-01-16Updated API documentation to reflect the addition of version validation featureChenfei Gao1-46/+77
Issue-ID: POLICY-2316 Change-Id: I981f7998926931d4bc2cd6a3bb0781071f768fae Signed-off-by: Chenfei Gao <cgao@research.att.com>
2019-10-15Update api swagger docs to reflect application/yaml supportChenfei Gao1-1/+1
Issue-ID: POLICY-2102 Change-Id: I46c9146d7c35edd1dfdc75b1efc82e89a1b726ef Signed-off-by: Chenfei Gao <cgao@research.att.com>
2019-10-10Update api documentation to reflect addition of new policy creation endpointChenfei Gao1-0/+1
Issue-ID: POLICY-2157 Change-Id: Iebdf6f27c47b8bfae375845a01ab7dbea225c5a9 Signed-off-by: Chenfei Gao <cgao@research.att.com>
2019-10-01Fix links in api docChenfei Gao1-25/+25
Issue-ID: POLICY-2121 Change-Id: I5ea5308afd63e5aeba3ac018c959f24c14c0b961 Signed-off-by: Chenfei Gao <cgao@research.att.com>
2019-09-11Update api docs to reflect the most recent changes to policytypesChenfei Gao1-29/+30
Issue-ID: POLICY-2073 Change-Id: I67bcd417329231d5297d8f7e9c982b788cb46928 Signed-off-by: Chenfei Gao <cgao@research.att.com>
2019-08-23Add documentation for stability/performance tests of policy componentsChenfei Gao1-2/+3
Add s3p documentation for policy-api Add s3p documentation for policy-pap Add s3p documentation for policy-xacml-pdp Add s3p documentation for policy-apex-pdp Issue-ID: POLICY-1993 Change-Id: Id267f2b89316b32e79db11009cb013027058e94a Signed-off-by: Chenfei Gao <cgao@research.att.com>
2019-06-12Fix documentation add tutorialPamela Dragosh1-2/+2
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-05-21Add more textual explanation in api docChenfei Gao1-15/+149
Added more textual explanation and tables for downloading sample policies and preloaded policy types. Also added sample curl commands for api calls. Issue-ID: POLICY-1680 Change-Id: Ia98e37679ae8e632da9d1f7308e156f722648faf Signed-off-by: Chenfei Gao <cgao@research.att.com>
2019-05-21Add policy design api documentationChenfei Gao1-3/+27
Adding swagger and global api table to api rst documentation Issue-ID: POLICY-1680 Change-Id: Iae966917b73a8762172e708fe207c4fc6e52615f Signed-off-by: Chenfei Gao <cgao@research.att.com>
2019-05-21Initial set of documentationPamela Dragosh1-0/+14
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>