summaryrefslogtreecommitdiffstats
path: root/docs/api
AgeCommit message (Collapse)AuthorFilesLines
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 Gao3-626/+64
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 Gao5-46/+92
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 Gao7-31/+31
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 Gao2-1/+78
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 Gao24-1730/+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-08-21Update API swagger to reflect the most recent changes to deployed endpointsChenfei Gao2-2/+146
Issue-ID: POLICY-1994 Change-Id: Iab2795ba9cf89cacf467cfa8156fc50685f81059 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 Gao30-25/+1860
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 Gao7-3/+2489
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>