summaryrefslogtreecommitdiffstats
path: root/docs/api/api.rst
diff options
context:
space:
mode:
authorChenfei Gao <cgao@research.att.com>2019-09-16 22:35:47 -0400
committerPamela Dragosh <pdragosh@research.att.com>2019-10-15 16:08:56 +0000
commitf22846dd8b032876addae750a5d24fd6339b7c4b (patch)
tree1020d36c8adb9cb2945ddc7f5dc4f12d09e8e21d /docs/api/api.rst
parent09ed59bc86f78ad25076c326f7240f5473c6e6c6 (diff)
Update api swagger docs to reflect application/yaml support
Issue-ID: POLICY-2102 Change-Id: I46c9146d7c35edd1dfdc75b1efc82e89a1b726ef Signed-off-by: Chenfei Gao <cgao@research.att.com>
Diffstat (limited to 'docs/api/api.rst')
-rw-r--r--docs/api/api.rst2
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/api/api.rst b/docs/api/api.rst
index fc0f106f..ecaf4151 100644
--- a/docs/api/api.rst
+++ b/docs/api/api.rst
@@ -125,7 +125,7 @@ x-onap-requestid is used to track REST transactions for logging purpose, as desc
.. swaggerv2doc:: swagger/policy-api.json
It is worth noting that in POST policy API, client needs to provide a policy payload encoded in well-formed TOSCA Service Template, and
-in the JSON payload, "type" field value should strictly match the policy type name embedded in the API path (case sensitive).
+in the JSON/YAML payload, "type" field value should strictly match the policy type name embedded in the API path (case sensitive).
Otherwise, it will complain the policy type does not exist. Please check out the sample policies in above policy table.
.. swaggerv2doc:: swagger/guard-policy-api.json