From af35b6a245e1587a3f149746c043fc4520daecaa Mon Sep 17 00:00:00 2001
From: Chenfei Gao <cgao@research.att.com>
Date: Tue, 21 May 2019 17:40:21 -0400
Subject: Add more textual explanation in api doc

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>
---
 .../onap.policies.optimization.PciPolicy.json      | 92 ++++++++++++++++++++++
 1 file changed, 92 insertions(+)
 create mode 100644 docs/api/policytypes/onap.policies.optimization.PciPolicy.json

(limited to 'docs/api/policytypes/onap.policies.optimization.PciPolicy.json')

diff --git a/docs/api/policytypes/onap.policies.optimization.PciPolicy.json b/docs/api/policytypes/onap.policies.optimization.PciPolicy.json
new file mode 100644
index 00000000..4adb631d
--- /dev/null
+++ b/docs/api/policytypes/onap.policies.optimization.PciPolicy.json
@@ -0,0 +1,92 @@
+{
+    "tosca_definitions_version": "tosca_simple_yaml_1_0_0",
+    "policy_types": [
+        {
+            "onap.policies.Optimization": {
+                "derived_from": "tosca.policies.Root",
+                "version": "1.0.0",
+                "description": "a base policy type for all policies that govern optimization"
+            }
+        },
+        {
+            "onap.policies.optimization.PciPolicy": {
+                "derived_from": "onap.policies.Optimization",
+                "version": "1.0.0",
+                "properties": {
+                    "policyScope": {
+                        "type": "list",
+                        "description": "scope where the policy is applicable",
+                        "required": true,
+                        "matchable": true,
+                        "entry_schema": {
+                            "type": "string"
+                        }
+                    },
+                    "policyType": {
+                        "type": "list",
+                        "description": "type of a policy",
+                        "required": true,
+                        "matchable": true,
+                        "entry_schema": {
+                            "type": "string",
+                            "constraints": [
+                                {
+                                    "valid_values": [
+                                        "pciPolicy"
+                                    ]
+                                }
+                            ]
+                        }
+                    },
+                    "identity": {
+                        "type": "string",
+                        "required": true
+                    },
+                    "resources": {
+                        "type": "list",
+                        "required": true,
+                        "entry_schema": {
+                            "type": "string"
+                        }
+                    },
+                    "pciProperties": {
+                        "type": "list",
+                        "required": false,
+                        "entry_schema": {
+                            "type": "policy.data.pciProperties_properties"
+                        }
+                    }
+                }
+            }
+        }
+    ],
+    "data_types": [
+        {
+            "policy.data.pciProperties_properties": {
+                "derived_from": "tosca.nodes.Root",
+                "properties": {
+                    "algoCategory": {
+                        "type": "string",
+                        "required": false
+                    },
+                    "pciOptmizationAlgoName": {
+                        "type": "string",
+                        "required": false
+                    },
+                    "pciOptimizationNwConstraint": {
+                        "type": "string",
+                        "required": false
+                    },
+                    "pciOptimizationPriority": {
+                        "type": "string",
+                        "required": false
+                    },
+                    "pciOptimizationTimeConstraint": {
+                        "type": "string",
+                        "required": false
+                    }
+                }
+            }
+        }
+    ]
+}
-- 
cgit 1.2.3-korg