added PolicyItemDefinitionType to api-types schema. needed for genera…

…te/validate methods.. updated swagger doc + generated html
Evolveum · Mar 2, 2017 · d4649ff · d4649ff
1 parent 833b7ff
commit d4649ff
Show file tree

Hide file tree

Showing 3 changed files with 88 additions and 5 deletions.
diff --git a/config/rest/index.html b/config/rest/index.html
@@ -6661,7 +6661,7 @@ <h3> Status: 200 - Successful operation </h3>
   "description" : "Successful operation",
   "schema" : {
     "type" : "object",
-    "description" : "TODO",
+    "description" : "see PolicyItemsDefinitionType",
     "properties" : { }
   }
 };
@@ -19062,7 +19062,7 @@ <h2>Parameters</h2>
   "required" : true,
   "schema" : {
     "type" : "object",
-    "description" : "TODO"
+    "description" : "see PolicyItemsDefinitionType"
   }
 };
 
@@ -19784,7 +19784,7 @@ <h3> Status: 503 - Communication problem while provisioning </h3>
             </div>
             <div id="generator">
                 <div class="content">
-                    Generated 2017-03-01T19:39:15.972+01:00
+                    Generated 2017-03-02T14:25:03.802+01:00
                 </div>
             </div>
         </div>

diff --git a/config/rest/swagger.yml b/config/rest/swagger.yml
@@ -183,7 +183,7 @@ paths:
         200:
           description: "Successful operation"
           schema:
-            description: "TODO"
+            description: "see PolicyItemsDefinitionType"
             type: "object"
         404:
           description: "Requested object was not found."
@@ -245,7 +245,7 @@ paths:
         required: true
         schema:
           type: "object"
-          description: "TODO"
+          description: "see PolicyItemsDefinitionType"
         description: "path to the property which will be generated"
       responses:
         200:

diff --git a/infra/schema/src/main/resources/xml/ns/public/common/api-types-3.xsd b/infra/schema/src/main/resources/xml/ns/public/common/api-types-3.xsd
@@ -526,6 +526,89 @@
             </xsd:element>
         </xsd:sequence>
     </xsd:complexType>
+
+    <xsd:complexType name="PolicyItemsDefinitionType">
+		<xsd:annotation>
+			<xsd:documentation>
+				Defined items and rules for generating/validating values
+			</xsd:documentation>
+		</xsd:annotation>
+		<xsd:sequence>
+			<xsd:element name="policyItemDefinition" type="tns:PolicyItemDefinitionType" maxOccurs="unbounded">
+				<xsd:annotation>
+					<xsd:documentation>
+						Definition for the item to be generated/validated
+					</xsd:documentation>
+				</xsd:annotation>
+			</xsd:element>
+		</xsd:sequence>
+	</xsd:complexType>
+	<xsd:element name="policyItemsDefinition" type="tns:PolicyItemsDefinitionType"/>
+
+	<xsd:complexType name="PolicyItemDefinitionType">
+		<xsd:annotation>
+			<xsd:documentation>
+
+			</xsd:documentation>
+		</xsd:annotation>
+		<xsd:sequence>
+			<xsd:element name="target" type="tns:PolicyItemTargetType" minOccurs="1">
+				<xsd:annotation>
+					<xsd:documentation>
+						Definition of item for which the value will be generated/validated
+					</xsd:documentation>
+				</xsd:annotation>
+			</xsd:element>
+
+			<xsd:element name="valuePolicyRef" type="c:ObjectReferenceType" minOccurs="0">
+        		<xsd:annotation>
+	                <xsd:documentation>
+	                    Reference to the value policy that should be used to generate/validate the value. 
+	                    If not specified, system defined policy is used
+	                </xsd:documentation>
+	                <xsd:appinfo>
+	        			<a:objectReferenceTargetType>c:ValuePolicyType</a:objectReferenceTargetType>
+	        		</xsd:appinfo>
+	            </xsd:annotation>
+        	</xsd:element>
+
+        	<xsd:element name="value" type="xsd:anyType" minOccurs="0">
+        		<xsd:annotation>
+	                <xsd:documentation>
+	                    Contains either generated value or value which will be validated
+	                </xsd:documentation>
+	            </xsd:annotation>
+        	</xsd:element>
+
+        	<xsd:element name="execute" type="xsd:boolean" minOccurs="0">
+        		<xsd:annotation>
+	                <xsd:documentation>
+	                    Specifies if the generated value should be set immediately to the object. 
+	                    Relevant only for generate operation.
+	                </xsd:documentation>	                
+	            </xsd:annotation>
+        	</xsd:element>
+        </xsd:sequence>
+	</xsd:complexType>
+	<xsd:element name="policyItemDefinition" type="tns:PolicyItemDefinitionType"/>
+
+   <xsd:complexType name="PolicyItemTargetType">
+		<xsd:annotation>
+			<xsd:documentation>
+				Defined items and rules for generating/validating values
+			</xsd:documentation>
+		</xsd:annotation>
+		<xsd:sequence>
+			<xsd:element name="path" type="t:ItemPathType" minOccurs="1">
+				<xsd:annotation>
+					<xsd:documentation>
+						Definition for the item to be generated/validated
+					</xsd:documentation>
+				</xsd:annotation>
+			</xsd:element>
+		</xsd:sequence>
+	</xsd:complexType>
+	<xsd:element name="policyItemTarget" type="tns:PolicyItemTargetType"/>
 
 </xsd:schema>