openstack/deb-sahara
Code Issues Proposed changes

Replacement of project name in api-ref.

Browse Source 
The keystone resource was renamed from 'tenant' to 'project',
this patch replaces 'tenant' with 'project' in api-ref
documents of sahara.

Change-Id: I1f41757b3ec90f88926681d4a0b7767764c37c4a
Closes-Bug: #1626678
This commit is contained in:
Gökhan IŞIK 2017-01-31 10:29:08 +00:00
parent 108a10bb55
commit c9681132a7
13 changed files with 134 additions and 128 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
api-ref/source/cluster-templates.inc
View File

@ -13,7 +13,7 @@ template.
Show cluster template details
=============================
.. rest_method:: GET /v1.1/{tenant_id}/cluster-templates/{cluster_template_id}
.. rest_method:: GET /v1.1/{project_id}/cluster-templates/{cluster_template_id}
Shows details for a cluster template.
@ -26,7 +26,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- cluster_template_id: cluster_template_id
@ -67,7 +67,7 @@ Response Example
Update cluster templates
========================
.. rest_method:: PUT /v1.1/{tenant_id}/cluster-templates/{cluster_template_id}
.. rest_method:: PUT /v1.1/{project_id}/cluster-templates/{cluster_template_id}
Updates a cluster template.
@ -79,7 +79,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- cluster_template_id: cluster_template_id
Request Example
@ -120,7 +120,7 @@ Response Parameters
Delete cluster template
=======================
.. rest_method:: DELETE /v1.1/{tenant_id}/cluster-templates/{cluster_template_id}
.. rest_method:: DELETE /v1.1/{project_id}/cluster-templates/{cluster_template_id}
Deletes a cluster template.
@ -132,7 +132,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- cluster_template_id: cluster_template_id
@ -143,7 +143,7 @@ Request
List cluster templates
======================
.. rest_method:: GET /v1.1/{tenant_id}/cluster-templates
.. rest_method:: GET /v1.1/{project_id}/cluster-templates
Lists available cluster templates.
@ -156,7 +156,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- limit: limit
- marker: marker
- sort_by: sort_by_cluster_templates
@ -191,7 +191,7 @@ Response Parameters
Response Example
----------------
.. rest_method:: GET /v1.1/{tenant_id}/cluster-templates?limit=2
.. rest_method:: GET /v1.1/{project_id}/cluster-templates?limit=2
.. literalinclude:: samples/cluster-templates/cluster-templates-list-response.json
:language: javascript
@ -202,7 +202,7 @@ Response Example
Create cluster templates
========================
.. rest_method:: POST /v1.1/{tenant_id}/cluster-templates
.. rest_method:: POST /v1.1/{project_id}/cluster-templates
Creates a cluster template.
@ -214,7 +214,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- project_id: project_id
Request Example

34
api-ref/source/clusters.inc
View File

@ -10,7 +10,7 @@ A cluster is a group of nodes with the same configuration.
List available clusters
=======================
.. rest_method:: GET /v1.1/{tenant_id}/clusters
.. rest_method:: GET /v1.1/{project_id}/clusters
Lists available clusters.
@ -23,7 +23,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- limit: limit
- marker: marker
- sort_by: sort_by_clusters
@ -55,7 +55,7 @@ Response Parameters
Response Example
----------------
.. rest_method:: GET /v1.1/{tenant_id}/clusters
.. rest_method:: GET /v1.1/{project_id}/clusters
.. literalinclude:: samples/clusters/clusters-list-response.json
:language: javascript
@ -66,7 +66,7 @@ Response Example
Create cluster
==============
.. rest_method:: POST /v1.1/{tenant_id}/clusters
.. rest_method:: POST /v1.1/{project_id}/clusters
Creates a cluster.
@ -78,7 +78,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
Request Example
@ -113,7 +113,7 @@ Response Parameters
Create multiple clusters
========================
.. rest_method:: POST /v1.1/{tenant_id}/clusters/multiple
.. rest_method:: POST /v1.1/{project_id}/clusters/multiple
Creates multiple clusters.
@ -125,7 +125,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
Request Example
@ -143,7 +143,7 @@ Request Example
Show details of a cluster
=========================
.. rest_method:: GET /v1.1/{tenant_id}/clusters/{cluster_id}
.. rest_method:: GET /v1.1/{project_id}/clusters/{cluster_id}
Shows details for a cluster, by ID.
@ -156,7 +156,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- cluster_id: cluster_id
@ -191,7 +191,7 @@ Response Example
Delete a cluster
================
.. rest_method:: DELETE /v1.1/{tenant_id}/clusters/{cluster_id}
.. rest_method:: DELETE /v1.1/{project_id}/clusters/{cluster_id}
Deletes a cluster.
@ -203,7 +203,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- cluster_id: cluster_id
@ -214,7 +214,7 @@ Request
Scale cluster
=============
.. rest_method:: PUT /v1.1/{tenant_id}/clusters/{cluster_id}
.. rest_method:: PUT /v1.1/{project_id}/clusters/{cluster_id}
Scales a cluster.
@ -226,7 +226,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- cluster_id: cluster_id
Request Example
@ -260,7 +260,7 @@ Response Parameters
Update cluster
==============
.. rest_method:: PATCH /v1.1/{tenant_id}/clusters/{cluster_id}
.. rest_method:: PATCH /v1.1/{project_id}/clusters/{cluster_id}
Updates a cluster.
@ -272,7 +272,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- cluster_id: cluster_id
Request Example
@ -306,7 +306,7 @@ Response Parameters
Show progress
=============
.. rest_method:: GET /v1.1/{tenant_id}/clusters/{cluster_id}
.. rest_method:: GET /v1.1/{project_id}/clusters/{cluster_id}
Shows provisioning progress for a cluster.
@ -319,7 +319,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- cluster_id: cluster_id

22
api-ref/source/data-sources.inc
View File

@ -14,7 +14,7 @@ locations.
Show data source details
========================
.. rest_method:: GET /v1.1/{tenant_id}/data-sources/{data_source_id}
.. rest_method:: GET /v1.1/{project_id}/data-sources/{data_source_id}
Shows details for a data source.
@ -27,7 +27,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- data_source_id: data_source_id
@ -61,7 +61,7 @@ Response Example
Delete data source
==================
.. rest_method:: DELETE /v1.1/{tenant_id}/data-sources/{data_source_id}
.. rest_method:: DELETE /v1.1/{project_id}/data-sources/{data_source_id}
Deletes a data source.
@ -73,7 +73,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- data_source_id: data_source_id
@ -84,7 +84,7 @@ Request
Update data source
==================
.. rest_method:: PUT /v1.1/{tenant_id}/data-sources/{data_source_id}
.. rest_method:: PUT /v1.1/{project_id}/data-sources/{data_source_id}
Updates a data source.
@ -96,7 +96,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- data_source_id: data_source_id
Request Example
@ -114,7 +114,7 @@ Request Example
List data sources
=================
.. rest_method:: GET /v1.1/{tenant_id}/data-sources
.. rest_method:: GET /v1.1/{project_id}/data-sources
Lists all data sources.
@ -127,7 +127,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- limit: limit
- marker: marker
- sort_by: sort_by_data_sources
@ -157,7 +157,7 @@ Response Parameters
Response Example
----------------
.. rest_method:: GET /v1.1/{tenant-id}/data-sourses?sort_by=-name
.. rest_method:: GET /v1.1/{project_id}/data-sourses?sort_by=-name
.. literalinclude:: samples/data-sources/data-sources-list-response.json
:language: javascript
@ -168,7 +168,7 @@ Response Example
Create data source
==================
.. rest_method:: POST /v1.1/{tenant_id}/data-sources
.. rest_method:: POST /v1.1/{project_id}/data-sources
Creates a data source.
@ -180,7 +180,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
Request Example

4
api-ref/source/event-log.inc
View File

@ -12,7 +12,7 @@ reason for the failure.
Show progress
=============
.. rest_method:: GET /v1.1/{tenant_id}/clusters/{cluster_id}
.. rest_method:: GET /v1.1/{project_id}/clusters/{cluster_id}
Shows provisioning progress of cluster.
@ -26,7 +26,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- cluster_id: cluster_id

24
api-ref/source/image-registry.inc
View File

@ -14,7 +14,7 @@ name with which to log in to the operating system for an instance.
Add tags to image
=================
.. rest_method:: POST /v1.1/{tenant_id}/images/{image_id}/tag
.. rest_method:: POST /v1.1/{project_id}/images/{image_id}/tag
Adds tags to an image.
@ -26,7 +26,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- tags: tags
- image_id: image_id
@ -45,7 +45,7 @@ Request Example
Show image details
==================
.. rest_method:: GET /v1.1/{tenant_id}/images/{image_id}
.. rest_method:: GET /v1.1/{project_id}/images/{image_id}
Shows details for an image.
@ -58,7 +58,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- image_id: image_id
@ -95,7 +95,7 @@ Response Example
Register image
==============
.. rest_method:: POST /v1.1/{tenant_id}/images/{image_id}
.. rest_method:: POST /v1.1/{project_id}/images/{image_id}
Registers an image in the registry.
@ -107,7 +107,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- username: username
- description: description
- image_id: image_id
@ -146,7 +146,7 @@ Response Parameters
Unregister image
================
.. rest_method:: DELETE /v1.1/{tenant_id}/images/{image_id}
.. rest_method:: DELETE /v1.1/{project_id}/images/{image_id}
Removes an image from the registry.
@ -158,7 +158,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- image_id: image_id
@ -169,7 +169,7 @@ Request
Remove tags from image
======================
.. rest_method:: POST /v1.1/{tenant_id}/images/{image_id}/untag
.. rest_method:: POST /v1.1/{project_id}/images/{image_id}/untag
Removes tags from an image.
@ -181,7 +181,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- tags: tags
- image_id: image_id
@ -200,7 +200,7 @@ Request Example
List images
===========
.. rest_method:: GET /v1.1/{tenant_id}/images
.. rest_method:: GET /v1.1/{project_id}/images
Lists all images registered in the registry.
@ -213,7 +213,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- tags: tags

26
api-ref/source/job-binaries.inc
View File

@ -12,7 +12,7 @@ Object Storage service.
List job binaries
=================
.. rest_method:: GET /v1.1/{tenant_id}/job-binaries
.. rest_method:: GET /v1.1/{project_id}/job-binaries
Lists the available job binaries.
@ -25,7 +25,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- limit: limit
- marker: marker
- sort_by: sort_by_job_binary
@ -55,7 +55,7 @@ Response Parameters
Response Example
----------------
.. rest_method:: GET /v1.1/{tenant_id}/job-binaries?sort_by=created_at
.. rest_method:: GET /v1.1/{project_id}/job-binaries?sort_by=created_at
.. literalinclude:: samples/job-binaries/list-response.json
:language: javascript
@ -66,7 +66,7 @@ Response Example
Create job binary
=================
.. rest_method:: POST /v1.1/{tenant_id}/job-binaries
.. rest_method:: POST /v1.1/{project_id}/job-binaries
Creates a job binary.
@ -78,7 +78,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
Request Example
@ -111,7 +111,7 @@ Response Parameters
Show job binary details
=======================
.. rest_method:: GET /v1.1/{tenant_id}/job-binaries/{job_binary_id}
.. rest_method:: GET /v1.1/{project_id}/job-binaries/{job_binary_id}
Shows details for a job binary.
@ -124,7 +124,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
@ -157,7 +157,7 @@ Response Example
Delete job binary
=================
.. rest_method:: DELETE /v1.1/{tenant_id}/job-binaries/{job_binary_id}
.. rest_method:: DELETE /v1.1/{project_id}/job-binaries/{job_binary_id}
Deletes a job binary.
@ -170,7 +170,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
@ -180,7 +180,7 @@ Request
Update job binary
=================
.. rest_method:: PUT /v1.1/{tenant_id}/job-binaries/{job_binary_id}
.. rest_method:: PUT /v1.1/{project_id}/job-binaries/{job_binary_id}
Updates a job binary.
@ -193,7 +193,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
Request Example
@ -211,7 +211,7 @@ Request Example
Show job binary data
====================
.. rest_method:: GET /v1.1/{tenant_id}/job-binaries/{job_binary_id}/data
.. rest_method:: GET /v1.1/{project_id}/job-binaries/{job_binary_id}/data
Shows data for a job binary.
@ -240,7 +240,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- job_binary_id: job_binary_id

26
api-ref/source/job-binary-internals.inc
View File

@ -11,7 +11,7 @@ and libraries that are stored in the internal database.
Create job binary internal
==========================
.. rest_method:: PUT /v1.1/{tenant_id}/job-binary-internals/{name}
.. rest_method:: PUT /v1.1/{project_id}/job-binary-internals/{name}
Creates a job binary internal.
@ -30,7 +30,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- name: name
@ -55,7 +55,7 @@ Response Parameters
Show job binary internal data
=============================
.. rest_method:: GET /v1.1/{tenant_id}/job-binary-internals/{job_binary_internals_id}/data
.. rest_method:: GET /v1.1/{project_id}/job-binary-internals/{job_binary_internals_id}/data
Shows data for a job binary internal.
@ -84,7 +84,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- job_binary_internals_id: job_binary_internals_id
@ -109,7 +109,7 @@ Response Example
Show job binary internal details
================================
.. rest_method:: GET /v1.1/{tenant_id}/job-binary-internals/{job_binary_internals_id}
.. rest_method:: GET /v1.1/{project_id}/job-binary-internals/{job_binary_internals_id}
Shows details for a job binary internal.
@ -122,7 +122,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- job_binary_internals_id: job_binary_internals_id
@ -154,7 +154,7 @@ Response Example
Delete job binary internal
==========================
.. rest_method:: DELETE /v1.1/{tenant_id}/job-binary-internals/{job_binary_internals_id}
.. rest_method:: DELETE /v1.1/{project_id}/job-binary-internals/{job_binary_internals_id}
Deletes a job binary internal.
@ -166,7 +166,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- job_binary_internals_id: job_binary_internals_id
@ -177,7 +177,7 @@ Request
Update job binary internal
==========================
.. rest_method:: PATCH /v1.1/{tenant_id}/job-binary-internals/{job_binary_internals_id}
.. rest_method:: PATCH /v1.1/{project_id}/job-binary-internals/{job_binary_internals_id}
Updates a job binary internal.
@ -189,7 +189,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- job_binary_internals_id: job_binary_internals_id
Request Example
@ -207,7 +207,7 @@ Request Example
List job binary internals
=========================
.. rest_method:: GET /v1.1/{tenant_id}/job-binary-internals
.. rest_method:: GET /v1.1/{project_id}/job-binary-internals
Lists the available job binary internals.
@ -220,7 +220,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- limit: limit
- marker: marker
- sort_by: sort_by_job_binary_internals
@ -249,7 +249,7 @@ Response Parameters
Response Example
----------------
.. rest_method:: GET /v1.1/{tenant_id}/job-binary-internals
.. rest_method:: GET /v1.1/{project_id}/job-binary-internals
.. literalinclude:: samples/job-binary-internals/list-response.json
:language: javascript

26
api-ref/source/job-executions.inc
View File

@ -12,7 +12,7 @@ reports it to the user. Also a user can cancel a running job.
Refresh job execution status
============================
.. rest_method:: GET /v1.1/{tenant_id}/job-executions/{job_execution_id}/refresh-status
.. rest_method:: GET /v1.1/{project_id}/job-executions/{job_execution_id}/refresh-status
Refreshes the status of and shows information for a job execution.
@ -25,7 +25,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- job_execution_id: job_execution_id
@ -69,7 +69,7 @@ Response Example
List job executions
===================
.. rest_method:: GET /v1.1/{tenant_id}/job-executions
.. rest_method:: GET /v1.1/{project_id}/job-executions
Lists available job executions.
@ -82,7 +82,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- limit: limit
- marker: marker
- sort_by: sort_by_job_execution
@ -123,7 +123,7 @@ Response Parameters
Response Example
----------------
.. rest_method:: /v1.1/{tenant_id}/job-executions
.. rest_method:: /v1.1/{project_id}/job-executions
.. literalinclude:: samples/job-executions/list-response.json
:language: javascript
@ -134,7 +134,7 @@ Response Example
Show job execution details
==========================
.. rest_method:: GET /v1.1/{tenant_id}/job-executions/{job_execution_id}
.. rest_method:: GET /v1.1/{project_id}/job-executions/{job_execution_id}
Shows details for a job execution, by ID.
@ -147,7 +147,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- job_execution_id: job_execution_id
@ -191,7 +191,7 @@ Response Example
Delete job execution
====================
.. rest_method:: DELETE /v1.1/{tenant_id}/job-executions/{job_execution_id}
.. rest_method:: DELETE /v1.1/{project_id}/job-executions/{job_execution_id}
Deletes a job execution.
@ -203,7 +203,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- job_execution_id: job_execution_id
@ -214,7 +214,7 @@ Request
Update job execution
====================
.. rest_method:: PATCH /v1.1/{tenant_id}/job-executions/{job_execution_id}
.. rest_method:: PATCH /v1.1/{project_id}/job-executions/{job_execution_id}
Updates a job execution.
@ -226,7 +226,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- job_execution_id: job_execution_id
Request Example
@ -270,7 +270,7 @@ Response Parameters
Cancel job execution
====================
.. rest_method:: GET /v1.1/{tenant_id}/job-executions/{job_execution_id}/cancel
.. rest_method:: GET /v1.1/{project_id}/job-executions/{job_execution_id}/cancel
Cancels a job execution.
@ -283,7 +283,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- job_execution_id: job_execution_id

4
api-ref/source/job-types.inc
View File

@ -15,7 +15,7 @@ job types and how to configure the job types.
List job types
==============
.. rest_method:: GET /v1.1/{tenant_id}/job-types
.. rest_method:: GET /v1.1/{project_id}/job-types
Lists all job types.
@ -31,7 +31,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- plugin: plugin
- version: version
- type: type

26
api-ref/source/jobs.inc
View File

@ -13,7 +13,7 @@ You can run a job on an existing or new transient cluster.
Run job
=======
.. rest_method:: POST /v1.1/{tenant_id}/jobs/{job_id}/execute
.. rest_method:: POST /v1.1/{project_id}/jobs/{job_id}/execute
Runs a job.
@ -25,7 +25,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- job_id: job_id
Request Example
@ -43,7 +43,7 @@ Request Example
List jobs
=========
.. rest_method:: GET /v1.1/{tenant_id}/jobs
.. rest_method:: GET /v1.1/{project_id}/jobs
Lists all jobs.
@ -56,7 +56,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- limit: limit
- marker: marker
- sort_by: sort_by_jobs
@ -88,7 +88,7 @@ Response Parameters
Response Example
----------------
..rest_method:: GET /v1.1/{tenant_id}/jobs?limit=2
..rest_method:: GET /v1.1/{project_id}/jobs?limit=2
.. literalinclude:: samples/jobs/jobs-list-response.json
:language: javascript
@ -99,7 +99,7 @@ Response Example
Create job
==========
.. rest_method:: POST /v1.1/{tenant_id}/jobs
.. rest_method:: POST /v1.1/{project_id}/jobs
Creates a job object.
@ -111,7 +111,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
Request Example
@ -147,7 +147,7 @@ Response Parameters
Show job details
================
.. rest_method:: GET /v1.1/{tenant_id}/jobs/{job_id}
.. rest_method:: GET /v1.1/{project_id}/jobs/{job_id}
Shows details for a job.
@ -160,7 +160,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- job_id: job_id
@ -196,7 +196,7 @@ Response Example
Remove job
==========
.. rest_method:: DELETE /v1.1/{tenant_id}/jobs/{job_id}
.. rest_method:: DELETE /v1.1/{project_id}/jobs/{job_id}
Removes a job.
@ -208,7 +208,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- job_id: job_id
@ -219,7 +219,7 @@ Request
Update job object
=================
.. rest_method:: PATCH /v1.1/{tenant_id}/jobs/{job_id}
.. rest_method:: PATCH /v1.1/{project_id}/jobs/{job_id}
Updates a job object.
@ -231,7 +231,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- job_id: job_id
Request Example

22
api-ref/source/node-group-templates.inc
View File

@ -16,7 +16,7 @@ characteristics through an OpenStack flavor.
List node group templates
=========================
.. rest_method:: GET /v1.1/{tenant_id}/node-group-templates
.. rest_method:: GET /v1.1/{project_id}/node-group-templates
Lists available node group templates.
@ -29,7 +29,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- limit: limit
- marker: marker
- sort_by: sort_by_node_groups
@ -77,7 +77,7 @@ Response Parameters
Response Example
----------------
.. rest_method:: GET /v1.1/{tenant_id}/node-group-templates?limit=2&marker=38b4e146-1d39-4822-bad2-fef1bf304a52&sort_by=name
.. rest_method:: GET /v1.1/{project_id}/node-group-templates?limit=2&marker=38b4e146-1d39-4822-bad2-fef1bf304a52&sort_by=name
.. literalinclude:: samples/node-group-templates/node-group-templates-list-response.json
:language: javascript
@ -88,7 +88,7 @@ Response Example
Create node group template
==========================
.. rest_method:: POST /v1.1/{tenant_id}/node-group-templates
.. rest_method:: POST /v1.1/{project_id}/node-group-templates
Creates a node group template.
@ -100,7 +100,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
Request Example
@ -152,7 +152,7 @@ Response Parameters
Show node group template details
================================
.. rest_method:: GET /v1.1/{tenant_id}/node-group-templates/{node_group_template_id}
.. rest_method:: GET /v1.1/{project_id}/node-group-templates/{node_group_template_id}
Shows a node group template, by ID.
@ -165,7 +165,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- node_group_template_id: node_group_template_id
@ -218,7 +218,7 @@ Response Example
Delete node group template
==========================
.. rest_method:: DELETE /v1.1/{tenant_id}/node-group-templates/{node_group_template_id}
.. rest_method:: DELETE /v1.1/{project_id}/node-group-templates/{node_group_template_id}
Deletes a node group template.
@ -230,7 +230,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- node_group_template_id: node_group_template_id
@ -241,7 +241,7 @@ Request
Update node group template
==========================
.. rest_method:: PUT /v1.1/{tenant_id}/node-group-templates/{node_group_template_id}
.. rest_method:: PUT /v1.1/{project_id}/node-group-templates/{node_group_template_id}
Updates a node group template.
@ -253,7 +253,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- node_group_template_id: node_group_template_id
Request Example

10
api-ref/source/parameters.yaml
View File

@ -215,9 +215,9 @@ sort_by_node_group_templates:
required: false
type: string
url_tenant_id:
url_project_id:
description: |
UUID of the tenant.
UUID of the project.
in: path
required: true
type: string
@ -829,6 +829,12 @@ progress:
in: body
required: true
type: integer
project_id:
description: |
The UUID of the project.
in: body
required: true
type: string
provision_progress:
description: |
A list of the cluster progresses.

16
api-ref/source/plugins.inc
View File

@ -11,7 +11,7 @@ install and which configurations can be set for the cluster.
Show plugin details
===================
.. rest_method:: GET /v1.1/{tenant_id}/plugins/{plugin_name}
.. rest_method:: GET /v1.1/{project_id}/plugins/{plugin_name}
Shows details for a plugin.
@ -25,7 +25,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- plugin_name: plugin_name
@ -53,7 +53,7 @@ Response Example
List plugins
============
.. rest_method:: GET /v1.1/{tenant_id}/plugins
.. rest_method:: GET /v1.1/{project_id}/plugins
Lists all registered plugins.
@ -67,7 +67,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
@ -96,7 +96,7 @@ Response Example
Show plugin version details
===========================
.. rest_method:: GET /v1.1/{tenant_id}/plugins/{plugin_name}/{version}
.. rest_method:: GET /v1.1/{project_id}/plugins/{plugin_name}/{version}
Shows details for a plugin version.
@ -110,7 +110,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- plugin_name: plugin_name
- version: version
@ -139,7 +139,7 @@ Response Example
Update plugin details
=====================
.. rest_method:: PATCH /v1.1/{tenant_id}/plugins/{plugin_name}
.. rest_method:: PATCH /v1.1/{project_id}/plugins/{plugin_name}
Updates details for a plugin.
@ -153,7 +153,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: url_tenant_id
- project_id: url_project_id
- plugin_name: plugin_name