openstack/api-site
Code Issues Proposed changes

Update Data Processing API to spellcheck and make other changes

Browse Source 
- Remove passive voice from api-site
- Renamed code samples using this naming convention:
  <resource>-<action>-request.json or <resource>-<action>-response.json.
  For example, volume-create-request.json and volume-create-response.json.
- Removed unused code samples
- Made method names consistent throughout - use list<resource> for list
  operations, show<resource> for show operations, and so on.
- Remove XML code samples
- Change csapi:uuid -> csapi:UUID

Change-Id: I1cc7043ec8e64b4c4a21d9f462bd2f2ae544d57a
Partial-Bug: #1521244
This commit is contained in:
Diane Fleming
2015-12-14 20:36:11 -06:00
parent d0338d4e23
commit 331c5947d8
84 changed files with 356 additions and 543 deletions
Download Patch File Download Diff File Expand all files Collapse all files

184
api-ref/src/docbkx/ch_data-processing-v1.1.xml
View File

@@ -15,44 +15,20 @@
A plugin object defines the Hadoop or Spark version that it can
install and which configurations can be set for the cluster.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/plugins.wadl#plugins">
<wadl:method href="#pluginslist"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/plugins.wadl#pluginSimple">
<wadl:method href="#pluginsget"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/plugins.wadl#pluginDetailed">
<wadl:method href="#pluginsgetversion"/>
</wadl:resource>
</wadl:resources>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
href="../wadls/dataprocessing-api/src/v1.1/wadl/plugins.wadl"/>
</section>
<section xml:id="v1.1imageregistry">
<title>Image registry</title>
<para>
Use the image registry tool to manage images. Use this tool to add
tags to and remove tags from images and define the user name for
an instance operating system. Each plugin lists required tags for
an image. For remote operations execution, the Data Processing
service requires a user name to log in to the operating system for
an instance.
Use the image registry tool to manage images, add tags to and
remove tags from images, and define the user name for an instance
operating system. Each plugin lists required tags for an image. To
run remote operations, the Data Processing service requires a user
name with which to log in to the operating system for an instance.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/image-registry.wadl#images">
<wadl:method href="#imageslist"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/image-registry.wadl#imageId">
<wadl:method href="#imageInfo"/>
<wadl:method href="#imageReg"/>
<wadl:method href="#imageUnreg"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/image-registry.wadl#imageTag">
<wadl:method href="#addTags"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/image-registry.wadl#imageUntag">
<wadl:method href="#removeTags"/>
</wadl:resource>
</wadl:resources>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
href="../wadls/dataprocessing-api/src/v1.1/wadl/image-registry.wadl"/>
</section>
<section xml:id="v1.1nodegrouptemplate">
<title>Node group templates</title>
@@ -66,17 +42,8 @@
CPUs, and the amount of RAM. The template specifies the VM
characteristics through an OpenStack flavor.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/node-group-template.wadl#node-group-templates">
<wadl:method href="#node-group-templates-list"/>
<wadl:method href="#node-group-templates-create"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/node-group-template.wadl#node_group_template_id">
<wadl:method href="#node-group-templates-get"/>
<wadl:method href="#node-group-templates-delete"/>
<wadl:method href="#node-group-templates-update"/>
</wadl:resource>
</wadl:resources>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
href="../wadls/dataprocessing-api/src/v1.1/wadl/node-group-template.wadl"/>
</section>
<section xml:id="v1.1clustertemplate">
<title>Cluster templates</title>
@@ -86,38 +53,16 @@
can also define cluster-scoped configurations in a cluster
template.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/cluster-templates.wadl#cluster-templates">
<wadl:method href="#cluster-templates-list"/>
<wadl:method href="#cluster-templates-create"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/cluster-templates.wadl#cluster_template_id">
<wadl:method href="#cluster-templates-show"/>
<wadl:method href="#cluster-templates-update"/>
<wadl:method href="#cluster-templates-delete"/>
</wadl:resource>
</wadl:resources>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
href="../wadls/dataprocessing-api/src/v1.1/wadl/cluster-templates.wadl"/>
</section>
<section xml:id="v1.1clusters">
<title>Clusters</title>
<para>
A cluster is a group of nodes with the same configuration.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/clusters.wadl#clusters">
<wadl:method href="#clusters-list"/>
<wadl:method href="#clusters-create"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/clusters.wadl#multiple-clusters">
<wadl:method href="#multiple-clusters-create"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/clusters.wadl#cluster_id">
<wadl:method href="#clusters-get"/>
<wadl:method href="#clusters-delete"/>
<wadl:method href="#clusters-scale"/>
<wadl:method href="#clusters-update"/>
</wadl:resource>
</wadl:resources>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
href="../wadls/dataprocessing-api/src/v1.1/wadl/clusters.wadl"/>
</section>
<section xml:id="v1.1event-log">
<title>Event log</title>
@@ -125,11 +70,8 @@
The event log feature provides information about cluster provisioning.
In the event of errors, the event log shows the reason for the failure.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/event-log.wadl#cluster_id">
<wadl:method href="#show-progress"/>
</wadl:resource>
</wadl:resources>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
href="../wadls/dataprocessing-api/src/v1.1/wadl/event-log.wadl"/>
</section>
<section xml:id="v1.1datasources">
<title>Data sources</title>
@@ -141,17 +83,8 @@
The Data Processing service does not validate data source
locations.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/data-sources.wadl#data-sources">
<wadl:method href="#dataSourcesList"/>
<wadl:method href="#dataSourcesCreate"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/data-sources.wadl#dataSourceId">
<wadl:method href="#dataSourceInfo"/>
<wadl:method href="#dataSourceDelete"/>
<wadl:method href="#dataSourceUpdate"/>
</wadl:resource>
</wadl:resources>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
href="../wadls/dataprocessing-api/src/v1.1/wadl/data-sources.wadl"/>
</section>
<section xml:id="v1.1jobbinary-internals">
<title>Job binary internals</title>
@@ -159,26 +92,8 @@
Job binary internal objects represent data processing applications
and libraries that are stored in the internal database.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/dataprocessing-api/src/v1.1/wadl/job-binary-internals.wadl#job-binary-internals">
<wadl:method href="#job-binary-internals-list"/>
</wadl:resource>
<wadl:resource
href="../wadls/dataprocessing-api/src/v1.1/wadl/job-binary-internals.wadl#job-binary-internals-name-create">
<wadl:method href="#job-binary-internals-create"/>
</wadl:resource>
<wadl:resource
href="../wadls/dataprocessing-api/src/v1.1/wadl/job-binary-internals.wadl#job-binary-internals-id">
<wadl:method href="#job-binary-internals-show"/>
<wadl:method href="#job-binary-internals-delete"/>
<wadl:method href="#job-binary-internals-update"/>
</wadl:resource>
<wadl:resource
href="../wadls/dataprocessing-api/src/v1.1/wadl/job-binary-internals.wadl#job-binary-internals-id-data">
<wadl:method href="#job-binary-internals-data"/>
</wadl:resource>
</wadl:resources>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
href="../wadls/dataprocessing-api/src/v1.1/wadl/job-binary-internals.wadl"/>
</section>
<section xml:id="v1.1jobbinaries">
<title>Job binaries</title>
@@ -187,20 +102,8 @@
libraries that are stored in either the internal database or the
Object Storage service.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/job-binaries.wadl#job-binaries">
<wadl:method href="#job-binaries-list"/>
<wadl:method href="#job-binaries-create"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/job-binaries.wadl#job-binaries-id">
<wadl:method href="#job-binaries-show"/>
<wadl:method href="#job-binaries-delete"/>
<wadl:method href="#job-binaries-update"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/job-binaries.wadl#job-binaries-id-data">
<wadl:method href="#job-binaries-data"/>
</wadl:resource>
</wadl:resources>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
href="../wadls/dataprocessing-api/src/v1.1/wadl/job-binaries.wadl"/>
</section>
<section xml:id="v1.1jobs">
<title>Jobs</title>
@@ -211,20 +114,8 @@
<para>
You can run a job on an existing or new transient cluster.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/jobs.wadl#jobs">
<wadl:method href="#jobsList"/>
<wadl:method href="#jobCreate"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/jobs.wadl#jobId">
<wadl:method href="#jobInfo"/>
<wadl:method href="#jobDelete"/>
<wadl:method href="#jobUpdate"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/jobs.wadl#execute">
<wadl:method href="#jobExecute"/>
</wadl:resource>
</wadl:resources>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
href="../wadls/dataprocessing-api/src/v1.1/wadl/jobs.wadl"/>
</section>
<section xml:id="v1.1jobexecutions">
<title>Job executions</title>
@@ -233,22 +124,8 @@
cluster. A job execution polls the status of a running job and
reports it to the user. Also a user can cancel a running job.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/job-executions.wadl#job-executions">
<wadl:method href="#job-executions-list"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/job-executions.wadl#job_execution_id">
<wadl:method href="#job-executions-show"/>
<wadl:method href="#job-executions-delete"/>
<wadl:method href="#job-executions-update"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/job-executions.wadl#refresh-status">
<wadl:method href="#job-executions-refresh"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/job-executions.wadl#cancel">
<wadl:method href="#job-executions-cancel"/>
</wadl:resource>
</wadl:resources>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
href="../wadls/dataprocessing-api/src/v1.1/wadl/job-executions.wadl"/>
</section>
<section xml:id="v1.1jobtypes">
<title>Job types</title>
@@ -262,10 +139,7 @@
The job types provide information about which plugins support
which job types and how to configure the job types.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/job-types.wadl#job-types">
<wadl:method href="#jobTypesList"/>
</wadl:resource>
</wadl:resources>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
href="../wadls/dataprocessing-api/src/v1.1/wadl/job-types.wadl"/>
</section>
</chapter>

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/cluster-templates/create-req.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/cluster-templates/cluster-template-create-request.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/cluster-templates/create-resp.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/cluster-templates/cluster-template-create-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/cluster-templates/show-resp.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/cluster-templates/cluster-template-show-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/cluster-templates/update-req.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/cluster-templates/cluster-template-update-request.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/cluster-templates/update-resp.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/cluster-templates/cluster-template-update-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/cluster-templates/list-resp.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/cluster-templates/cluster-templates-list-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/clusters/clusters-create-req.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/clusters/cluster-create-request.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/clusters/clusters-create-resp.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/clusters/cluster-create-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/clusters/clusters-scale-req.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/clusters/cluster-scale-request.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/clusters/clusters-scale-resp.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/clusters/cluster-scale-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/clusters/clusters-get.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/clusters/cluster-show-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/clusters/clusters-update-req.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/clusters/cluster-update-request.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/clusters/clusters-update-resp.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/clusters/cluster-update-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/clusters/clusters-list.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/clusters/clusters-list-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/clusters/multiple-clusters-create-req.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/clusters/multiple-clusters-create-request.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/clusters/multiple-clusters-create-resp.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/clusters/multiple-clusters-create-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/data-sources/data-source-register-hdfs-req.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/data-sources/data-source-register-hdfs-request.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/data-sources/data-source-register-hdfs-resp.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/data-sources/data-source-register-hdfs-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/data-sources/data-source-register-swift-req.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/data-sources/data-source-register-swift-request.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/data-sources/data-source-register-swift-resp.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/data-sources/data-source-register-swift-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/data-sources/data-sources-get-resp.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/data-sources/data-source-show-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/data-sources/data-source-update-req.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/data-sources/data-source-update-request.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/data-sources/data-source-update-resp.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/data-sources/data-source-update-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/data-sources/data-sources-list-resp.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/data-sources/data-sources-list-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/event-log/cluster-resp.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/event-log/cluster-progress-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/image-registry/images-set-req.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/image-registry/image-register-request.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/image-registry/images-set-resp.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/image-registry/image-register-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/image-registry/images-get-resp.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/image-registry/image-show-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/image-registry/image-tags-add-req.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/image-registry/image-tags-add-request.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/image-registry/image-tags-add-resp.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/image-registry/image-tags-add-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/image-registry/image-tags-delete-req.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/image-registry/image-tags-delete-request.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/image-registry/image-tags-delete-resp.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/image-registry/image-tags-delete-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/image-registry/images-list-resp.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/image-registry/images-list-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/job-binaries/create-req.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/job-binaries/create-request.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/job-binaries/create-resp.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/job-binaries/create-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/job-binaries/list-resp.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/job-binaries/list-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/job-binaries/show-resp.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/job-binaries/show-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/job-binaries/update-req.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/job-binaries/update-request.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/job-binaries/update-resp.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/job-binaries/update-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/job-binary-internals/create-resp.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/job-binary-internals/create-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/job-binary-internals/list-resp.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/job-binary-internals/list-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/job-binary-internals/show-resp.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/job-binary-internals/show-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/job-binary-internals/update-req.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/job-binary-internals/update-request.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/job-binary-internals/update-resp.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/job-binary-internals/update-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/job-executions/cancel-resp.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/job-executions/cancel-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/job-executions/job-ex-resp.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/job-executions/job-ex-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/job-executions/job-ex-update-req.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/job-executions/job-ex-update-request.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/job-executions/job-ex-update-resp.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/job-executions/job-ex-update-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/job-executions/list-resp.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/job-executions/list-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/job-types/job-types-get-resp.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/job-types/job-types-list-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/jobs/job-create-req.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/jobs/job-create-request.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/jobs/job-create-resp.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/jobs/job-create-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/jobs/job-execute-req.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/jobs/job-execute-request.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/jobs/job-execute-resp.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/jobs/job-execute-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/jobs/job-get-resp.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/jobs/job-show-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/jobs/job-update-req.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/jobs/job-update-request.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/jobs/job-update-resp.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/jobs/job-update-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/jobs/job-list-resp.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/jobs/jobs-list-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/node-group-templates/node-group-templates-create-req.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/node-group-templates/node-group-template-create-request.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/node-group-templates/node-group-templates-create-resp.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/node-group-templates/node-group-template-create-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/node-group-templates/node-group-templates-get.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/node-group-templates/node-group-template-show-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/node-group-templates/node-group-templates-update-req.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/node-group-templates/node-group-template-update-request.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/node-group-templates/node-group-templates-update-resp.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/node-group-templates/node-group-template-update-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/node-group-templates/node-group-templates-list.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/node-group-templates/node-group-templates-list-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/plugins-get-response.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/plugins/plugin-show-response.json
View File

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/plugins-get-version-response.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/plugins/plugin-version-show-response.json
View File

12
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/plugins/plugins-get-resp.json
View File

@@ -1,12 +0,0 @@
{
"plugin": {
"name": "vanilla",
"versions": [
"1.2.1",
"2.4.1",
"2.6.0"
],
"title": "Vanilla Apache Hadoop",
"description": "The Apache Vanilla plugin provides the ability to launch upstream Vanilla Apache Hadoop cluster without any management consoles. It can also deploy the Oozie component."
}
}

92
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/plugins/plugins-get-version-resp.json
View File

@@ -1,92 +0,0 @@
{
"plugin": {
"name": "vanilla",
"versions": [
"1.2.1",
"2.4.1",
"2.6.0"
],
"description": "The Apache Vanilla plugin provides the ability to launch upstream Vanilla Apache Hadoop cluster without any management consoles. It can also deploy the Oozie component.",
"required_image_tags": [
"vanilla",
"2.6.0"
],
"node_processes": {
"JobFlow": [
"oozie"
],
"HDFS": [
"namenode",
"datanode",
"secondarynamenode"
],
"YARN": [
"resourcemanager",
"nodemanager"
],
"MapReduce": [
"historyserver"
],
"Hadoop": [],
"Hive": [
"hiveserver"
]
},
"configs": [
{
"default_value": "/tmp/hadoop-${user.name}",
"name": "hadoop.tmp.dir",
"priority": 2,
"config_type": "string",
"applicable_target": "HDFS",
"is_optional": true,
"scope": "node",
"description": "A base for other temporary directories."
},
{
"default_value": true,
"name": "hadoop.native.lib",
"priority": 2,
"config_type": "bool",
"applicable_target": "HDFS",
"is_optional": true,
"scope": "node",
"description": "Should native hadoop libraries, if present, be used."
},
{
"default_value": 1024,
"name": "NodeManager Heap Size",
"config_values": null,
"priority": 1,
"config_type": "int",
"applicable_target": "YARN",
"is_optional": false,
"scope": "node",
"description": null
},
{
"default_value": true,
"name": "Enable Swift",
"config_values": null,
"priority": 1,
"config_type": "bool",
"applicable_target": "general",
"is_optional": false,
"scope": "cluster",
"description": null
},
{
"default_value": true,
"name": "Enable MySQL",
"config_values": null,
"priority": 1,
"config_type": "bool",
"applicable_target": "general",
"is_optional": true,
"scope": "cluster",
"description": null
}
],
"title": "Vanilla Apache Hadoop"
}
}

41
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/plugins/plugins-list-resp.json
View File

@@ -1,41 +0,0 @@
{
"plugins": [
{
"name": "vanilla",
"description": "The Apache Vanilla plugin provides the ability to launch upstream Vanilla Apache Hadoop cluster without any management consoles. It can also deploy the Oozie component.",
"versions": [
"1.2.1",
"2.4.1",
"2.6.0"
],
"title": "Vanilla Apache Hadoop"
},
{
"name": "hdp",
"description": "The Hortonworks Sahara plugin automates the deployment of the Hortonworks Data Platform (HDP) on OpenStack.",
"versions": [
"1.3.2",
"2.0.6"
],
"title": "Hortonworks Data Platform"
},
{
"name": "spark",
"description": "This plugin provides an ability to launch Spark on Hadoop CDH cluster without any management consoles.",
"versions": [
"1.0.0",
"0.9.1"
],
"title": "Apache Spark"
},
{
"name": "cdh",
"description": "The Cloudera Sahara plugin provides the ability to launch the Cloudera distribution of Apache Hadoop (CDH) with Cloudera Manager management console.",
"versions": [
"5",
"5.3.0"
],
"title": "Cloudera Plugin"
}
]
}

0
api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/plugins-list-response.json → api-ref/src/wadls/dataprocessing-api/src/v1.1/samples/plugins/plugins-list-response.json
View File

45
api-ref/src/wadls/dataprocessing-api/src/v1.1/wadl/cluster-templates.wadl
View File

@@ -27,17 +27,17 @@
<resource id="tenant_id" path="{tenant_id}">
&tenant_idTemplateParameter;
<resource id="cluster-templates" path="cluster-templates">
<method href="#cluster-templates-list"/>
<method href="#cluster-templates-create"/>
<method href="#listClusterTemplates"/>
<method href="#createClusterTemplate"/>
<resource id="cluster_template_id" path="{cluster_template_id}">
<param name="cluster_template_id" style="template" type="capi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of the cluster template.</para>
</wadl:doc>
</param>
<method href="#cluster-templates-show"/>
<method href="#cluster-templates-update"/>
<method href="#cluster-templates-delete"/>
<method href="#showClusterTemplate"/>
<method href="#updateClusterTemplate"/>
<method href="#deleteClusterTemplate"/>
</resource>
</resource>
</resource>
@@ -46,8 +46,8 @@
<!-- *******************************************************-->
<!-- Cluster templates actions -->
<!--******************************************************-->
<method name="GET" id="cluster-templates-list">
<wadl:doc xml:lang="EN" title="List available cluster templates"
<method name="GET" id="listClusterTemplates">
<wadl:doc xml:lang="EN" title="List cluster templates"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists available cluster
templates.</para>
@@ -56,14 +56,14 @@
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../samples/cluster-templates/list-resp.json"
href="../samples/cluster-templates/cluster-templates-list-response.json"
/>
</wadl:doc>
&clustertemplateResponseParameters;
</representation>
</response>
</method>
<method name="POST" id="cluster-templates-create">
<method name="POST" id="createClusterTemplate">
<wadl:doc xml:lang="EN" title="Create cluster templates"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Creates a cluster template.</para>
@@ -73,49 +73,50 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Create cluster template: JSON request">
<xsdxt:code
href="../samples/cluster-templates/create-req.json"
href="../samples/cluster-templates/cluster-template-create-request.json"
/>
</wadl:doc>
</representation>
</request>
<response status="202">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" title="Create cluster template: JSON response">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Create cluster template: JSON response">
<xsdxt:code
href="../samples/cluster-templates/create-resp.json"
href="../samples/cluster-templates/cluster-template-create-response.json"
/>
</wadl:doc>
&clustertemplateResponseParameters;
</representation>
</response>
</method>
<method name="GET" id="cluster-templates-show">
<wadl:doc xml:lang="EN" title="Show cluster template"
<method name="GET" id="showClusterTemplate">
<wadl:doc xml:lang="EN" title="Show cluster template details"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Shows the cluster template.</para>
<para role="shortdesc">Shows details for a cluster template.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../samples/cluster-templates/list-resp.json"
href="../samples/cluster-templates/cluster-templates-list-response.json"
/>
</wadl:doc>
&clustertemplateResponseParameters;
</representation>
</response>
</method>
<method name="PUT" id="cluster-templates-update">
<method name="PUT" id="updateClusterTemplate">
<wadl:doc xml:lang="EN" title="Update cluster templates"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Updates the cluster template.</para>
<para role="shortdesc">Updates a cluster template.</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Update the cluster template: JSON request">
<xsdxt:code
href="../samples/cluster-templates/update-req.json"
href="../samples/cluster-templates/cluster-template-update-request.json"
/>
</wadl:doc>
</representation>
@@ -124,17 +125,17 @@
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../samples/cluster-templates/update-resp.json"
href="../samples/cluster-templates/cluster-template-update-response.json"
/>
</wadl:doc>
&clustertemplateResponseParameters;
</representation>
</response>
</method>
<method name="DELETE" id="cluster-templates-delete">
<method name="DELETE" id="deleteClusterTemplate">
<wadl:doc xml:lang="EN" title="Delete cluster template"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Deletes the cluster template.</para>
<para role="shortdesc">Deletes a cluster template.</para>
</wadl:doc>
<response status="204"/>
</method>

80
api-ref/src/wadls/dataprocessing-api/src/v1.1/wadl/clusters.wadl
View File

@@ -27,22 +27,22 @@
<resource id="tenant_id" path="{tenant_id}">
&tenant_idTemplateParameter;
<resource id="clusters" path="clusters">
<method href="#clusters-list"/>
<method href="#clusters-create"/>
<method href="#listClusters"/>
<method href="#createCluster"/>
<resource id="multiple-clusters" path="multiple">
<method href="#multiple-clusters-create"/>
<method href="#createMultipleClusters"/>
</resource>
<resource id="cluster_id"
path="{cluster_id}">
<resource id="cluster_id" path="{cluster_id}">
<param name="cluster_id" style="template" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The ID of the cluster</para>
</wadl:doc>
</param>
<method href="#clusters-get"/>
<method href="#clusters-delete"/>
<method href="#clusters-scale"/>
<method href="#clusters-update"/>
<method href="#showCluster"/>
<method href="#scaleCluster"/>
<method href="#updateCluster"/>
<method href="#showClusterProgress"/>
<method href="#deleteCluster"/>
</resource>
</resource>
</resource>
@@ -51,7 +51,7 @@
<!-- *******************************************************-->
<!-- OS Cluster actions -->
<!--******************************************************-->
<method name="GET" id="clusters-list">
<method name="GET" id="listClusters">
<wadl:doc xml:lang="EN" title="List available clusters"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists available clusters.</para>
@@ -60,7 +60,7 @@
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../samples/clusters/clusters-list.json"
href="../samples/clusters/clusters-list-response.json"
/>
</wadl:doc>
&clustersResponseParameters;
@@ -68,23 +68,23 @@
</representation>
</response>
</method>
<method name="GET" id="clusters-get">
<method name="GET" id="clusters-show">
<wadl:doc xml:lang="EN" title="Show details of a cluster"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Shows cluster by ID.</para>
<para role="shortdesc">Shows details for a cluster, by ID.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../samples/clusters/clusters-get.json"
href="../samples/clusters/cluster-show-response.json"
/>
</wadl:doc>
&clustersResponseParameters;
</representation>
</response>
</method>
<method name="POST" id="clusters-create">
<method name="POST" id="createCluster">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create cluster">
<para role="shortdesc">Creates a cluster.</para>
@@ -94,7 +94,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Create cluster: JSON request">
<xsdxt:code
href="../samples/clusters/clusters-create-req.json"
href="../samples/clusters/cluster-create-request.json"
/>
</wadl:doc>
</representation>
@@ -103,14 +103,14 @@
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../samples/clusters/clusters-create-resp.json"
href="../samples/clusters/cluster-create-response.json"
/>
</wadl:doc>
&clustersResponseParameters;
</representation>
</response>
</method>
<method name="POST" id="multiple-clusters-create">
<method name="POST" id="createMultipleClusters">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create multiple clusters">
<para role="shortdesc">Creates multiple clusters.</para>
@@ -120,7 +120,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/clusters/multiple-clusters-create-req.json"
href="../samples/clusters/multiple-clusters-create-request.json"
/>
</wadl:doc>
</representation>
@@ -129,20 +129,20 @@
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../samples/clusters/multiple-clusters-create-resp.json"
href="../samples/clusters/multiple-clusters-create-response.json"
/>
</wadl:doc>
</representation>
</response>
</method>
<method name="DELETE" id="clusters-delete">
<method name="DELETE" id="deleteCluster">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete a cluster">
<para role="shortdesc">Deletes a cluster.</para>
</wadl:doc>
<response status="204"/>
</method>
<method name="PUT" id="clusters-scale">
<method name="PUT" id="scaleCluster">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Scale cluster">
<para role="shortdesc">Scales a cluster.</para>
@@ -150,9 +150,9 @@
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Scale cluster : JSON request">
xml:lang="EN" title="Scale cluster: JSON request">
<xsdxt:code
href="../samples/clusters/clusters-scale-req.json"
href="../samples/clusters/cluster-scale-request.json"
/>
</wadl:doc>
</representation>
@@ -161,14 +161,14 @@
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../samples/clusters/clusters-scale-resp.json"
href="../samples/clusters/cluster-scale-response.json"
/>
</wadl:doc>
&clustersResponseParameters;
</representation>
</response>
</method>
<method name="PATCH" id="clusters-update">
<method name="PATCH" id="updateCluster">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Update cluster">
<para role="shortdesc">Updates a cluster.</para>
@@ -176,9 +176,9 @@
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Update cluster : JSON request">
xml:lang="EN" title="Update cluster: JSON request">
<xsdxt:code
href="../samples/clusters/clusters-update-req.json"
href="../samples/clusters/cluster-update-request.json"
/>
</wadl:doc>
</representation>
@@ -187,11 +187,33 @@
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../samples/clusters/clusters-update-resp.json"
href="../samples/clusters/cluster-update-response.json"
/>
</wadl:doc>
&clustersResponseParameters;
</representation>
</response>
</method>
<method name="GET" id="showCluster-progress">
<wadl:doc xml:lang="EN" title="Show progress"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Shows provisioning progress for a cluster.</para>
</wadl:doc>
<request>
<param name="show-progress" style="plain" type="xsd:boolean" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Cluster provisioning progress.</para>
</wadl:doc>
</param>
</request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../samples/event-log/cluster-progress-response.json"
/>
</wadl:doc>
</representation>
</response>
</method>
</application>

57
api-ref/src/wadls/dataprocessing-api/src/v1.1/wadl/common.ent
View File

@@ -11,6 +11,61 @@
</para>
</wadl:doc>
</param>'>
<!ENTITY data_source_idTemplateParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="data_source_id" style="template" type="capi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The UUID of the data source.
</para>
</wadl:doc>
</param>'>
<!ENTITY image_idTemplateParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="image_id" style="template" type="capi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The UUID of the image.
</para>
</wadl:doc>
</param>'>
<!ENTITY job_binary_idTemplateParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="job_binary_id" style="template" type="capi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The UUID of the job binary.
</para>
</wadl:doc>
</param>'>
<!ENTITY plugin_nameTemplateParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="plugin_name" style="template" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Name of the plugin.
</para>
</wadl:doc>
</param>'>
<!ENTITY versionTemplateParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="version" style="template" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Version of the plugin.
</para>
</wadl:doc>
</param>'>
<!-- Response parameters of the Data processing APIs -->
<!ENTITY pluginResponseParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
@@ -57,7 +112,7 @@
</para>
</wadl:doc>
</param>'>
<!ENTITY imageregResponseParameters '
<!ENTITY registerImageResponseParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" required="true"
type="xsd:string">

66
api-ref/src/wadls/dataprocessing-api/src/v1.1/wadl/data-sources.wadl
View File

@@ -27,17 +27,13 @@
<resource id="tenant_id" path="{tenant_id}">
&tenant_idTemplateParameter;
<resource id="data-sources" path="data-sources">
<method href="#dataSourcesList"/>
<method href="#dataSourcesCreate"/>
<resource id="dataSourceId" path="{data_source_id}">
<param name="data_source_id" style="template" type="capi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of the data source.</para>
</wadl:doc>
</param>
<method href="#dataSourceInfo"/>
<method href="#dataSourceDelete"/>
<method href="#dataSourceUpdate"/>
<method href="#listDataSources"/>
<method href="#createDataSource"/>
<resource id="data_source_id" path="{data_source_id}">
&data_source_idTemplateParameter;
<method href="#showDataSource"/>
<method href="#updateDataSource"/>
<method href="#deleteDataSource"/>
</resource>
</resource>
</resource>
@@ -46,17 +42,19 @@
<!-- *******************************************************-->
<!-- data sources -->
<!--*******************************************************-->
<method name="GET" id="dataSourcesList">
<method name="GET" id="listDataSources">
<wadl:doc xml:lang="EN" title="List data sources"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists all data sources.</para>
<para role="shortdesc">
Lists all data sources.
</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/data-sources/data-sources-list-resp.json"
href="../samples/data-sources/data-sources-list-response.json"
/>
</wadl:doc>
&datasourceResponseParameters;
@@ -64,17 +62,19 @@
</representation>
</response>
</method>
<method name="GET" id="dataSourceInfo">
<method name="GET" id="showDataSource">
<wadl:doc xml:lang="EN" title="Show data source details"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Shows details for a data source.</para>
<para role="shortdesc">
Shows details for a data source.
</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/data-sources/data-sources-get-resp.json"
href="../samples/data-sources/data-source-show-response.json"
/>
</wadl:doc>
&datasourceResponseParameters;
@@ -82,17 +82,19 @@
</representation>
</response>
</method>
<method name="POST" id="dataSourcesCreate">
<method name="POST" id="createDataSource">
<wadl:doc xml:lang="EN" title="Create data source"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Creates a data source.</para>
<para role="shortdesc">
Creates a data source.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/data-sources/data-source-register-swift-req.json"
href="../samples/data-sources/data-source-register-swift-request.json"
/>
</wadl:doc>
</representation>
@@ -100,7 +102,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/data-sources/data-source-register-hdfs-req.json"
href="../samples/data-sources/data-source-register-hdfs-request.json"
/>
</wadl:doc>
</representation>
@@ -110,7 +112,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/data-sources/data-source-register-swift-resp.json"
href="../samples/data-sources/data-source-register-swift-response.json"
/>
</wadl:doc>
</representation>
@@ -118,7 +120,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/data-sources/data-source-register-hdfs-resp.json"
href="../samples/data-sources/data-source-register-hdfs-response.json"
/>
</wadl:doc>
&datasourceResponseParameters;
@@ -126,24 +128,28 @@
</representation>
</response>
</method>
<method name="DELETE" id="dataSourceDelete">
<method name="DELETE" id="deleteDataSource">
<wadl:doc xml:lang="EN" title="Delete data source"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Deletes a data source.</para>
<para role="shortdesc">
Deletes a data source.
</para>
</wadl:doc>
<response status="204"/>
</method>
<method name="PUT" id="dataSourceUpdate">
<method name="PUT" id="updateDataSource">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Update data source">
<para role="shortdesc">Updates a data source.</para>
<para role="shortdesc">
Updates a data source.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Update data source : JSON request">
xml:lang="EN" title="Update data source: JSON request">
<xsdxt:code
href="../samples/data-sources/data-source-update-req.json"
href="../samples/data-sources/data-source-update-request.json"
/>
</wadl:doc>
</representation>
@@ -152,7 +158,7 @@
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../samples/data-sources/data-source-update-resp.json"
href="../samples/data-sources/data-source-update-response.json"
/>
</wadl:doc>
</representation>

12
api-ref/src/wadls/dataprocessing-api/src/v1.1/wadl/event-log.wadl
View File

@@ -31,10 +31,10 @@
path="{cluster_id}">
<param name="cluster_id" style="template" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The ID of the cluster</para>
<para>The UUID of the cluster</para>
</wadl:doc>
</param>
<method href="#show-progress"/>
<method href="#showClusterProgress"/>
</resource>
</resource>
</resource>
@@ -43,15 +43,15 @@
<!-- *******************************************************-->
<!-- Event log actions -->
<!--********************************************************-->
<method name="GET" id="show-progress">
<method name="GET" id="showClusterProgress">
<wadl:doc xml:lang="EN" title="Show progress"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Shows provisioning progress of cluster.</para>
</wadl:doc>
<request>
<param name="show-progress" style="plain" type="xsd:boolean" required="true">
<param name="showClusterProgress" style="plain" type="xsd:boolean" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Flag, which show cluster provisioning progress.</para>
<para>The cluster provisioning progress.</para>
</wadl:doc>
</param>
</request>
@@ -59,7 +59,7 @@
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../samples/event-log/cluster-resp.json"
href="../samples/event-log/cluster-progress-response.json"
/>
</wadl:doc>
</representation>

54
api-ref/src/wadls/dataprocessing-api/src/v1.1/wadl/image-registry.wadl
View File

@@ -27,16 +27,12 @@
<resource id="tenant_id" path="{tenant_id}">
&tenant_idTemplateParameter;
<resource id="images" path="images">
<method href="#imageslist"/>
<method href="#listImages"/>
<resource id="imageId" path="{image_id}">
<param name="image_id" style="template" type="capi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of the image.</para>
</wadl:doc>
</param>
<method href="#imageInfo"/>
<method href="#imageReg"/>
<method href="#imageUnreg"/>
&image_idTemplateParameter;
<method href="#showImage"/>
<method href="#registerImage"/>
<method href="#unregisterImage"/>
<resource id="imageTag" path="tag">
<method href="#addTags"/>
</resource>
@@ -51,10 +47,10 @@
<!-- *******************************************************-->
<!-- Image Registry -->
<!--*******************************************************-->
<method name="GET" id="imageslist">
<method name="GET" id="listImages">
<wadl:doc xml:lang="EN" title="List images"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists all images registered in the image registry.</para>
<para role="shortdesc">Lists all images registered in the registry.</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
@@ -73,48 +69,48 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/image-registry/images-list-resp.json"
href="../samples/image-registry/images-list-response.json"
/>
</wadl:doc>
&imageregResponseParameters;
&registerImageResponseParameters;
&imagesResponseParameter;
</representation>
</response>
</method>
<method name="GET" id="imageInfo">
<method name="GET" id="showImage">
<wadl:doc xml:lang="EN" title="Show image details"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Shows details about an image.</para>
<para role="shortdesc">Shows details for an image.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/image-registry/images-get-resp.json"
href="../samples/image-registry/image-show-response.json"
/>
</wadl:doc>
&imageregResponseParameters;
&registerImageResponseParameters;
</representation>
</response>
</method>
<method name="POST" id="imageReg">
<method name="POST" id="registerImage">
<wadl:doc xml:lang="EN" title="Register image"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Registers an image in the image registry.</para>
<para role="shortdesc">Registers an image in the registry.</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/image-registry/images-set-req.json"
href="../samples/image-registry/image-register-request.json"
/>
</wadl:doc>
<param name="username" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
The user name to log in to an instance OS for
The user name to log in to an instance operating system for
remote operations execution.
</para>
</wadl:doc>
@@ -131,17 +127,17 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/image-registry/images-set-resp.json"
href="../samples/image-registry/image-register-response.json"
/>
</wadl:doc>
&imageregResponseParameters;
&registerImageResponseParameters;
</representation>
</response>
</method>
<method name="DELETE" id="imageUnreg">
<method name="DELETE" id="unregisterImage">
<wadl:doc xml:lang="EN" title="Unregister image"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Removes an image from the image registry.</para>
<para role="shortdesc">Removes an image from the registry.</para>
</wadl:doc>
<response status="204"/>
</method>
@@ -155,7 +151,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/image-registry/image-tags-add-req.json"
href="../samples/image-registry/image-tags-add-request.json"
/>
</wadl:doc>
<param name="tags" style="plain" type="xsd:string" required="true">
@@ -170,7 +166,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/image-registry/image-tags-add-resp.json"
href="../samples/image-registry/image-tags-add-response.json"
/>
</wadl:doc>
</representation>
@@ -186,7 +182,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/image-registry/image-tags-delete-req.json"
href="../samples/image-registry/image-tags-delete-request.json"
/>
</wadl:doc>
<param name="tags" style="plain" type="xsd:string" required="true">
@@ -201,7 +197,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/image-registry/image-tags-add-resp.json"
href="../samples/image-registry/image-tags-add-response.json"
/>
</wadl:doc>
</representation>

74
api-ref/src/wadls/dataprocessing-api/src/v1.1/wadl/job-binaries.wadl
View File

@@ -27,20 +27,16 @@
<resource id="tenant_id" path="{tenant_id}">
&tenant_idTemplateParameter;
<resource id="job-binaries" path="job-binaries">
<method href="#job-binaries-list"/>
<method href="#job-binaries-create"/>
<resource id="job-binaries-id" path="{job_binaries_id}">
<param name="job_binaries_id" style="template" type="capi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The ID of the job binary.</para>
</wadl:doc>
</param>
<method href="#job-binaries-show"/>
<method href="#job-binaries-delete"/>
<method href="#job-binaries-update"/>
<method href="#listJobBinaries"/>
<method href="#jcreateJobBinary"/>
<resource id="job-binary-id" path="{job_binary_id}">
&job_binary_idTemplateParameter;
<resource id="job-binaries-id-data" path="data">
<method href="#job-binaries-data"/>
<method href="#showJobBinaryData"/>
</resource>
<method href="#showJobBinary"/>
<method href="#updateJobBinary"/>
<method href="#deleteJobBinary"/>
</resource>
</resource>
</resource>
@@ -49,16 +45,18 @@
<!-- *******************************************************-->
<!-- Job binary actions -->
<!-- *******************************************************-->
<method name="GET" id="job-binaries-list">
<method name="GET" id="listJobBinaries">
<wadl:doc xml:lang="EN" title="List job binaries"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists the available job binaries.</para>
<para role="shortdesc">
Lists the available job binaries.
</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../samples/job-binaries/list-resp.json"
href="../samples/job-binaries/list-response.json"
/>
</wadl:doc>
&binariesParameter;
@@ -70,13 +68,15 @@
<method name="POST" id="job-binaries-create">
<wadl:doc xml:lang="EN" title="Create job binary"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Creates a job binary.</para>
<para role="shortdesc">
Creates a job binary.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../samples/job-binaries/create-req.json"
href="../samples/job-binaries/create-request.json"
/>
</wadl:doc>
</representation>
@@ -85,7 +85,7 @@
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../samples/job-binaries/create-resp.json"
href="../samples/job-binaries/create-response.json"
/>
</wadl:doc>
&jobbinaryResponseParameters;
@@ -96,14 +96,15 @@
<method name="GET" id="job-binaries-show">
<wadl:doc xml:lang="EN" title="Show job binary details"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Shows details for a
job binary.</para>
<para role="shortdesc">
Shows details for a job binary.
</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../samples/job-binaries/show-resp.json"
href="../samples/job-binaries/show-response.json"
/>
</wadl:doc>
&jobbinaryResponseParameters;
@@ -118,15 +119,18 @@
</wadl:doc>
<response status="204"/>
</method>
<method name="GET" id="job-binaries-data">
<wadl:doc xml:lang="EN" title="Get job binary data"
<method name="GET" id="showJobBinaryData">
<wadl:doc xml:lang="EN" title="Show job binary data"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Gets data for a job
binary.</para>
<para>The response body shows the job binary raw data and
the response headers show the data length.</para>
<para role="shortdesc">
Shows data for a job binary.
</para>
<para>
The response body shows the job binary raw data and the
response headers show the data length.
</para>
<para>Example response:</para>
<para><programlisting>HTTP/1.1 200 OK
<programlisting>HTTP/1.1 200 OK
Connection: keep-alive
Content-Length: 161
Content-Type: text/html; charset=utf-8
@@ -134,14 +138,16 @@ Date: Sat, 28 Mar 2015 02:42:48 GMT
A = load '$INPUT' using PigStorage(':') as (fruit: chararray);
B = foreach A generate com.hadoopbook.pig.Trim(fruit);
store B into '$OUTPUT' USING PigStorage();</programlisting></para>
store B into '$OUTPUT' USING PigStorage();</programlisting>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<param name="Content-Length" style="header" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The length of the returned data in bytes.</para>
<para>
The length of the data, in bytes.
</para>
</wadl:doc>
</param>
<!-- the following element is present to suppress the output
@@ -152,14 +158,16 @@ store B into '$OUTPUT' USING PigStorage();</programlisting></para>
<method name="PUT" id="job-binaries-update">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Update job binary">
<para role="shortdesc">Updates a job binary.</para>
<para role="shortdesc">
Updates a job binary.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Update job binary : JSON request">
<xsdxt:code
href="../samples/job-binaries/update-req.json"
href="../samples/job-binaries/update-request.json"
/>
</wadl:doc>
</representation>
@@ -168,7 +176,7 @@ store B into '$OUTPUT' USING PigStorage();</programlisting></para>
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../samples/job-binaries/update-resp.json"
href="../samples/job-binaries/update-response.json"
/>
</wadl:doc>
</representation>

20
api-ref/src/wadls/dataprocessing-api/src/v1.1/wadl/job-binary-internals.wadl
View File

@@ -38,9 +38,9 @@
<method href="#job-binary-internals-create"/>
</resource>
<resource id="job-binary-internals-id" path="{job_binary_internals_id}">
<param name="job_binary_internals_id" style="template" type="capi:UUID">
<param name="job_binary_internals_id" style="template" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The ID of the job binary internal.</para>
<para>The UUID of the job binary internal.</para>
</wadl:doc>
</param>
<method href="#job-binary-internals-show"/>
@@ -67,7 +67,7 @@
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../samples/job-binary-internals/list-resp.json"
href="../samples/job-binary-internals/list-response.json"
/>
</wadl:doc>
&jobbinaryInternalsResponseParameters;
@@ -97,7 +97,7 @@
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../samples/job-binary-internals/create-resp.json"
href="../samples/job-binary-internals/create-response.json"
/>
</wadl:doc>
&jobbinaryInternalsResponseParameters;
@@ -115,7 +115,7 @@
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../samples/job-binary-internals/show-resp.json"
href="../samples/job-binary-internals/show-response.json"
/>
</wadl:doc>
&jobbinaryInternalsResponseParameters;
@@ -132,9 +132,9 @@
<response status="204"/>
</method>
<method name="GET" id="job-binary-internals-data">
<wadl:doc xml:lang="EN" title="Get job binary internal data"
<wadl:doc xml:lang="EN" title="Show job binary internal data"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Gets data for a job
<para role="shortdesc">Shows data for a job
binary internal.</para>
<para>The response body shows the job binary raw data and
the response headers show the data length.</para>
@@ -154,7 +154,7 @@ store B into '$OUTPUT' USING PigStorage(); </programlisting></para>
<param name="Content-Length" style="header" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The length of the returned data in bytes.</para>
<para>The length of the data, in bytes.</para>
</wadl:doc>
</param>
<!-- the following element is present to suppress the output
@@ -172,7 +172,7 @@ store B into '$OUTPUT' USING PigStorage(); </programlisting></para>
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Update job binary internal : JSON request">
<xsdxt:code
href="../samples/job-binary-internals/update-req.json"
href="../samples/job-binary-internals/update-request.json"
/>
</wadl:doc>
</representation>
@@ -181,7 +181,7 @@ store B into '$OUTPUT' USING PigStorage(); </programlisting></para>
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../samples/job-binary-internals/update-resp.json"
href="../samples/job-binary-internals/update-response.json"
/>
</wadl:doc>
</representation>

16
api-ref/src/wadls/dataprocessing-api/src/v1.1/wadl/job-executions.wadl
View File

@@ -29,9 +29,9 @@
<resource id="job-executions" path="job-executions">
<method href="#job-executions-list"/>
<resource id="job_execution_id" path="{job_execution_id}">
<param name="job_execution_id" style="template" type="capi:UUID">
<param name="job_execution_id" style="template" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of the job execution.</para>
<para>The UUID of the job execution.</para>
</wadl:doc>
</param>
<method href="#job-executions-show"/>
@@ -62,7 +62,7 @@
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../samples/job-executions/list-resp.json"
href="../samples/job-executions/list-response.json"
/>
</wadl:doc>
&jobexecutionsParameter;
@@ -81,7 +81,7 @@
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../samples/job-executions/job-ex-resp.json"
href="../samples/job-executions/job-ex-response.json"
/>
</wadl:doc>
&jobexecutionResponseParameters;
@@ -100,7 +100,7 @@
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../samples/job-executions/job-ex-resp.json"
href="../samples/job-executions/job-ex-response.json"
/>
</wadl:doc>
&jobexecutionResponseParameters;
@@ -118,7 +118,7 @@
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../samples/job-executions/cancel-resp.json"
href="../samples/job-executions/cancel-response.json"
/>
</wadl:doc>
&jobexecutionResponseParameters;
@@ -144,7 +144,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/job-executions/job-ex-update-req.json"
href="../samples/job-executions/job-ex-update-request.json"
/>
</wadl:doc>
</representation>
@@ -154,7 +154,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/job-executions/job-ex-update-resp.json"
href="../samples/job-executions/job-ex-update-response.json"
/>
</wadl:doc>
&jobexecutionResponseParameters;

22
api-ref/src/wadls/dataprocessing-api/src/v1.1/wadl/job-types.wadl
View File

@@ -27,7 +27,7 @@
<resource id="tenant_id" path="{tenant_id}">
&tenant_idTemplateParameter;
<resource id="job-types" path="job-types">
<method href="#jobTypesList"/>
<method href="#listJobTypes"/>
</resource>
</resource>
</resource>
@@ -35,36 +35,36 @@
<!-- *******************************************************-->
<!-- Job Types -->
<!--*******************************************************-->
<method name="GET" id="jobTypesList">
<method name="GET" id="listJobTypes">
<wadl:doc xml:lang="EN" title="List job types"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">
Lists job types.
Lists all job types.
</para>
<para>
You can filter the response through filter parameters.
You can use query parameters to filter the response.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<param name="plugin" style="template" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Filter results by plugin name.</para>
</wadl:doc>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Filters the response by a plugin name.</para>
</wadl:doc>
</param>
<param name="version" style="template" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Filter results by plugin version.</para>
<para>Filters the response by a plugin version.</para>
</wadl:doc>
</param>
<param name="type" style="template" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Filter results by job type.</para>
<para>Filters the response by a job type.</para>
</wadl:doc>
</param>
<param name="hints" style="template" type="xsd:bool">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Include configuration hints in results.</para>
<para>Includes configuration hints in the response.</para>
</wadl:doc>
</param>
</representation>
@@ -74,7 +74,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/job-types/job-types-get-resp.json"
href="../samples/job-types/job-types-list-response.json"
/>
</wadl:doc>
&jobtypesResponseParameters;

44
api-ref/src/wadls/dataprocessing-api/src/v1.1/wadl/jobs.wadl
View File

@@ -27,19 +27,19 @@
<resource id="tenant_id" path="{tenant_id}">
&tenant_idTemplateParameter;
<resource id="jobs" path="jobs">
<method href="#jobsList"/>
<method href="#jobCreate"/>
<resource id="jobId" path="{job_id}">
<method href="#listJobs"/>
<method href="#createJob"/>
<resource id="job_id" path="{job_id}">
<param name="job_id" style="template" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of the job.</para>
<para>The UUID of the job.</para>
</wadl:doc>
</param>
<method href="#jobInfo"/>
<method href="#jobDelete"/>
<method href="#jobUpdate"/>
<method href="#showJob"/>
<method href="#deleteJob"/>
<method href="#updateJob"/>
<resource id="execute" path="execute">
<method href="#jobExecute"/>
<method href="#runJob"/>
</resource>
</resource>
</resource>
@@ -49,7 +49,7 @@
<!-- *******************************************************-->
<!-- jobs -->
<!--*******************************************************-->
<method name="GET" id="jobsList">
<method name="GET" id="listJobs">
<wadl:doc xml:lang="EN" title="List jobs"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists all jobs.</para>
@@ -59,7 +59,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/jobs/job-list-resp.json"
href="../samples/jobs/jobs-list-response.json"
/>
</wadl:doc>
&jobsResponseParameter;
@@ -68,7 +68,7 @@
</representation>
</response>
</method>
<method name="GET" id="jobInfo">
<method name="GET" id="showJob">
<wadl:doc xml:lang="EN" title="Show job details"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Shows details for a job.</para>
@@ -78,7 +78,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/jobs/job-get-resp.json"
href="../samples/jobs/job-show-response.json"
/>
</wadl:doc>
&jobResponseParameters;
@@ -86,7 +86,7 @@
</representation>
</response>
</method>
<method name="POST" id="jobCreate">
<method name="POST" id="createJob">
<wadl:doc xml:lang="EN" title="Create job"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Creates a job object.</para>
@@ -96,7 +96,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/jobs/job-create-req.json"
href="../samples/jobs/job-create-request.json"
/>
</wadl:doc>
</representation>
@@ -106,7 +106,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/jobs/job-create-resp.json"
href="../samples/jobs/job-create-response.json"
/>
</wadl:doc>
&jobResponseParameters;
@@ -114,14 +114,14 @@
</representation>
</response>
</method>
<method name="DELETE" id="jobDelete">
<method name="DELETE" id="deleteJob">
<wadl:doc xml:lang="EN" title="Remove job"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Removes a job.</para>
</wadl:doc>
<response status="204"/>
</method>
<method name="POST" id="jobExecute">
<method name="POST" id="runJob">
<wadl:doc xml:lang="EN" title="Run job"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Runs a job.</para>
@@ -131,7 +131,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/jobs/job-execute-req.json"
href="../samples/jobs/job-execute-request.json"
/>
</wadl:doc>
</representation>
@@ -141,13 +141,13 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/jobs/job-execute-resp.json"
href="../samples/jobs/job-execute-response.json"
/>
</wadl:doc>
</representation>
</response>
</method>
<method name="PATCH" id="jobUpdate">
<method name="PATCH" id="updateJob">
<wadl:doc xml:lang="EN" title="Update job object"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Updates a job object.</para>
@@ -157,7 +157,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/jobs/job-update-req.json"
href="../samples/jobs/job-update-request.json"
/>
</wadl:doc>
</representation>
@@ -167,7 +167,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/jobs/job-update-resp.json"
href="../samples/jobs/job-update-response.json"
/>
</wadl:doc>
&jobResponseParameters;

36
api-ref/src/wadls/dataprocessing-api/src/v1.1/wadl/node-group-template.wadl
View File

@@ -27,18 +27,18 @@
<resource id="tenant_id" path="{tenant_id}">
&tenant_idTemplateParameter;
<resource id="node-group-templates" path="node-group-templates">
<method href="#node-group-templates-list"/>
<method href="#node-group-templates-create"/>
<method href="#listNodeGroupTemplates"/>
<method href="#createNodeGroupTemplate"/>
<resource id="node_group_template_id"
path="{node_group_template_id}">
<param name="node_group_template_id" style="template" type="capi:UUID">
<param name="node_group_template_id" style="template" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of the node group template.</para>
<para>The UUID of the node group template.</para>
</wadl:doc>
</param>
<method href="#node-group-templates-get"/>
<method href="#node-group-templates-delete"/>
<method href="#node-group-templates-update"/>
<method href="#showNodeGroupTemplate"/>
<method href="#deleteNodeGroupTemplate"/>
<method href="#updateNodeGroupTemplate"/>
</resource>
</resource>
</resource>
@@ -47,7 +47,7 @@
<!-- *******************************************************-->
<!-- OS Node group templates actions -->
<!--******************************************************-->
<method name="GET" id="node-group-templates-list">
<method name="GET" id="listNodeGroupTemplates">
<wadl:doc xml:lang="EN" title="List node group templates"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists available node group
@@ -58,14 +58,14 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/node-group-templates/node-group-templates-list.json"
href="../samples/node-group-templates/node-group-templates-list-response.json"
/>
</wadl:doc>
&nodegrouptemplatesRespParameters;
</representation>
</response>
</method>
<method name="GET" id="node-group-templates-get">
<method name="GET" id="showNodeGroupTemplate">
<wadl:doc xml:lang="EN" title="Show node group template details"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Shows a node group template, by ID.</para>
@@ -75,14 +75,14 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/node-group-templates/node-group-templates-get.json"
href="../samples/node-group-templates/node-group-template-show-response.json"
/>
</wadl:doc>
&nodegrouptemplatesRespParameters;
</representation>
</response>
</method>
<method name="POST" id="node-group-templates-create">
<method name="POST" id="createNodeGroupTemplate">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create node group template">
<para role="shortdesc">Creates a node group template.</para>
@@ -92,7 +92,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/node-group-templates/node-group-templates-create-req.json"
href="../samples/node-group-templates/node-group-template-create-request.json"
/>
</wadl:doc>
</representation>
@@ -102,21 +102,21 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/node-group-templates/node-group-templates-create-resp.json"
href="../samples/node-group-templates/node-group-template-create-response.json"
/>
</wadl:doc>
&nodegrouptemplatesRespParameters;
</representation>
</response>
</method>
<method name="DELETE" id="node-group-templates-delete">
<method name="DELETE" id="deleteNodeGroupTemplate">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete node group template">
<para role="shortdesc">Deletes a node group template.</para>
</wadl:doc>
<response status="204"/>
</method>
<method name="PUT" id="node-group-templates-update">
<method name="PUT" id="updateNodeGroupTemplate">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Update node group template">
<para role="shortdesc">Updates a node group template.</para>
@@ -126,7 +126,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/node-group-templates/node-group-templates-update-req.json"
href="../samples/node-group-templates/node-group-template-update-request.json"
/>
</wadl:doc>
</representation>
@@ -136,7 +136,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/node-group-templates/node-group-templates-update-resp.json"
href="../samples/node-group-templates/node-group-template-update-response.json"
/>
</wadl:doc>
</representation>

44
api-ref/src/wadls/dataprocessing-api/src/v1.1/wadl/plugins.wadl
View File

@@ -27,21 +27,13 @@
<resource id="tenant_id" path="{tenant_id}">
&tenant_idTemplateParameter;
<resource id="plugins" path="plugins">
<method href="#pluginslist"/>
<method href="#listPlugins"/>
<resource id="pluginSimple" path="{plugin_name}">
<param name="plugin_name" style="template" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Name of the plugin.</para>
</wadl:doc>
</param>
<method href="#pluginsget"/>
&plugin_nameTemplateParameter;
<method href="#showPlugin"/>
<resource id="pluginDetailed" path="{version}">
<param name="version" style="template" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Version of the plugin.</para>
</wadl:doc>
</param>
<method href="#pluginsgetversion"/>
&versionTemplateParameter;
<method href="#showPluginVersion"/>
</resource>
</resource>
</resource>
@@ -51,17 +43,19 @@
<!-- *******************************************************-->
<!-- Plugins -->
<!--*******************************************************-->
<method name="GET" id="pluginslist">
<method name="GET" id="listPlugins">
<wadl:doc xml:lang="EN" title="List plugins"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists all registered plugins.</para>
<para role="shortdesc">
Lists all registered plugins.
</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/plugins/plugins-list-resp.json"
href="../samples/plugins/plugins-list-response.json"
/>
</wadl:doc>
&pluginsParameter;
@@ -69,36 +63,38 @@
</representation>
</response>
</method>
<method name="GET" id="pluginsget">
<method name="GET" id="showPlugin">
<wadl:doc xml:lang="EN" title="Show plugin details"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Shows details for a
plugin.</para>
<para role="shortdesc">
Shows details for a plugin.
</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/plugins/plugins-get-resp.json"
href="../samples/plugins/plugin-show-response.json"
/>
</wadl:doc>
&pluginResponseParameters;
</representation>
</response>
</method>
<method name="GET" id="pluginsgetversion">
<method name="GET" id="showPluginVersion">
<wadl:doc xml:lang="EN" title="Show plugin version details"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Shows details for a
plugin version.</para>
<para role="shortdesc">
Shows details for a plugin version.
</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/plugins/plugins-get-version-resp.json"
href="../samples/plugins/plugin-version-show-response.json"
/>
</wadl:doc>
&pluginResponseParameters;