Merge "Improve sparse descriptions for Resource Schemas API operations"

api-ref/src/wadls/orchestration-api/src/v1/orchestration-api.wadl

@@ -1309,6 +1309,10 @@
          title="Show resource schema">
          <para role="shortdesc">
             Shows the interface schema for a specified resource type.
+            This schema describes the properties that can be set on
+            the resource, their types, constraints, descriptions, and
+            default values. Additionally, the resource attributes and
+            their descriptions are provided.
          </para>
       </wadl:doc>
       <response status="200">
@@ -1327,6 +1331,16 @@
          <para role="shortdesc">
             Shows the template representation for a specified resource type.
          </para>
+         <para>
+            The returned template contains a single resource of the specified
+            type. Each resource property is mapped to a template parameter and
+            each resource attribute is mapped to a template output.
+         </para>
+         <para>
+            You can use these templates as a starting place for creating
+            customized, template-based resources or as examples of using the
+            particular resource in another template.
+         </para>
       </wadl:doc>
       <response status="200">
         <representation mediaType="application/json" >

api-ref/src/wadls/orchestration-api/src/v1/samples/resource_schema.json

@@ -1,21 +1,30 @@
 {
     "attributes": {
         "an_attribute": {
-            "description": "An attribute description ."
+            "description": "A runtime value of the resource."
         }
     },
     "properties": {
         "a_property": {
-            "update_allowed": false,
+            "constraints": [
+                {
+                    "description": "Must be between 1 and 255 characters",
+                    "length": {
+                        "max": 255,
+                        "min": 1
+                    }
+                }
+            ],
+            "description": "A resource description.",
             "required": true,
             "type": "string",
-            "description": "A resource description."
+            "update_allowed": false
         }
     },
     "resource_type": "OS::Heat::AResourceName",
     "support_status": {
-        "status": "SUPPORTED",
         "message": "A status message",
+        "status": "SUPPORTED",
         "version": "2014.1"
     }
 }