Merge "Add Capabilities endpoint to Telemetry API Reference"
This commit is contained in:
Jenkins
Gerrit Code Review
commit
bd28b503c2
@ -11,7 +11,7 @@
|
||||
<para>Manage Telemetry operations.</para>
|
||||
<section xml:id="alarms">
|
||||
<title>Alarms</title>
|
||||
<para>List, create, gets details for, update, and delete
|
||||
<para>List, create, get details for, update, and delete
|
||||
alarms.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
@ -83,4 +83,33 @@
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="capabilities">
|
||||
<title>Capabilities</title>
|
||||
<para>Get information for API and storage capabilities.</para>
|
||||
<para>
|
||||
The Telemetry service enables you to store samples, events,
|
||||
and alarm definitions in supported database back ends. The
|
||||
<code>capabilities</code> resource enables you to list the
|
||||
capabilities that a database supports.
|
||||
</para>
|
||||
<para>
|
||||
The <code>capabilities</code> resource returns a flattened
|
||||
dictionary of capability properties, each with an associated
|
||||
boolean value. A value of <code>true</code> indicates that the
|
||||
corresponding capability is available in the back end.
|
||||
</para>
|
||||
<para>
|
||||
Optionally, you can configure separate database back ends for
|
||||
samples, events, and alarm definitions. The
|
||||
<code>capabilities</code> response body shows a value of
|
||||
<code>true</code> to indicate that the samples, events, or alarm
|
||||
definitions database is ready to use in a production environment.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/telemetry-api/src/v2/os-telemetry-api-2.0.wadl#capabilities">
|
||||
<wadl:method href="#listCapabilities"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
</chapter>
|
||||
|
||||
393
api-ref/src/wadls/telemetry-api/src/v2/common.ent
Normal file
393
api-ref/src/wadls/telemetry-api/src/v2/common.ent
Normal file
@ -0,0 +1,393 @@
|
||||
<!-- Response parameters of the Capabilities endpoint -->
|
||||
<!ENTITY capabilitiesListParameters
|
||||
'
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="api" style="plain" type="array" path="$.api">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>An array of API capabilities for the
|
||||
configured storage driver.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="alarms:history:query:complex" style="plain"
|
||||
type="boolean" path="$.api.alarms:history:query:complex">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Indicates whether the complex query capability
|
||||
for alarm history is available for the configured database
|
||||
back end. A value of <code>true</code> indicates that the capability is available.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="alarms:history:query:simple" style="plain"
|
||||
type="boolean" path="$.api.alarms:history:query:simple">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Indicates whether the simple query capability
|
||||
for alarm history is available for the configured database
|
||||
back end. A value of <code>true</code> indicates that the capability is available.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="alarms:query:complex" style="plain"
|
||||
type="boolean" path="$.api.alarms:query:complex">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Indicates whether the complex query capability
|
||||
for alarm definitions is available for the configured database
|
||||
back end. A value of <code>true</code> indicates that the capability is available.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="alarms:query:simple" style="plain"
|
||||
type="boolean" path="$.api.alarms:query:simple">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Indicates whether the simple query capability
|
||||
for alarm definitions is available for the configured database
|
||||
back end. A value of <code>true</code> indicates that the capability is available.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="events:query:simple" style="plain"
|
||||
type="boolean" path="$.api.events:query:simple">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Indicates whether the simple query capability
|
||||
for events is available for the configured database
|
||||
back end. A value of <code>true</code> indicates that the capability is available.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="meters:pagination" style="plain"
|
||||
type="boolean" path="$.api.meters:pagination">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Indicates whether pagination
|
||||
for meters is available for the configured database
|
||||
back end. A value of <code>true</code> indicates that the capability is available.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="meters:query:complex" style="plain"
|
||||
type="boolean" path="$.api.meters:query:complex">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Indicates whether the complex query capability
|
||||
for meters is available for the configured database
|
||||
back end. A value of <code>true</code> indicates that the capability is available.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="meters:query:metadata" style="plain"
|
||||
type="boolean" path="$.api.meters:query:metadata">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Indicates whether the simple query capability
|
||||
for the metadata of meters is available for the configured
|
||||
database back end. A value of <code>true</code> indicates that the capability is available.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="meters:query:simple" style="plain"
|
||||
type="boolean" path="$.api.meters:query:simple">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Indicates whether the simple query capability
|
||||
for meters is available for the configured database back
|
||||
end. A value of <code>true</code> indicates that the capability is available.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="resources:pagination" style="plain"
|
||||
type="boolean" path="$.api.resources:pagination">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Indicates whether pagination
|
||||
for resources is available for the configured database
|
||||
back end. A value of <code>true</code> indicates that the capability is available.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="resources:query:complex" style="plain"
|
||||
type="boolean" path="$.api.resources:query:complex">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Indicates whether the complex query capability
|
||||
for resources is available for the configured database
|
||||
back end. A value of <code>true</code> indicates that the capability is available.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="resources:query:metadata" style="plain"
|
||||
type="boolean" path="$.api.resources:query:metadata">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Indicates whether the simple query capability
|
||||
for the metadata of resources is available for the configured
|
||||
database back end. A value of <code>true</code> indicates that the capability is available.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="resources:query:simple" style="plain"
|
||||
type="boolean" path="$.api.resources:query:simple">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Indicates whether the simple query capability
|
||||
for resources is available for the configured database back
|
||||
end. A value of <code>true</code> indicates that the capability is available.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="samples:pagination" style="plain"
|
||||
type="boolean" path="$.api.samples:pagination">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Indicates whether pagination
|
||||
for samples is available for the configured database
|
||||
back end. A value of <code>true</code> indicates that the capability is available.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="samples:query:complex" style="plain"
|
||||
type="boolean" path="$.api.samples:query:complex">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Indicates whether the complex query capability
|
||||
for samples is available for the configured database
|
||||
back end. A value of <code>true</code> indicates that the capability is available.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="samples:query:metadata" style="plain"
|
||||
type="boolean" path="$.api.samples:query:metadata">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Indicates whether the simple query capability
|
||||
for the metadata of samples is available for the configured
|
||||
database back end. A value of <code>true</code> indicates that the capability is available.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="samples:query:simple" style="plain"
|
||||
type="boolean" path="$.api.samples:query:simple">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Indicates whether the simple query capability
|
||||
for samples is available for the configured database back
|
||||
end. A value of <code>true</code> indicates that the capability is available.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="statistics:aggregation:selectable:avg" style="plain"
|
||||
type="boolean" path="$.api.statistics:aggregation:selectable:avg">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Indicates whether the <code>avg</code> capability
|
||||
is available for the configured database back end. A value of <code>true</code> indicates that the capability is available. Use the
|
||||
<code>avg</code> capability to get average values
|
||||
for samples.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="statistics:aggregation:selectable:cardinality" style="plain"
|
||||
type="boolean" path="$.api.statistics:aggregation:selectable:cardinality">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>
|
||||
Indicates whether the <code>cardinality</code> capability is
|
||||
available for the configured database back end. A value of
|
||||
<code>true</code> indicates that the capability is available. Use
|
||||
the <code>cardinality</code> capability to get cardinality
|
||||
for samples.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="statistics:aggregation:selectable:count" style="plain"
|
||||
type="boolean" path="$.api.statistics:aggregation:selectable:count">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Indicates whether the <code>count</code> capability
|
||||
is available for the configured database back end. A value of <code>true</code> indicates that the capability is available. Use the
|
||||
<code>count</code> capability to calculate the number of
|
||||
samples for a specified query.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="statistics:aggregation:selectable:max" style="plain"
|
||||
type="boolean" path="$.api.statistics:aggregation:selectable:max">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Indicates whether the <code>max</code> capability
|
||||
is available for the configured database back end. A value of <code>true</code> indicates that the capability is available. Use the
|
||||
<code>max</code> capability to calculate the maximum value
|
||||
for a specified query.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="statistics:aggregation:selectable:min" style="plain"
|
||||
type="boolean" path="$.api.statistics:aggregation:selectable:min">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Indicates whether the <code>min</code> capability
|
||||
is available for the configured database back end. A value of <code>true</code> indicates that the capability is available. Use the
|
||||
<code>min</code> capability to calculate the minimum value
|
||||
for a specified query.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="statistics:aggregation:selectable:quartile" style="plain"
|
||||
type="boolean" path="$.api.statistics:aggregation:selectable:quartile">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Indicates whether the <code>quartile</code> capability
|
||||
is available for the configured database back end. A value of <code>true</code> indicates that the capability is available. Use the
|
||||
<code>quartile</code> capability to calculate the quartile of
|
||||
sample volumes for a specified query.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="statistics:aggregation:selectable:stddev" style="plain"
|
||||
type="boolean" path="$.api.statistics:aggregation:selectable:stddev">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Indicates whether the <code>stddev</code> capability
|
||||
is available for the configured database back end. A value of <code>true</code> indicates that the capability is available. Use the
|
||||
<code>stddev</code> capability to calculate the standard deviation of
|
||||
sample volumes for a specified query.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="statistics:aggregation:selectable:sum" style="plain"
|
||||
type="boolean" path="$.api.statistics:aggregation:selectable:sum">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Indicates whether the <code>sum</code> capability
|
||||
is available for the configured database back end. A value of <code>true</code> indicates that the capability is available. Use the
|
||||
<code>sum</code> capability to calculate the sum of
|
||||
sample volumes for a specified query.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="statistics:aggregation:standard" style="plain"
|
||||
type="boolean" path="$.api.statistics:aggregation:standard">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Indicates whether the <code>standard</code> set of
|
||||
aggregation capability is available for the configured database
|
||||
back end. A value of <code>true</code> indicates that the capability is available.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="statistics:groupby" style="plain"
|
||||
type="boolean" path="$.api.statistics:groupby">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Indicates whether the <code>groupby</code>
|
||||
capabilityality is available for calculating statistics
|
||||
for the configured database back end. A value of <code>true</code> indicates that the capability is available.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="statistics:pagination" style="plain"
|
||||
type="boolean" path="$.api.statistics:pagination">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Indicates whether pagination
|
||||
for statistics is available for the configured database
|
||||
back end. A value of <code>true</code> indicates that the capability is available.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="statistics:query:complex" style="plain"
|
||||
type="boolean" path="$.api.statistics:query:complex">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Indicates whether the complex query capability
|
||||
for statistics is available for the configured database
|
||||
back end. A value of <code>true</code> indicates that the capability is available.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="statistics:query:metadata" style="plain"
|
||||
type="boolean" path="$.api.statistics:query:metadata">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Indicates whether the simple query capability
|
||||
for the metadata of samples used for calculating statistics
|
||||
is available for the configured database back end. A value of <code>true</code> indicates that the capability is available.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="statistics:query:simple" style="plain"
|
||||
type="boolean" path="$.api.statistics:query:simple">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Indicates whether the simple query capability
|
||||
for statistics is available for the configured database back
|
||||
end. A value of <code>true</code> indicates that the capability is available.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="alarm_storage" style="plain" type="array" path="$.alarm_storage">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Defines the capabilities for the storage that stores persisting alarm definitions. A value of <code>true</code> indicates that the capability is available.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="storage:production_ready" style="plain"
|
||||
type="boolean" path="$.api.storage:production_ready">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>
|
||||
Indicates whether the the configured database back end is
|
||||
ready to use in production environment. A value of
|
||||
<code>true</code> indicates that the database back end is
|
||||
ready to use in a production environment.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="event_storage" style="plain" type="array" path="$.event_storage">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>
|
||||
Defines the capabilities for the storage that stores
|
||||
persisting events. A value of <code>true</code> indicates that
|
||||
the capability is available.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="storage:production_ready" style="plain"
|
||||
type="boolean" path="$.api.storage:production_ready">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Indicates whether the the configured database
|
||||
back end is ready to use in production environment. A value of
|
||||
<code>true</code> indicates that the database back end is
|
||||
ready to use in a production environment.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="storage" style="plain" type="array" path="$.storage">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Defines the capabilities for the storage that stores persisting samples. A value of <code>true</code> indicates that the capability is available.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="storage:production_ready" style="plain"
|
||||
type="boolean" path="$.api.storage:production_ready">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Indicates whether the the configured database
|
||||
back end is ready to use in production environment. A value of
|
||||
<code>true</code> indicates that the database back end is
|
||||
ready to use in a production environment.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
'>
|
||||
@ -1,9 +1,11 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE application [<!ENTITY % common SYSTEM "common.ent">
|
||||
%common;]>
|
||||
<!-- (C) 2012-2014 OpenStack Foundation, All Rights Reserved -->
|
||||
<!--*******************************************************-->
|
||||
<!-- Import Common XML Entities -->
|
||||
<!-- -->
|
||||
<!-- You can resolve the entities with xmllint -->
|
||||
<!-- You can resolve the entites with xmllint -->
|
||||
<!-- -->
|
||||
<!-- xmllint -noent os-compute-2.wadl -->
|
||||
<!--*******************************************************-->
|
||||
@ -53,8 +55,35 @@
|
||||
<method href="#showResource"/>
|
||||
</resource>
|
||||
</resource>
|
||||
<resource path="capabilities" id="capabilities">
|
||||
<method href="#listCapabilities"/>
|
||||
</resource>
|
||||
</resource>
|
||||
</resources>
|
||||
<method id="listCapabilities" name="GET">
|
||||
<wadl:doc title="List capabilities" xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">A representation of
|
||||
the API and storage capabilities. Usually
|
||||
constrained by restrictions imposed by
|
||||
the storage driver.</para>
|
||||
</wadl:doc>
|
||||
<request/>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code href="./samples/capabilities.json"/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code href="./samples/capabilities.xml"/>
|
||||
</wadl:doc> &capabilitiesListParameters;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method id="listResources" name="GET">
|
||||
<wadl:doc title="List resources" xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
|
||||
@ -0,0 +1,44 @@
|
||||
{
|
||||
"alarm_storage": {
|
||||
"storage:production_ready": true
|
||||
},
|
||||
"api": {
|
||||
"alarms:history:query:complex": true,
|
||||
"alarms:history:query:simple": true,
|
||||
"alarms:query:complex": true,
|
||||
"alarms:query:simple": true,
|
||||
"events:query:simple": true,
|
||||
"meters:pagination": true,
|
||||
"meters:query:complex": false,
|
||||
"meters:query:metadata": true,
|
||||
"meters:query:simple": true,
|
||||
"resources:pagination": false,
|
||||
"resources:query:complex": false,
|
||||
"resources:query:metadata": true,
|
||||
"resources:query:simple": true,
|
||||
"samples:pagination": true,
|
||||
"samples:query:complex": true,
|
||||
"samples:query:metadata": true,
|
||||
"samples:query:simple": true,
|
||||
"statistics:aggregation:selectable:avg": true,
|
||||
"statistics:aggregation:selectable:cardinality": true,
|
||||
"statistics:aggregation:selectable:count": true,
|
||||
"statistics:aggregation:selectable:max": true,
|
||||
"statistics:aggregation:selectable:min": true,
|
||||
"statistics:aggregation:selectable:quartile": false,
|
||||
"statistics:aggregation:selectable:stddev": true,
|
||||
"statistics:aggregation:selectable:sum": true,
|
||||
"statistics:aggregation:standard": true,
|
||||
"statistics:groupby": true,
|
||||
"statistics:pagination": true,
|
||||
"statistics:query:complex": false,
|
||||
"statistics:query:metadata": true,
|
||||
"statistics:query:simple": true
|
||||
},
|
||||
"event_storage": {
|
||||
"storage:production_ready": true
|
||||
},
|
||||
"storage": {
|
||||
"storage:production_ready": true
|
||||
}
|
||||
}
|
||||
146
api-ref/src/wadls/telemetry-api/src/v2/samples/capabilities.xml
Normal file
146
api-ref/src/wadls/telemetry-api/src/v2/samples/capabilities.xml
Normal file
@ -0,0 +1,146 @@
|
||||
<value>
|
||||
<api>
|
||||
<item>
|
||||
<key>statistics:query:complex</key>
|
||||
<value>false</value>
|
||||
</item>
|
||||
<item>
|
||||
<key>alarms:history:query:simple</key>
|
||||
<value>true</value>
|
||||
</item>
|
||||
<item>
|
||||
<key>meters:query:metadata</key>
|
||||
<value>true</value>
|
||||
</item>
|
||||
<item>
|
||||
<key>alarms:query:simple</key>
|
||||
<value>true</value>
|
||||
</item>
|
||||
<item>
|
||||
<key>resources:query:simple</key>
|
||||
<value>true</value>
|
||||
</item>
|
||||
<item>
|
||||
<key>statistics:aggregation:selectable:quartile</key>
|
||||
<value>false</value>
|
||||
</item>
|
||||
<item>
|
||||
<key>statistics:query:simple</key>
|
||||
<value>true</value>
|
||||
</item>
|
||||
<item>
|
||||
<key>statistics:aggregation:selectable:count</key>
|
||||
<value>true</value>
|
||||
</item>
|
||||
<item>
|
||||
<key>statistics:aggregation:selectable:min</key>
|
||||
<value>true</value>
|
||||
</item>
|
||||
<item>
|
||||
<key>samples:pagination</key>
|
||||
<value>true</value>
|
||||
</item>
|
||||
<item>
|
||||
<key>statistics:pagination</key>
|
||||
<value>true</value>
|
||||
</item>
|
||||
<item>
|
||||
<key>alarms:query:complex</key>
|
||||
<value>true</value>
|
||||
</item>
|
||||
<item>
|
||||
<key>meters:query:complex</key>
|
||||
<value>false</value>
|
||||
</item>
|
||||
<item>
|
||||
<key>resources:pagination</key>
|
||||
<value>false</value>
|
||||
</item>
|
||||
<item>
|
||||
<key>statistics:groupby</key>
|
||||
<value>true</value>
|
||||
</item>
|
||||
<item>
|
||||
<key>alarms:history:query:complex</key>
|
||||
<value>true</value>
|
||||
</item>
|
||||
<item>
|
||||
<key>meters:pagination</key>
|
||||
<value>true</value>
|
||||
</item>
|
||||
<item>
|
||||
<key>meters:query:simple</key>
|
||||
<value>true</value>
|
||||
</item>
|
||||
<item>
|
||||
<key>samples:query:metadata</key>
|
||||
<value>true</value>
|
||||
</item>
|
||||
<item>
|
||||
<key>statistics:query:metadata</key>
|
||||
<value>true</value>
|
||||
</item>
|
||||
<item>
|
||||
<key>samples:query:simple</key>
|
||||
<value>true</value>
|
||||
</item>
|
||||
<item>
|
||||
<key>resources:query:metadata</key>
|
||||
<value>true</value>
|
||||
</item>
|
||||
<item>
|
||||
<key>statistics:aggregation:selectable:max</key>
|
||||
<value>true</value>
|
||||
</item>
|
||||
<item>
|
||||
<key>samples:query:complex</key>
|
||||
<value>true</value>
|
||||
</item>
|
||||
<item>
|
||||
<key>statistics:aggregation:standard</key>
|
||||
<value>true</value>
|
||||
</item>
|
||||
<item>
|
||||
<key>statistics:aggregation:selectable:sum</key>
|
||||
<value>true</value>
|
||||
</item>
|
||||
<item>
|
||||
<key>events:query:simple</key>
|
||||
<value>true</value>
|
||||
</item>
|
||||
<item>
|
||||
<key>statistics:aggregation:selectable:stddev</key>
|
||||
<value>true</value>
|
||||
</item>
|
||||
<item>
|
||||
<key>statistics:aggregation:selectable:avg</key>
|
||||
<value>true</value>
|
||||
</item>
|
||||
<item>
|
||||
<key>statistics:aggregation:selectable:cardinality</key>
|
||||
<value>true</value>
|
||||
</item>
|
||||
<item>
|
||||
<key>resources:query:complex</key>
|
||||
<value>false</value>
|
||||
</item>
|
||||
</api>
|
||||
<storage>
|
||||
<item>
|
||||
<key>storage:production_ready</key>
|
||||
<value>true</value>
|
||||
</item>
|
||||
</storage>
|
||||
<alarm_storage>
|
||||
<item>
|
||||
<key>storage:production_ready</key>
|
||||
<value>true</value>
|
||||
</item>
|
||||
</alarm_storage>
|
||||
<event_storage>
|
||||
<item>
|
||||
<key>storage:production_ready</key>
|
||||
<value>true</value>
|
||||
</item>
|
||||
</event_storage>
|
||||
</value>
|
||||
Loading…
x
Reference in New Issue
Block a user