starlingx
/
integ
Code Issues Proposed changes

Remove ceilometer CLI extensions from restapi doc 

Updating restapi doc to remove ceilometer CLI extensions as
ceilometer API is deprecated.

Story: 2002825
Task: 24241

Change-Id: I0f23a45b2348910a6f6d08c5142e003bfa0bd24a
Signed-off-by: Angie Wang <angie.wang@windriver.com>
This commit is contained in:
Angie Wang 2018-08-08 16:48:27 -04:00
parent c7d64f9705
commit 230217421e
19 changed files with 2 additions and 823 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
restapi-doc/centos/build_srpm.data
View File

@ -3,5 +3,5 @@ COPY_LIST="$SRC_DIR/* \
$CGCS_BASE/downloads/mvn.repo.tgz \
"
TIS_PATCH_VER=25
TIS_PATCH_VER=26
BUILD_IS_SLOW=3

11
restapi-doc/restapi-doc/api-ref-guides/pom.xml
View File

@ -77,17 +77,6 @@ SPDX-License-Identifier: Apache-2.0
<pdfFilenameBase>api-ref-networking-v2-cgcs-ext</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-telemetry-v2-cgcs-ext</id>
<goals>
<goal>generate-pdf</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref-telemetry-v2-cgcs-ext.xml </includes>
<pdfFilenameBase>api-ref-telemetry-v2-cgcs-ext</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-image-v2-cgcs-ext</id>
<goals>

57
restapi-doc/restapi-doc/api-ref-guides/src/bk-api-ref-telemetry-v2-cgcs-ext.xml
View File

@ -1,57 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2014-2017 Wind River Systems, Inc.
SPDX-License-Identifier: Apache-2.0
-->
<!DOCTYPE book[
<!-- Some useful entities borrowed from HTML -->
<!ENTITY ndash "&#x2013;">
<!ENTITY mdash "&#x2014;">
<!ENTITY hellip "&#x2026;">
<!ENTITY plusmn "&#xB1;">
<!ENTITY nbsp "&#160;">
<!-- Useful for describing APIs -->
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
]>
<book xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0"
xml:id="api.openstack.org-telemetry-v2-cgcs-ext-pdf">
<info>
<title>OpenStack Telemetry API v2 cgcs extensions</title>
<titleabbrev>API Reference</titleabbrev>
<author>
<personname>
<firstname/>
<surname/>
</personname>
<affiliation>
<orgname>Wind River</orgname>
</affiliation>
</author>
<copyright>
<year>2014</year>
<holder>Wind River</holder>
</copyright>
<productname>Titanium Cloud</productname>
<pubdate/>
<legalnotice role="apache2">
<annotation>
<remark>Copyright details are filled in by the
template.</remark>
</annotation>
</legalnotice>
</info>
<!-- <xi:include href="preface.xml"/>-->
<xi:include
href="../../api-ref/src/docbkx/ch_telemetry-v2-cgcs-ext.xml"/>
</book>

1
restapi-doc/restapi-doc/api-ref-guides/src/bk-api-ref.xml
View File

@ -43,7 +43,6 @@ SPDX-License-Identifier: Apache-2.0
<xi:include href="../../api-ref/src/docbkx/ch_compute-v2-cgcs-ext.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_networking-v2-cgcs-ext.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_blockstorage-api-v2-cgcs-ext.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_telemetry-v2-cgcs-ext.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_image-v2-cgcs-ext.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_sysinv-api-v1.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_patching-api-v1.xml"/>

38
restapi-doc/restapi-doc/api-ref/locale/api-ref.pot
View File

@ -13,7 +13,7 @@ msgstr ""
msgid "OpenStack Compute API v2 extensions"
msgstr ""
#: ./api-ref/src/docbkx/api-ref-compute-v2-ext.xml:13(year) ./api-ref/src/docbkx/api-ref-identity-v3.xml:13(year) ./api-ref/src/docbkx/api-ref-blockstorage-v1.xml:13(year) ./api-ref/src/docbkx/api-ref-objectstorage-v1.xml:13(year) ./api-ref/src/docbkx/api-ref.xml:13(year) ./api-ref/src/docbkx/api-ref-image-v2.xml:13(year) ./api-ref/src/docbkx/api-ref-orchestration-v1.xml:13(year) ./api-ref/src/docbkx/api-ref-networking-v2.xml:13(year) ./api-ref/src/docbkx/api-ref-compute-v2.xml:13(year) ./api-ref/src/docbkx/api-ref-image-v1.xml:13(year) ./api-ref/src/docbkx/api-ref-telemetry-v2.xml:13(year) ./api-ref/src/docbkx/api-ref-blockstorage-v2.xml:13(year) ./api-ref/src/docbkx/api-ref-identity-v2.xml:13(year) ./api-ref/src/docbkx/api-ref-databases-v1.xml:13(year) ./api-ref/src/docbkx/api-ref-compute-v3.xml:13(year)
#: ./api-ref/src/docbkx/api-ref-compute-v2-ext.xml:13(year) ./api-ref/src/docbkx/api-ref-identity-v3.xml:13(year) ./api-ref/src/docbkx/api-ref-blockstorage-v1.xml:13(year) ./api-ref/src/docbkx/api-ref-objectstorage-v1.xml:13(year) ./api-ref/src/docbkx/api-ref.xml:13(year) ./api-ref/src/docbkx/api-ref-image-v2.xml:13(year) ./api-ref/src/docbkx/api-ref-orchestration-v1.xml:13(year) ./api-ref/src/docbkx/api-ref-networking-v2.xml:13(year) ./api-ref/src/docbkx/api-ref-compute-v2.xml:13(year) ./api-ref/src/docbkx/api-ref-image-v1.xml:13(year) ./api-ref/src/docbkx/api-ref-blockstorage-v2.xml:13(year) ./api-ref/src/docbkx/api-ref-identity-v2.xml:13(year) ./api-ref/src/docbkx/api-ref-databases-v1.xml:13(year) ./api-ref/src/docbkx/api-ref-compute-v3.xml:13(year)
msgid "2010-2014"
msgstr ""
@ -345,10 +345,6 @@ msgstr ""
msgid "Orchestration API v1 (CURRENT)"
msgstr ""
#: ./api-ref/src/docbkx/itemizedlist-service-list.xml:64(link) ./api-ref/src/docbkx/ch_telemetry-v2.xml:9(title)
msgid "Telemetry API v2 (CURRENT)"
msgstr ""
#: ./api-ref/src/docbkx/api-ref.xml:11(title)
msgid "OpenStack API Reference"
msgstr ""
@ -1545,10 +1541,6 @@ msgstr ""
msgid "Provide simple tenant usage for tenant."
msgstr ""
#: ./api-ref/src/docbkx/api-ref-telemetry-v2.xml:11(title)
msgid "OpenStack Telemetry API v2"
msgstr ""
#: ./api-ref/src/docbkx/ch_blockstorage-api-v1.xml:13(para)
msgid "When making an API call to create, list, or delete volume(s), the following status values are possible:"
msgstr ""
@ -1749,34 +1741,6 @@ msgstr ""
msgid "OpenStack Compute API v3"
msgstr ""
#: ./api-ref/src/docbkx/ch_telemetry-v2.xml:10(para)
msgid "Manage telemetry operations."
msgstr ""
#: ./api-ref/src/docbkx/ch_telemetry-v2.xml:12(title)
msgid "Alarms"
msgstr ""
#: ./api-ref/src/docbkx/ch_telemetry-v2.xml:13(para)
msgid "List, create, gets details for, update, and delete alarms."
msgstr ""
#: ./api-ref/src/docbkx/ch_telemetry-v2.xml:39(title)
msgid "Meters"
msgstr ""
#: ./api-ref/src/docbkx/ch_telemetry-v2.xml:40(para)
msgid "Get information for meters."
msgstr ""
#: ./api-ref/src/docbkx/ch_telemetry-v2.xml:58(title)
msgid "Resources"
msgstr ""
#: ./api-ref/src/docbkx/ch_telemetry-v2.xml:59(para)
msgid "Get information for resources."
msgstr ""
#: ./api-ref/src/docbkx/ch_identity-v3-ext.xml:13(title)
msgid "Identity API v3 extensions (STABLE)"
msgstr ""

36
restapi-doc/restapi-doc/api-ref/locale/fr.po
View File

@ -32,7 +32,6 @@ msgstr "Extensions de l'API de Calcul v2 OpenStack"
#: ./api-ref/src/docbkx/api-ref-networking-v2.xml13(year)
#: ./api-ref/src/docbkx/api-ref-compute-v2.xml13(year)
#: ./api-ref/src/docbkx/api-ref-image-v1.xml13(year)
#: ./api-ref/src/docbkx/api-ref-telemetry-v2.xml13(year)
#: ./api-ref/src/docbkx/api-ref-blockstorage-v2.xml13(year)
#: ./api-ref/src/docbkx/api-ref-identity-v2.xml13(year)
#: ./api-ref/src/docbkx/api-ref-databases-v1.xml13(year)
@ -487,9 +486,6 @@ msgid "Orchestration API v1 (CURRENT)"
msgstr "API d'Orchestration v1 (ACTUELLE)"
#: ./api-ref/src/docbkx/itemizedlist-service-list.xml64(link)
#: ./api-ref/src/docbkx/ch_telemetry-v2.xml9(title)
msgid "Telemetry API v2 (CURRENT)"
msgstr "API de Télémétrie v2 (ACTUELLE)"
#: ./api-ref/src/docbkx/api-ref.xml11(title)
msgid "OpenStack API Reference"
@ -1935,10 +1931,6 @@ msgstr "Ajoute launched_at et terminated_at aux serveurs."
msgid "Provide simple tenant usage for tenant."
msgstr "Donne l'utilisation du client simple pour le client."
#: ./api-ref/src/docbkx/api-ref-telemetry-v2.xml11(title)
msgid "OpenStack Telemetry API v2"
msgstr "API de Télémétrie v2 OpenStack"
#: ./api-ref/src/docbkx/ch_blockstorage-api-v1.xml13(para)
msgid ""
"When making an API call to create, list, or delete volume(s), the following "
@ -2178,34 +2170,6 @@ msgstr "API du Service de Base de données v1.0 OpenStack"
msgid "OpenStack Compute API v3"
msgstr "API de Calcul v3 OpenStack"
#: ./api-ref/src/docbkx/ch_telemetry-v2.xml10(para)
msgid "Manage telemetry operations."
msgstr "Gérer les opérations de télémétrie."
#: ./api-ref/src/docbkx/ch_telemetry-v2.xml12(title)
msgid "Alarms"
msgstr "Alarmes"
#: ./api-ref/src/docbkx/ch_telemetry-v2.xml13(para)
msgid "List, create, gets details for, update, and delete alarms."
msgstr "Liste, crée, obtient les informations, modifie, et supprime les alarmes."
#: ./api-ref/src/docbkx/ch_telemetry-v2.xml39(title)
msgid "Meters"
msgstr "Mètres"
#: ./api-ref/src/docbkx/ch_telemetry-v2.xml40(para)
msgid "Get information for meters."
msgstr " Obtient les informations des métriques."
#: ./api-ref/src/docbkx/ch_telemetry-v2.xml58(title)
msgid "Resources"
msgstr "Ressources"
#: ./api-ref/src/docbkx/ch_telemetry-v2.xml59(para)
msgid "Get information for resources."
msgstr "Obtenir les informations pour les resources."
#: ./api-ref/src/docbkx/ch_identity-v3-ext.xml13(title)
msgid "Identity API v3 extensions (STABLE)"
msgstr "Extensions de l'API de Gestion des Identités v3 (STABLE)"

11
restapi-doc/restapi-doc/api-ref/pom.xml
View File

@ -98,17 +98,6 @@ SPDX-License-Identifier: Apache-2.0
<pdfFilename>bk-api-ref-networking-v2-cgcs-ext</pdfFilename>
</configuration>
</execution>
<execution>
<id>os-api-ref-telemetry-v2-cgcs-ext</id>
<goals>
<goal>generate-html</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes>api-ref-telemetry-v2-cgcs-ext.xml</includes>
<pdfFilename>bk-api-ref-telemetry-v2-cgcs-ext</pdfFilename>
</configuration>
</execution>
<execution>
<id>os-api-ref-image-v2-cgcs-ext</id>
<goals>

30
restapi-doc/restapi-doc/api-ref/src/docbkx/api-ref-telemetry-v2-cgcs-ext.xml
View File

@ -1,30 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2014 Wind River Systems, Inc.
SPDX-License-Identifier: Apache-2.0
-->
<book xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0"
xml:id="api.openstack.org-telemetry-v2-cgcs-ext" status="CURRENT">
<info>
<title>Telemetry V2-TITANIUM-Extensions API</title>
<copyright>
<year>2014</year>
<holder>Wind River</holder>
</copyright>
<legalnotice role="apache2">
<para/>
</legalnotice>
<annotation>
<xi:include href="itemizedlist-service-list.xml"/>
</annotation>
</info>
<xi:include href="ch_telemetry-v2-cgcs-ext.xml"/>
</book>

97
restapi-doc/restapi-doc/api-ref/src/docbkx/ch_telemetry-v2-cgcs-ext.xml
View File

@ -1,97 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2014-2017 Wind River Systems, Inc.
SPDX-License-Identifier: Apache-2.0
-->
<!DOCTYPE chapter[
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
]>
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="telemetry-v2-cgcs-ext"
role="api-reference">
<title>Telemetry API v2 Titanium extensions</title>
<para>Titanium extensions to the OpenStack Telemetry API such as
Pipelines for outputting samples to CSV files.
</para>
<para>The typical port used for the Telemetry REST API is 8777.
However, proper technique would be to look up the ceilometer service endpoint in Keystone.</para>
<!--*******************************************************-->
<!-- EXTENSIONS -->
<!--*******************************************************-->
<section xml:id="telemetry-ext-list">
<title>Extensions</title>
<para>The Extensions entity lists all available extensions</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/telemetry-api/v2/cgcs-ext/telemetry-v2-cgcs-ext.wadl#extensions">
<wadl:method href="#listExtensions"/>
</wadl:resource>
<wadl:resource
href="../wadls/telemetry-api/v2/cgcs-ext/telemetry-v2-cgcs-ext.wadl#extensionget">
<wadl:method href="#getExtension"/>
</wadl:resource>
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- Meter Types -->
<!--*******************************************************-->
<section xml:id="telemetry-metertype-list">
<title>Meter Types</title>
<para>The Meter Types entity is modeled by Titanium extensions to
show unique meter types</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/telemetry-api/v2/cgcs-ext/telemetry-v2-cgcs-ext.wadl#metertypes">
<wadl:method href="#listMeterTypes"/>
</wadl:resource>
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- PIPELINES -->
<!--*******************************************************-->
<section xml:id="telemetry-ext-action">
<title>Pipeline</title>
<para>The Pipeline entity is modeled by Titanium extensions to
manipulate how samples are stored to CSV files</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/telemetry-api/v2/cgcs-ext/telemetry-v2-cgcs-ext.wadl#pipelines">
<wadl:method href="#listPipelines"/>
</wadl:resource>
<wadl:resource
href="../wadls/telemetry-api/v2/cgcs-ext/telemetry-v2-cgcs-ext.wadl#pipeline_id">
<wadl:method href="#getPipeline"/>
</wadl:resource>
<wadl:resource
href="../wadls/telemetry-api/v2/cgcs-ext/telemetry-v2-cgcs-ext.wadl#pipeline_id">
<wadl:method href="#modifyPipeline"/>
</wadl:resource>
</wadl:resources>
</section>
</chapter>

4
restapi-doc/restapi-doc/api-ref/src/docbkx/itemizedlist-service-list.xml
View File

@ -26,10 +26,6 @@ SPDX-License-Identifier: Apache-2.0
<para><link xlink:href="api-ref-blockstorage-v2-cgcs-ext.xml">Block Storage
API v2 Titanium extensions</link></para>
</listitem>
<listitem>
<para><link xlink:href="api-ref-telemetry-v2-cgcs-ext.html">Telemetry
API v2 Titanium extensions</link></para>
</listitem>
<listitem>
<para><link xlink:href="api-ref-image-v2-cgcs-ext.html">Image
API v2 Titanium extensions</link></para>

11
restapi-doc/restapi-doc/api-ref/src/wadls/telemetry-api/v2/api_samples/telemetry-v2-cgcs-ext/extension_get-response.json
View File

@ -1,11 +0,0 @@
{
"extensions" : {
"namespace" : "http://docs.windriver.org/tis/ext/wrs-pipelines/v1",
"name" : "wrs-pipelines",
"updated" : "2014-10-01T12:00:00-00:00",
"description" : "Windriver Telemetry Pipelines for managing the writing of Ceilometer PMs to a Comma-Separated-Value file.",
"alias" : "wrs-pipelines",
"links" : []
}
}

13
restapi-doc/restapi-doc/api-ref/src/wadls/telemetry-api/v2/api_samples/telemetry-v2-cgcs-ext/extension_list-response.json
View File

@ -1,13 +0,0 @@
{
"extensions" : [
{
"namespace" : "http://docs.windriver.org/tis/ext/wrs-pipelines/v1",
"name" : "wrs-pipelines",
"updated" : "2014-10-01T12:00:00-00:00",
"description" : "Windriver Telemetry Pipelines for managing the writing of Ceilometer PMs to a Comma-Separated-Value file.",
"alias" : "wrs-pipelines",
"links" : []
}
]
}

7
restapi-doc/restapi-doc/api-ref/src/wadls/telemetry-api/v2/api_samples/telemetry-v2-cgcs-ext/metertype_list-response.json
View File

@ -1,7 +0,0 @@
[
{
"name": "memory.usage",
"type": "gauge",
"unit": "MB"
}
]

11
restapi-doc/restapi-doc/api-ref/src/wadls/telemetry-api/v2/api_samples/telemetry-v2-cgcs-ext/pipeline_list-response.json
View File

@ -1,11 +0,0 @@
[
{
"name": "csv",
"compress": true,
"enabled": true,
"meters": ["!vswitch.*"],
"location": "/opt/cgcs/ceilometer/csv/pm.csv",
"backup_count": 5,
"max_bytes": 10000000
}
]

8
restapi-doc/restapi-doc/api-ref/src/wadls/telemetry-api/v2/api_samples/telemetry-v2-cgcs-ext/pipeline_modify-request.json
View File

@ -1,8 +0,0 @@
{"name": "csv",
"compress": false,
"enabled": false,
"meters": ["!vswitch.*", "!cpu_util"],
"location": "/opt/cgcs/ceilometer/csv/pm2.csv",
"backup_count": 4,
"max_bytes": 9999999
}

10
restapi-doc/restapi-doc/api-ref/src/wadls/telemetry-api/v2/api_samples/telemetry-v2-cgcs-ext/pipeline_modify-response.json
View File

@ -1,10 +0,0 @@
{
"name": "csv",
"compress": false,
"enabled": false,
"meters": ["!vswitch.*", "!cpu_util"],
"location": "/opt/cgcs/ceilometer/csv/pm2.csv",
"backup_count": 4,
"max_bytes": 9999999
}

9
restapi-doc/restapi-doc/api-ref/src/wadls/telemetry-api/v2/api_samples/telemetry-v2-cgcs-ext/pipeline_show-response.json
View File

@ -1,9 +0,0 @@
{
"name": "csv",
"compress": true,
"enabled": true,
"meters": ["!vswitch.*"],
"location": "/opt/cgcs/ceilometer/csv/pm.csv",
"backup_count": 5,
"max_bytes": 10000000
}

229
restapi-doc/restapi-doc/api-ref/src/wadls/telemetry-api/v2/cgcs-ext/telemetry-v2-cgcs-ext.wadl
View File

@ -1,229 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2014-2017 Wind River Systems, Inc.
SPDX-License-Identifier: Apache-2.0
-->
<!DOCTYPE application [<!ENTITY % common SYSTEM "../common.ent">
%common;]>
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<!-- REMOVED xmlns:csapi="http://docs.openstack.org/telemetry/api/v2" -->
<!--*******************************************************-->
<!-- RESOURCES -->
<!--*******************************************************-->
<resources base="https://windriver.com/cgcs-restapi/ceilometer/"
xml:id="telemetry-v2-cgcs-ext">
<!-- /v2 -->
<resource id="version" type="#VersionDetails" path="//v2">
<!-- /v2/extensions -->
<resource id="extensions" path="extensions">
<method href="#listExtensions"/>
<!-- /v2/extensions/{extension_alias} -->
<resource path="{extension_alias}" id="extensionget">
<param name="extension_alias" style="template"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The alias for the extension
to list.</para>
</wadl:doc>
</param>
<method href="#getExtension"/>
</resource>
</resource>
<!-- /v2/metertypes -->
<resource id="metertypes" path="wrs-metertypes">
<method href="#listMeterTypes"/>
</resource>
<!-- /v2/wrs-pipelines -->
<resource id="pipelines" path="wrs-pipelines">
<method href="#listPipelines"/>
<!-- /v2/wrs-pipelines/{pipeline_id} -->
<resource id="pipeline_id" path="{pipeline_id}">
<param name="pipeline_id" style="template"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The name for the pipeline.</para>
</wadl:doc>
</param>
<method href="#getPipeline"/>
<method href="#modifyPipeline"/>
</resource>
</resource>
</resource>
</resources>
<!--*******************************************************-->
<!-- METHODS -->
<!--*******************************************************-->
<method name="GET" id="listExtensions">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List extensions">
<para role="shortdesc">Lists all extensions.</para>
<para></para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&extensionListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../api_samples/telemetry-v2-cgcs-ext/extension_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="getExtension">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Get extension">
<para role="shortdesc">Gets information about a specified extension.</para>
<para></para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&extensionListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../api_samples/telemetry-v2-cgcs-ext/extension_get-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="listMeterTypes">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List metertypes">
<para role="shortdesc">Lists meter types.</para>
<para></para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" 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 name of the Meter Type</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="type" style="plain" 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 type of the Meter Type</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="unit" style="plain" 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 unit of the Meter Type</para>
</wadl:doc>
</param>
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../api_samples/telemetry-v2-cgcs-ext/metertype_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="listPipelines">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List pipelines">
<para role="shortdesc">Lists all pipelines.</para>
<para></para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&pipelineListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../api_samples/telemetry-v2-cgcs-ext/pipeline_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="getPipeline">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show pipeline">
<para role="shortdesc">Shows detailed information about a specific pipeline that outputs to CSV.</para>
<para></para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&pipelineListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../api_samples/telemetry-v2-cgcs-ext/pipeline_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="PUT" id="modifyPipeline">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Modify pipeline">
<para role="shortdesc">Modifies a specific pipeline.</para>
<para>Performance of the entire system can be impacted by storing too much data to CSV</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&pipelineListUpdateParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../api_samples/telemetry-v2-cgcs-ext/pipeline_modify-request.json"/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&pipelineListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../api_samples/telemetry-v2-cgcs-ext/pipeline_modify-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
</application>

240
restapi-doc/restapi-doc/api-ref/src/wadls/telemetry-api/v2/common.ent
View File

@ -1,240 +0,0 @@
<!--
A collection of common faults, these are pretty much expected
in every request.
-->
<!ENTITY commonFaults
'
<response xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:computeFault"/>
<representation mediaType="application/json"/>
</response>
<response status="503" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="400" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:overLimit"/>
<representation mediaType="application/json"/>
</response>
'>
<!--
Faults on GET
-->
<!ENTITY getFaults
'
<response status="404" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:itemNotFound"/>
<representation mediaType="application/json"/>
</response>'>
<!--
Faults on POST/PUT
-->
<!ENTITY postPutFaults
'
<response status="415" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:badMediaType"/>
<representation mediaType="application/json"/>
</response>
<response status="400" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:NetworkNotFound"/>
<representation mediaType="application/json"/>
</response>'>
<!ENTITY rebootFaults
'<response status="422" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:HTTPUnprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
'>
<!--
Faults that can occur when we are building servers or images.
-->
<!ENTITY buildFaults
'
<response status="503" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:serverCapacityUnavailable"/>
<representation mediaType="application/json"/>
</response>
'>
<!--
Holds build in progress which occurs when an operation fails
because the server is in the process of being built.
-->
<!ENTITY inProgressFault
'
<response status="409" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:buildInProgress"/>
<representation mediaType="application/json"/>
</response>
'>
<!-- Extension List/Show Parameters -->
<!ENTITY extensionListShowParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="namespace" style="plain" 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 namespace of the extension.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" 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 name of the extension.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="updated" style="plain" 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 updated time of the extension.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="description" style="plain" 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 description of the extension.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="alias" style="plain" 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 alias of the extension.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="links" style="plain" type="xsd:list" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>A list of links for the extension.</para>
</wadl:doc>
</param>
'>
<!-- Pipeline List/Show Parameters -->
<!ENTITY pipelineListShowParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" 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 name of the CSV pipeline.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="compress" style="plain" type="xsd:bool" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Indicates whether or not to compress the CSV file when rotating.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="enabled" style="plain" type="xsd:bool" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Indicates whether or not to enable this CSV pipeline.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="meters" style="plain" type="xsd:list" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>A regular expression of the meters piped to CSV.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="location" style="plain" 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 full path to the CSV output file. The folder is restricted.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="backup_count" style="plain" type="xsd:int" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The number of backed up CSV files to preserve.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="max_bytes" style="plain" type="xsd:int" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The size in bytes to allow the CSV file to grow before triggering rotating and compressing.</para>
</wadl:doc>
</param>
'>
<!ENTITY pipelineListUpdateParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="compress" style="plain" type="xsd:bool" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Indicates whether or not to compress the CSV file when rotating.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="enabled" style="plain" type="xsd:bool" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Indicates whether or not to enable this CSV pipeline.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="meters" style="plain" type="xsd:list" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>A regular expression of the meters piped to CSV</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="location" 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>The full path to the CSV output file. The folder is restricted</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="backup_count" style="plain" type="xsd:int" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The number of backed up CSV files to preserve. It can be any number from 0. No backup file will be generated when backup_count is set to 0</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="max_bytes" style="plain" type="xsd:int" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The size in bytes to allow the CSV file to grow before triggering rotating and compressing. It can be any number from 0. No rotating and compressing will be triggered when max_bytes is set to 0</para>
</wadl:doc>
</param>
'>
<!-- Useful for describing APIs -->
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>