Merge "Update metadata property flags"

This commit is contained in:
Jenkins 2015-08-07 03:35:57 +00:00 committed by Gerrit Code Review
commit 3785100458
2 changed files with 230 additions and 162 deletions

View File

@ -286,7 +286,7 @@
style="plain" required="true" type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Defines whether the image can be deleted.</para>
<para>Indicates whether the image can be deleted.</para>
</wadl:doc>
</param>'>
<!ENTITY idParameter '
@ -842,7 +842,7 @@
style="plain" required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The <code>name</code> of the property.</para>
<para>The name of the property.</para>
</wadl:doc>
</param>'>
<!ENTITY metadefPropertyTitleParameter '
@ -850,7 +850,7 @@
style="plain" required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The <code>title</code> of the property.</para>
<para>The title of the property.</para>
</wadl:doc>
</param>'>
<!ENTITY metadefPropertyTypeParameter '
@ -858,7 +858,7 @@
style="plain" required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Property <code>type</code>.</para>
<para>The property type.</para>
</wadl:doc>
</param>'>
<!ENTITY metadefPropertyEnumParameter '
@ -869,6 +869,14 @@
<para>Enumeration of property values.</para>
</wadl:doc>
</param>'>
<!ENTITY metadefPropertyEnumOptionalParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="enum"
style="plain" required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Enumeration of property values.</para>
</wadl:doc>
</param>'>
<!ENTITY metadefPropertyItemsParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="items"
style="plain" required="true" type="xsd:string">
@ -877,12 +885,68 @@
<para>Schema for the items in an array.</para>
</wadl:doc>
</param>'>
<!ENTITY metadefPropertyItemsOptionalParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="items"
style="plain" required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Schema for the items in an array.</para>
</wadl:doc>
</param>'>
<!ENTITY metadefPropertyDescParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="description"
style="plain" required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Property description.</para>
<para>The description of the property.</para>
</wadl:doc>
</param>'>
<!ENTITY metadefPropertyDescOptionalParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="description"
style="plain" required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The description of the property.</para>
</wadl:doc>
</param>'>
<!ENTITY metadefPropertyOperParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="operators"
style="plain" required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Operators property description.</para>
</wadl:doc>
</param>'>
<!ENTITY metadefPropertyOperOptionalParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="operators"
style="plain" required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Operators property description.</para>
</wadl:doc>
</param>'>
<!ENTITY metadefPropertyDfltParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="default"
style="plain" required="true" type="xsd:base64Binary">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Default property description.</para>
</wadl:doc>
</param>'>
<!ENTITY metadefPropertyDfltOptionalParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="default"
style="plain" required="false" type="xsd:base64Binary">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Default property description.</para>
</wadl:doc>
</param>'>
<!ENTITY metadefPropertyReadParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="readonly"
style="plain" required="true" type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Indicates whether this is a read-only property.</para>
</wadl:doc>
</param>'>
<!ENTITY metadefPropertyMinParameter '
@ -974,6 +1038,111 @@
</para>
</wadl:doc>
</param>'>
<!ENTITY metadefPropertyOptionalDfltParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="default"
style="plain" required="false" type="xsd:base64Binary">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Default property description.</para>
</wadl:doc>
</param>'>
<!ENTITY metadefPropertyReadOptionalParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="readonly"
style="plain" required="false" type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Indicates whether this is a read-only property.</para>
</wadl:doc>
</param>'>
<!ENTITY metadefPropertyMinOptionalParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="minimum"
style="plain" required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Minimum allowed numerical value.</para>
</wadl:doc>
</param>'>
<!ENTITY metadefPropertyMaxOptionalParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="maximum"
style="plain" required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Maximum allowed numerical value.</para>
</wadl:doc>
</param>'>
<!ENTITY metadefPropertyMinLengthOptionalParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="minLength"
style="plain" required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Minimum allowed string length.</para>
</wadl:doc>
</param>'>
<!ENTITY metadefPropertyMaxLengthOptionalParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="maxLength"
style="plain" required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Maximum allowed string length.</para>
</wadl:doc>
</param>'>
<!ENTITY metadefPropertyPatternOptionalParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="pattern"
style="plain" required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>A regular expression (ECMA 262) that a string value
must match.
</para>
</wadl:doc>
</param>'>
<!ENTITY metadefPropertyMinItemsOptionalParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="minItems"
style="plain" required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Minimum length of an array.</para>
</wadl:doc>
</param>'>
<!ENTITY metadefPropertyMaxItemsOptionalParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="maxItems"
style="plain" required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Maximum length of an array.</para>
</wadl:doc>
</param>'>
<!ENTITY metadefPropertyUniqueItemsOptionalParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="uniqueItems"
style="plain" required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>
Indicates whether all values in the array must be distinct.
</para>
</wadl:doc>
</param>'>
<!ENTITY metadefPropertyAdditionalItemsOptionalParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="additionalItems"
style="plain" required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>
Describes extra items, if you use <i>tuple typing</i>. If the value of
<code>items</code> is an array (tuple typing) and the instance is longer
than the list of schemas in <code>items</code>, the additional items are
described by the schema in this property.
</para>
<para>
If this value is <code>false</code>, the instance cannot be longer than
the list of schemas in <code>items</code>.
</para>
<para>
If this value is <code>true</code>, that is equivalent to the empty
schema (anything goes).
</para>
</wadl:doc>
</param>'>
<!ENTITY metadefTagsParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="tags"
style="plain" required="true" type="xsd:string">

View File

@ -58,8 +58,11 @@
<method name="POST" id="createProperty-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Create property">
<para role="shortdesc">Creates a property definition within a
namespace. Schema is subset of JSON Property definition schema
<para role="shortdesc">
Creates a property definition within a namespace.
</para>
<para>
The schema is a subset of JSON property definition schema.
</para>
</wadl:doc>
<request>
@ -69,156 +72,17 @@
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code href="samples/metadef-property-create-req.json"/>
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"><para>Name of the property.
</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="title" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"><para>Property title.
</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="type" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"><para>Property type
</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="enum" style="plain" type="xsd:enum"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Enumeration of property values.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="items" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>specifies schema for the items in an
array.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="description" style="plain" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Property description.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="minimum" style="plain" type="xsd:int"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Minimum allowed numerical value.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="maximum" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Maximum allowed numerical value.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="minLength" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Minimum allowed string length.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="maxLength" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Maximum allowed string length.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="pattern" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>A regular expression (ECMA 262) that
a string value must match.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="minItems" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Minimum length of an array.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="maxItems" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Maximum length of an array.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="uniqueItems" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>whether all the values in the array
must be distinct.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="additionalItems" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
If you use <i>tuple-typing</i>, describes extra
items. If the value of <code>items</code> is an
array and the instance is longer than the list of
schemas in <code>items</code>, the schema in this
property describes the additional items.
</para>
<para>
If this value is false, the instance cannot be
longer than the number of schemas listed in
<code>items</code>.
</para>
<para>
A value of true indicates an empty schema, or
anything goes.
</para>
</wadl:doc>
</param>
&metadefPropertyNameParameter;
&metadefPropertyTitleParameter; &metadefPropertyTypeParameter;
&metadefPropertyEnumOptionalParameter; &metadefPropertyItemsOptionalParameter;
&metadefPropertyDescOptionalParameter; &metadefPropertyOperOptionalParameter;
&metadefPropertyDfltOptionalParameter; &metadefPropertyReadOptionalParameter;
&metadefPropertyMinOptionalParameter;
&metadefPropertyMaxOptionalParameter; &metadefPropertyMinLengthOptionalParameter;
&metadefPropertyMaxLengthOptionalParameter; &metadefPropertyPatternOptionalParameter;
&metadefPropertyMinItemsOptionalParameter; &metadefPropertyMaxItemsOptionalParameter;
&metadefPropertyUniqueItemsOptionalParameter;
&metadefPropertyAdditionalItemsOptionalParameter;
</representation>
</request>
<response status="201">
@ -230,7 +94,9 @@
</wadl:doc> &metadefPropertyNameParameter;
&metadefPropertyTitleParameter; &metadefPropertyTypeParameter;
&metadefPropertyEnumParameter; &metadefPropertyItemsParameter;
&metadefPropertyDescParameter; &metadefPropertyMinParameter;
&metadefPropertyDescParameter; &metadefPropertyOperParameter;
&metadefPropertyDfltParameter; &metadefPropertyReadParameter;
&metadefPropertyMinParameter;
&metadefPropertyMaxParameter; &metadefPropertyMinLengthParameter;
&metadefPropertyMaxLengthParameter; &metadefPropertyPatternParameter;
&metadefPropertyMinItemsParameter; &metadefPropertyMaxItemsParameter;
@ -261,7 +127,9 @@
&metadefPropertyNameParameter;
&metadefPropertyTitleParameter; &metadefPropertyTypeParameter;
&metadefPropertyEnumParameter; &metadefPropertyItemsParameter;
&metadefPropertyDescParameter; &metadefPropertyMinParameter;
&metadefPropertyDescParameter; &metadefPropertyOperParameter;
&metadefPropertyDfltParameter; &metadefPropertyReadParameter;
&metadefPropertyMinParameter;
&metadefPropertyMaxParameter; &metadefPropertyMinLengthParameter;
&metadefPropertyMaxLengthParameter; &metadefPropertyPatternParameter;
&metadefPropertyMinItemsParameter; &metadefPropertyMaxItemsParameter;
@ -273,7 +141,7 @@
<method name="GET" id="getProperty-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Get property definition">
<para role="shortdesc">Gets definition for a specified property.
<para role="shortdesc">Gets the definition for a specified property.
</para>
<para>
If you include the <code>resource_type</code> query
@ -317,7 +185,9 @@
&metadefPropertyNameParameter;
&metadefPropertyTitleParameter; &metadefPropertyTypeParameter;
&metadefPropertyEnumParameter; &metadefPropertyItemsParameter;
&metadefPropertyDescParameter; &metadefPropertyMinParameter;
&metadefPropertyDescParameter; &metadefPropertyOperParameter;
&metadefPropertyDfltParameter; &metadefPropertyReadParameter;
&metadefPropertyMinParameter;
&metadefPropertyMaxParameter; &metadefPropertyMinLengthParameter;
&metadefPropertyMaxLengthParameter; &metadefPropertyPatternParameter;
&metadefPropertyMinItemsParameter; &metadefPropertyMaxItemsParameter;
@ -391,6 +261,33 @@
<para>Property description.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="operators" style="plain" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Operators property description.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="default" style="plain" type="xsd:base64Binary"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Default property description.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="readonly" style="plain" type="xsd:boolean"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Indicates whether this is a read-only property.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="minimum" style="plain" type="xsd:int"
required="false">
@ -501,7 +398,9 @@
&metadefPropertyNameParameter;
&metadefPropertyTitleParameter; &metadefPropertyTypeParameter;
&metadefPropertyEnumParameter; &metadefPropertyItemsParameter;
&metadefPropertyDescParameter; &metadefPropertyMinParameter;
&metadefPropertyDescParameter; &metadefPropertyOperParameter;
&metadefPropertyDfltParameter; &metadefPropertyReadParameter;
&metadefPropertyMinParameter;
&metadefPropertyMaxParameter; &metadefPropertyMinLengthParameter;
&metadefPropertyMaxLengthParameter; &metadefPropertyPatternParameter;
&metadefPropertyMinItemsParameter; &metadefPropertyMaxItemsParameter;