[Api-ref] fix description of response parameters
There is something wrong in API ref, this changes fixed it: 1. change the response parameter description of "description", "id" and "name" and so on 2. some request parameter in the url path should be marked as "required" Change-Id: I738fc5a3f490f9cc321349445249f7dcd9aaf4e7 Closes-Bug: 1636522
This commit is contained in:
parent
5ce7ad4e90
commit
6ccc0997c7
@ -27,7 +27,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: url_project_id
|
||||
- cluster_template_id: cluster_template_id
|
||||
- cluster_template_id: url_cluster_template_id
|
||||
|
||||
|
||||
Response Parameters
|
||||
@ -35,7 +35,7 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- description: description
|
||||
- description: cluster_template_description
|
||||
- use_autoconfig: use_autoconfig
|
||||
- cluster_configs: cluster_configs
|
||||
- created_at: created_at
|
||||
@ -43,15 +43,15 @@ Response Parameters
|
||||
- updated_at: updated_at
|
||||
- plugin_name: plugin_name
|
||||
- is_default: is_default
|
||||
- is_protected: is_protected
|
||||
- shares: shares
|
||||
- is_protected: object_is_protected
|
||||
- shares: object_shares
|
||||
- domain_name: domain_name
|
||||
- tenant_id: tenant_id
|
||||
- node_groups: node_groups
|
||||
- is_public: is_public
|
||||
- is_public: object_is_public
|
||||
- hadoop_version: hadoop_version
|
||||
- id: id
|
||||
- name: name
|
||||
- id: cluster_template_id
|
||||
- name: cluster_template_name
|
||||
|
||||
|
||||
|
||||
@ -95,7 +95,7 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- description: description
|
||||
- description: cluster_template_description
|
||||
- use_autoconfig: use_autoconfig
|
||||
- cluster_configs: cluster_configs
|
||||
- created_at: created_at
|
||||
@ -103,15 +103,15 @@ Response Parameters
|
||||
- updated_at: updated_at
|
||||
- plugin_name: plugin_name
|
||||
- is_default: is_default
|
||||
- is_protected: is_protected
|
||||
- shares: shares
|
||||
- is_protected: object_is_protected
|
||||
- shares: object_shares
|
||||
- domain_name: domain_name
|
||||
- tenant_id: tenant_id
|
||||
- node_groups: node_groups
|
||||
- is_public: is_public
|
||||
- is_public: object_is_public
|
||||
- hadoop_version: hadoop_version
|
||||
- id: id
|
||||
- name: name
|
||||
- id: cluster_template_id
|
||||
- name: cluster_template_name
|
||||
|
||||
|
||||
|
||||
@ -169,7 +169,7 @@ Response Parameters
|
||||
- markers: markers
|
||||
- prev: prev
|
||||
- next: next
|
||||
- description: description
|
||||
- description: cluster_template_description
|
||||
- use_autoconfig: use_autoconfig
|
||||
- cluster_configs: cluster_configs
|
||||
- created_at: created_at
|
||||
@ -177,15 +177,15 @@ Response Parameters
|
||||
- updated_at: updated_at
|
||||
- plugin_name: plugin_name
|
||||
- is_default: is_default
|
||||
- is_protected: is_protected
|
||||
- shares: shares
|
||||
- is_protected: object_is_protected
|
||||
- shares: object_shares
|
||||
- domain_name: domain_name
|
||||
- tenant_id: tenant_id
|
||||
- node_groups: node_groups
|
||||
- is_public: is_public
|
||||
- is_public: object_is_public
|
||||
- hadoop_version: hadoop_version
|
||||
- id: id
|
||||
- name: name
|
||||
- id: cluster_template_id
|
||||
- name: cluster_template_name
|
||||
|
||||
|
||||
|
||||
@ -230,7 +230,7 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- description: description
|
||||
- description: cluster_template_description
|
||||
- use_autoconfig: use_autoconfig
|
||||
- cluster_configs: cluster_configs
|
||||
- created_at: created_at
|
||||
@ -238,15 +238,15 @@ Response Parameters
|
||||
- updated_at: updated_at
|
||||
- plugin_name: plugin_name
|
||||
- is_default: is_default
|
||||
- is_protected: is_protected
|
||||
- shares: shares
|
||||
- is_protected: object_is_protected
|
||||
- shares: object_shares
|
||||
- domain_name: domain_name
|
||||
- tenant_id: tenant_id
|
||||
- node_groups: node_groups
|
||||
- is_public: is_public
|
||||
- is_public: object_is_public
|
||||
- hadoop_version: hadoop_version
|
||||
- id: id
|
||||
- name: name
|
||||
- id: cluster_template_id
|
||||
- name: cluster_template_name
|
||||
|
||||
|
||||
|
||||
|
@ -157,7 +157,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: url_project_id
|
||||
- cluster_id: cluster_id
|
||||
- cluster_id: url_cluster_id
|
||||
|
||||
|
||||
Response Parameters
|
||||
@ -204,7 +204,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: url_project_id
|
||||
- cluster_id: cluster_id
|
||||
- cluster_id: url_cluster_id
|
||||
|
||||
|
||||
|
||||
@ -273,7 +273,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: url_project_id
|
||||
- cluster_id: cluster_id
|
||||
- cluster_id: url_cluster_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -320,7 +320,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: url_project_id
|
||||
- cluster_id: cluster_id
|
||||
- cluster_id: url_cluster_id
|
||||
|
||||
|
||||
|
||||
|
@ -28,7 +28,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: url_project_id
|
||||
- data_source_id: data_source_id
|
||||
- data_source_id: url_data_source_id
|
||||
|
||||
|
||||
Response Parameters
|
||||
@ -36,16 +36,16 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- description: description
|
||||
- description: data_source_description
|
||||
- url: url
|
||||
- tenant_id: tenant_id
|
||||
- created_at: created_at
|
||||
- updated_at: updated_at
|
||||
- is_protected: is_protected
|
||||
- is_public: is_public
|
||||
- is_protected: object_is_protected
|
||||
- is_public: object_is_public
|
||||
- type: type
|
||||
- id: id
|
||||
- name: name
|
||||
- id: data_source_id
|
||||
- name: data_source_name
|
||||
|
||||
|
||||
|
||||
@ -74,7 +74,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: url_project_id
|
||||
- data_source_id: data_source_id
|
||||
- data_source_id: url_data_source_id
|
||||
|
||||
|
||||
|
||||
@ -97,7 +97,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: url_project_id
|
||||
- data_source_id: data_source_id
|
||||
- data_source_id: url_data_source_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -141,16 +141,16 @@ Response Parameters
|
||||
- markers: markers
|
||||
- prev: prev
|
||||
- next: next
|
||||
- description: description
|
||||
- description: data_source_description
|
||||
- url: url
|
||||
- tenant_id: tenant_id
|
||||
- created_at: created_at
|
||||
- updated_at: updated_at
|
||||
- is_protected: is_protected
|
||||
- is_public: is_public
|
||||
- is_protected: object_is_protected
|
||||
- is_public: object_is_public
|
||||
- type: type
|
||||
- id: id
|
||||
- name: name
|
||||
- id: data_source_id
|
||||
- name: data_source_name
|
||||
|
||||
|
||||
|
||||
@ -196,16 +196,16 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- description: description
|
||||
- description: data_source_description
|
||||
- url: url
|
||||
- tenant_id: tenant_id
|
||||
- created_at: created_at
|
||||
- updated_at: updated_at
|
||||
- is_protected: is_protected
|
||||
- is_public: is_public
|
||||
- is_protected: object_is_protected
|
||||
- is_public: object_is_public
|
||||
- type: type
|
||||
- id: id
|
||||
- name: name
|
||||
- id: data_source_id
|
||||
- name: data_source_name
|
||||
|
||||
|
||||
|
||||
|
@ -59,7 +59,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: url_project_id
|
||||
- image_id: image_id
|
||||
- image_id: url_image_id
|
||||
|
||||
|
||||
Response Parameters
|
||||
@ -70,15 +70,15 @@ Response Parameters
|
||||
- status: status
|
||||
- username: username
|
||||
- updated: updated
|
||||
- description: description
|
||||
- description: image_description
|
||||
- created: created
|
||||
- image: image
|
||||
- tags: tags
|
||||
- minDisk: minDisk
|
||||
- name: name
|
||||
- name: image_name
|
||||
- progress: progress
|
||||
- minRam: minRam
|
||||
- id: id
|
||||
- id: image_id
|
||||
- metadata: metadata
|
||||
|
||||
|
||||
@ -109,8 +109,8 @@ Request
|
||||
|
||||
- project_id: url_project_id
|
||||
- username: username
|
||||
- description: description
|
||||
- image_id: image_id
|
||||
- description: image_description
|
||||
- image_id: url_image_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -128,15 +128,15 @@ Response Parameters
|
||||
- status: status
|
||||
- username: username
|
||||
- updated: updated
|
||||
- description: description
|
||||
- description: image_description
|
||||
- created: created
|
||||
- image: image
|
||||
- tags: tags
|
||||
- minDisk: minDisk
|
||||
- name: name
|
||||
- name: image_name
|
||||
- progress: progress
|
||||
- minRam: minRam
|
||||
- id: id
|
||||
- id: image_id
|
||||
- metadata: metadata
|
||||
|
||||
|
||||
@ -159,7 +159,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: url_project_id
|
||||
- image_id: image_id
|
||||
- image_id: url_image_id
|
||||
|
||||
|
||||
|
||||
@ -183,7 +183,7 @@ Request
|
||||
|
||||
- project_id: url_project_id
|
||||
- tags: tags
|
||||
- image_id: image_id
|
||||
- image_id: url_image_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -225,16 +225,16 @@ Response Parameters
|
||||
- status: status
|
||||
- username: username
|
||||
- updated: updated
|
||||
- description: description
|
||||
- description: image_description
|
||||
- created: created
|
||||
- image: image
|
||||
- tags: tags
|
||||
- minDisk: minDisk
|
||||
- name: name
|
||||
- name: image_name
|
||||
- images: images
|
||||
- progress: progress
|
||||
- minRam: minRam
|
||||
- id: id
|
||||
- id: image_id
|
||||
- metadata: metadata
|
||||
|
||||
|
||||
|
@ -40,16 +40,16 @@ Response Parameters
|
||||
- markers: markers
|
||||
- prev: prev
|
||||
- next: next
|
||||
- description: description
|
||||
- description: job_binary_description
|
||||
- url: url
|
||||
- tenant_id: tenant_id
|
||||
- created_at: created_at
|
||||
- updated_at: updated_at
|
||||
- is_protected: is_protected
|
||||
- is_public: is_public
|
||||
- is_protected: object_is_protected
|
||||
- is_public: object_is_public
|
||||
- binaries: binaries
|
||||
- id: id
|
||||
- name: name
|
||||
- id: job_binary_id
|
||||
- name: job_binary_name
|
||||
|
||||
|
||||
|
||||
@ -94,15 +94,15 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- description: description
|
||||
- description: job_binary_description
|
||||
- url: url
|
||||
- tenant_id: tenant_id
|
||||
- created_at: created_at
|
||||
- updated_at: updated_at
|
||||
- is_protected: is_protected
|
||||
- is_public: is_public
|
||||
- id: id
|
||||
- name: name
|
||||
- is_protected: object_is_protected
|
||||
- is_public: object_is_public
|
||||
- id: job_binary_id
|
||||
- name: job_binary_name
|
||||
|
||||
|
||||
|
||||
@ -125,6 +125,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: url_project_id
|
||||
- job_binary_id: url_job_binary_id
|
||||
|
||||
|
||||
|
||||
@ -133,15 +134,15 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- description: description
|
||||
- description: job_binary_description
|
||||
- url: url
|
||||
- tenant_id: tenant_id
|
||||
- created_at: created_at
|
||||
- updated_at: updated_at
|
||||
- is_protected: is_protected
|
||||
- is_public: is_public
|
||||
- id: id
|
||||
- name: name
|
||||
- is_protected: object_is_protected
|
||||
- is_public: object_is_public
|
||||
- id: job_binary_id
|
||||
- name: job_binary_name
|
||||
|
||||
|
||||
|
||||
@ -171,6 +172,7 @@ Request
|
||||
|
||||
|
||||
- project_id: url_project_id
|
||||
- job_binary_id: url_job_binary_id
|
||||
|
||||
|
||||
|
||||
@ -194,6 +196,7 @@ Request
|
||||
|
||||
|
||||
- project_id: url_project_id
|
||||
- job_binary_id: url_job_binary_id
|
||||
|
||||
|
||||
Request Example
|
||||
@ -241,7 +244,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: url_project_id
|
||||
- job_binary_id: job_binary_id
|
||||
- job_binary_id: url_job_binary_id
|
||||
|
||||
|
||||
Response Parameters
|
||||
|
@ -31,7 +31,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: url_project_id
|
||||
- name: name
|
||||
- name: url_job_binary_internals_name
|
||||
|
||||
|
||||
Response Parameters
|
||||
@ -39,14 +39,14 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- name: name
|
||||
- name: job_binary_internals_name
|
||||
- tenant_id: tenant_id
|
||||
- created_at: created_at
|
||||
- updated_at: updated_at
|
||||
- is_protected: is_protected
|
||||
- is_public: is_public
|
||||
- is_protected: object_is_protected
|
||||
- is_public: object_is_public
|
||||
- datasize: datasize
|
||||
- id: id
|
||||
- id: job_binary_internals_id
|
||||
|
||||
|
||||
|
||||
@ -85,7 +85,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: url_project_id
|
||||
- job_binary_internals_id: job_binary_internals_id
|
||||
- job_binary_internals_id: url_job_binary_internals_id
|
||||
|
||||
|
||||
Response Parameters
|
||||
@ -123,7 +123,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: url_project_id
|
||||
- job_binary_internals_id: job_binary_internals_id
|
||||
- job_binary_internals_id: url_job_binary_internals_id
|
||||
|
||||
|
||||
Response Parameters
|
||||
@ -131,14 +131,14 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- name: name
|
||||
- name: job_binary_internals_name
|
||||
- tenant_id: tenant_id
|
||||
- created_at: created_at
|
||||
- updated_at: updated_at
|
||||
- is_protected: is_protected
|
||||
- is_public: is_public
|
||||
- is_protected: object_is_protected
|
||||
- is_public: object_is_public
|
||||
- datasize: datasize
|
||||
- id: id
|
||||
- id: job_binary_internals_id
|
||||
|
||||
|
||||
|
||||
@ -167,7 +167,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: url_project_id
|
||||
- job_binary_internals_id: job_binary_internals_id
|
||||
- job_binary_internals_id: url_job_binary_internals_id
|
||||
|
||||
|
||||
|
||||
@ -190,7 +190,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: url_project_id
|
||||
- job_binary_internals_id: job_binary_internals_id
|
||||
- job_binary_internals_id: url_job_binary_internals_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -236,14 +236,14 @@ Response Parameters
|
||||
- prev: prev
|
||||
- next: next
|
||||
- binaries: binaries
|
||||
- name: name
|
||||
- name: job_binary_internals_name
|
||||
- tenant_id: tenant_id
|
||||
- created_at: created_at
|
||||
- updated_at: updated_at
|
||||
- is_protected: is_protected
|
||||
- is_public: is_public
|
||||
- is_protected: object_is_protected
|
||||
- is_public: object_is_public
|
||||
- datasize: datasize
|
||||
- id: id
|
||||
- id: job_binary_internals_id
|
||||
|
||||
|
||||
|
||||
|
@ -26,7 +26,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: url_project_id
|
||||
- job_execution_id: job_execution_id
|
||||
- job_execution_id: url_job_execution_id
|
||||
|
||||
|
||||
Response Parameters
|
||||
@ -45,15 +45,15 @@ Response Parameters
|
||||
- data_source_urls: data_source_urls
|
||||
- return_code: return_code
|
||||
- oozie_job_id: oozie_job_id
|
||||
- is_protected: is_protected
|
||||
- is_protected: is_protected_3
|
||||
- cluster_id: cluster_id
|
||||
- end_time: end_time
|
||||
- params: params
|
||||
- is_public: is_public
|
||||
- is_public: job_execution_is_public
|
||||
- input_id: input_id
|
||||
- configs: configs
|
||||
- job_execution: job_execution
|
||||
- id: id
|
||||
- id: job_execution_id
|
||||
|
||||
|
||||
|
||||
@ -108,15 +108,15 @@ Response Parameters
|
||||
- data_source_urls: data_source_urls
|
||||
- return_code: return_code
|
||||
- oozie_job_id: oozie_job_id
|
||||
- is_protected: is_protected
|
||||
- is_protected: is_protected_3
|
||||
- cluster_id: cluster_id
|
||||
- end_time: end_time
|
||||
- params: params
|
||||
- is_public: is_public
|
||||
- is_public: job_execution_is_public
|
||||
- input_id: input_id
|
||||
- configs: configs
|
||||
- job_execution: job_execution
|
||||
- id: id
|
||||
- id: job_execution_id
|
||||
- job_executions: job_executions
|
||||
|
||||
|
||||
@ -148,7 +148,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: url_project_id
|
||||
- job_execution_id: job_execution_id
|
||||
- job_execution_id: url_job_execution_id
|
||||
|
||||
|
||||
Response Parameters
|
||||
@ -167,15 +167,15 @@ Response Parameters
|
||||
- data_source_urls: data_source_urls
|
||||
- return_code: return_code
|
||||
- oozie_job_id: oozie_job_id
|
||||
- is_protected: is_protected
|
||||
- is_protected: is_protected_3
|
||||
- cluster_id: cluster_id
|
||||
- end_time: end_time
|
||||
- params: params
|
||||
- is_public: is_public
|
||||
- is_public: job_execution_is_public
|
||||
- input_id: input_id
|
||||
- configs: configs
|
||||
- job_execution: job_execution
|
||||
- id: id
|
||||
- id: job_execution_id
|
||||
|
||||
|
||||
|
||||
@ -204,7 +204,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: url_project_id
|
||||
- job_execution_id: job_execution_id
|
||||
- job_execution_id: url_job_execution_id
|
||||
|
||||
|
||||
|
||||
@ -227,7 +227,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: url_project_id
|
||||
- job_execution_id: job_execution_id
|
||||
- job_execution_id: url_job_execution_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -253,15 +253,15 @@ Response Parameters
|
||||
- data_source_urls: data_source_urls
|
||||
- return_code: return_code
|
||||
- oozie_job_id: oozie_job_id
|
||||
- is_protected: is_protected
|
||||
- is_protected: is_protected_3
|
||||
- cluster_id: cluster_id
|
||||
- end_time: end_time
|
||||
- params: params
|
||||
- is_public: is_public
|
||||
- is_public: job_execution_is_public
|
||||
- input_id: input_id
|
||||
- configs: configs
|
||||
- job_execution: job_execution
|
||||
- id: id
|
||||
- id: job_execution_id
|
||||
|
||||
|
||||
|
||||
@ -284,7 +284,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: url_project_id
|
||||
- job_execution_id: job_execution_id
|
||||
- job_execution_id: url_job_execution_id
|
||||
|
||||
|
||||
Response Parameters
|
||||
@ -303,15 +303,15 @@ Response Parameters
|
||||
- data_source_urls: data_source_urls
|
||||
- return_code: return_code
|
||||
- oozie_job_id: oozie_job_id
|
||||
- is_protected: is_protected
|
||||
- is_protected: is_protected_3
|
||||
- cluster_id: cluster_id
|
||||
- end_time: end_time
|
||||
- params: params
|
||||
- is_public: is_public
|
||||
- is_public: job_execution_is_public
|
||||
- input_id: input_id
|
||||
- configs: configs
|
||||
- job_execution: job_execution
|
||||
- id: id
|
||||
- id: job_execution_id
|
||||
|
||||
|
||||
|
||||
|
@ -45,9 +45,9 @@ Response Parameters
|
||||
|
||||
- versions: versions
|
||||
- title: title
|
||||
- description: description
|
||||
- description: description_plugin
|
||||
- job_types: job_types
|
||||
- name: name
|
||||
- name: plugin_name
|
||||
|
||||
|
||||
|
||||
|
@ -26,7 +26,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: url_project_id
|
||||
- job_id: job_id
|
||||
- job_id: url_job_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -69,18 +69,18 @@ Response Parameters
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- jobs: jobs
|
||||
- description: description
|
||||
- description: job_description
|
||||
- tenant_id: tenant_id
|
||||
- created_at: created_at
|
||||
- mains: mains
|
||||
- updated_at: updated_at
|
||||
- libs: libs
|
||||
- is_protected: is_protected
|
||||
- is_protected: object_is_protected
|
||||
- interface: interface
|
||||
- is_public: is_public
|
||||
- is_public: object_is_public
|
||||
- type: type
|
||||
- id: id
|
||||
- name: name
|
||||
- id: job_id
|
||||
- name: job_name
|
||||
- markers: markers
|
||||
- prev: prev
|
||||
- next: next
|
||||
@ -127,18 +127,18 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- description: description
|
||||
- description: job_description
|
||||
- tenant_id: tenant_id
|
||||
- created_at: created_at
|
||||
- mains: mains
|
||||
- updated_at: updated_at
|
||||
- libs: libs
|
||||
- is_protected: is_protected
|
||||
- is_protected: object_is_protected
|
||||
- interface: interface
|
||||
- is_public: is_public
|
||||
- is_public: object_is_public
|
||||
- type: type
|
||||
- id: id
|
||||
- name: name
|
||||
- id: job_id
|
||||
- name: job_name
|
||||
|
||||
|
||||
|
||||
@ -161,7 +161,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: url_project_id
|
||||
- job_id: job_id
|
||||
- job_id: url_job_id
|
||||
|
||||
|
||||
Response Parameters
|
||||
@ -169,18 +169,18 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- description: description
|
||||
- description: job_description
|
||||
- tenant_id: tenant_id
|
||||
- created_at: created_at
|
||||
- mains: mains
|
||||
- updated_at: updated_at
|
||||
- libs: libs
|
||||
- is_protected: is_protected
|
||||
- is_protected: object_is_protected
|
||||
- interface: interface
|
||||
- is_public: is_public
|
||||
- is_public: object_is_public
|
||||
- type: type
|
||||
- id: id
|
||||
- name: name
|
||||
- id: job_id
|
||||
- name: job_name
|
||||
|
||||
|
||||
|
||||
@ -209,7 +209,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: url_project_id
|
||||
- job_id: job_id
|
||||
- job_id: url_job_id
|
||||
|
||||
|
||||
|
||||
@ -232,7 +232,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: url_project_id
|
||||
- job_id: job_id
|
||||
- job_id: url_job_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -247,18 +247,18 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- description: description
|
||||
- description: job_description
|
||||
- tenant_id: tenant_id
|
||||
- created_at: created_at
|
||||
- mains: mains
|
||||
- updated_at: updated_at
|
||||
- libs: libs
|
||||
- is_protected: is_protected
|
||||
- is_protected: object_is_protected
|
||||
- interface: interface
|
||||
- is_public: is_public
|
||||
- is_public: object_is_public
|
||||
- type: type
|
||||
- id: id
|
||||
- name: name
|
||||
- id: job_id
|
||||
- name: job_name
|
||||
|
||||
|
||||
|
||||
|
@ -32,7 +32,7 @@ Request
|
||||
- project_id: url_project_id
|
||||
- limit: limit
|
||||
- marker: marker
|
||||
- sort_by: sort_by_node_groups
|
||||
- sort_by: sort_by_node_group_templates
|
||||
|
||||
|
||||
|
||||
@ -49,13 +49,13 @@ Response Parameters
|
||||
- updated_at: updated_at
|
||||
- use_autoconfig: use_autoconfig
|
||||
- volumes_per_node: volumes_per_node
|
||||
- id: id
|
||||
- id: node_group_template_id
|
||||
- security_groups: security_groups
|
||||
- shares: shares
|
||||
- shares: object_shares
|
||||
- node_configs: node_configs
|
||||
- auto_security_group: auto_security_group
|
||||
- volumes_availability_zone: volumes_availability_zone
|
||||
- description: description
|
||||
- description: node_group_template_description
|
||||
- volume_mount_prefix: volume_mount_prefix
|
||||
- plugin_name: plugin_name
|
||||
- floating_ip_pool: floating_ip_pool
|
||||
@ -63,13 +63,13 @@ Response Parameters
|
||||
- image_id: image_id
|
||||
- volumes_size: volumes_size
|
||||
- is_proxy_gateway: is_proxy_gateway
|
||||
- is_public: is_public
|
||||
- is_public: object_is_public
|
||||
- hadoop_version: hadoop_version
|
||||
- name: name
|
||||
- name: node_group_template_name
|
||||
- tenant_id: tenant_id
|
||||
- created_at: created_at
|
||||
- volume_type: volume_type
|
||||
- is_protected: is_protected
|
||||
- is_protected: object_is_protected
|
||||
- node_processes: node_processes
|
||||
- flavor_id: flavor_id
|
||||
|
||||
@ -121,13 +121,13 @@ Response Parameters
|
||||
- updated_at: updated_at
|
||||
- use_autoconfig: use_autoconfig
|
||||
- volumes_per_node: volumes_per_node
|
||||
- id: id
|
||||
- id: node_group_template_id
|
||||
- security_groups: security_groups
|
||||
- shares: shares
|
||||
- shares: object_shares
|
||||
- node_configs: node_configs
|
||||
- auto_security_group: auto_security_group
|
||||
- volumes_availability_zone: volumes_availability_zone
|
||||
- description: description
|
||||
- description: node_group_template_description
|
||||
- volume_mount_prefix: volume_mount_prefix
|
||||
- plugin_name: plugin_name
|
||||
- floating_ip_pool: floating_ip_pool
|
||||
@ -135,13 +135,13 @@ Response Parameters
|
||||
- image_id: image_id
|
||||
- volumes_size: volumes_size
|
||||
- is_proxy_gateway: is_proxy_gateway
|
||||
- is_public: is_public
|
||||
- is_public: object_is_public
|
||||
- hadoop_version: hadoop_version
|
||||
- name: name
|
||||
- name: node_group_template_name
|
||||
- tenant_id: tenant_id
|
||||
- created_at: created_at
|
||||
- volume_type: volume_type
|
||||
- is_protected: is_protected
|
||||
- is_protected: object_is_protected
|
||||
- node_processes: node_processes
|
||||
- flavor_id: flavor_id
|
||||
|
||||
@ -166,7 +166,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: url_project_id
|
||||
- node_group_template_id: node_group_template_id
|
||||
- node_group_template_id: url_node_group_template_id
|
||||
|
||||
|
||||
|
||||
@ -180,13 +180,13 @@ Response Parameters
|
||||
- updated_at: updated_at
|
||||
- use_autoconfig: use_autoconfig
|
||||
- volumes_per_node: volumes_per_node
|
||||
- id: id
|
||||
- id: node_group_template_id
|
||||
- security_groups: security_groups
|
||||
- shares: shares
|
||||
- shares: object_shares
|
||||
- node_configs: node_configs
|
||||
- auto_security_group: auto_security_group
|
||||
- volumes_availability_zone: volumes_availability_zone
|
||||
- description: description
|
||||
- description: node_group_template_description
|
||||
- volume_mount_prefix: volume_mount_prefix
|
||||
- plugin_name: plugin_name
|
||||
- floating_ip_pool: floating_ip_pool
|
||||
@ -194,13 +194,13 @@ Response Parameters
|
||||
- image_id: image_id
|
||||
- volumes_size: volumes_size
|
||||
- is_proxy_gateway: is_proxy_gateway
|
||||
- is_public: is_public
|
||||
- is_public: object_is_public
|
||||
- hadoop_version: hadoop_version
|
||||
- name: name
|
||||
- name: node_group_template_name
|
||||
- tenant_id: tenant_id
|
||||
- created_at: created_at
|
||||
- volume_type: volume_type
|
||||
- is_protected: is_protected
|
||||
- is_protected: object_is_protected
|
||||
- node_processes: node_processes
|
||||
- flavor_id: flavor_id
|
||||
|
||||
@ -231,7 +231,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: url_project_id
|
||||
- node_group_template_id: node_group_template_id
|
||||
- node_group_template_id: url_node_group_template_id
|
||||
|
||||
|
||||
|
||||
@ -254,7 +254,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: url_project_id
|
||||
- node_group_template_id: node_group_template_id
|
||||
- node_group_template_id: url_node_group_template_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
@ -7,23 +7,29 @@ Content-Length:
|
||||
type: string
|
||||
|
||||
# variables in path
|
||||
cluster_id:
|
||||
url_cluster_id:
|
||||
description: |
|
||||
The ID of the cluster
|
||||
in: path
|
||||
required: false
|
||||
required: true
|
||||
type: string
|
||||
cluster_template_id_1:
|
||||
url_cluster_template_id:
|
||||
description: |
|
||||
The unique identifier of the cluster template.
|
||||
in: path
|
||||
required: false
|
||||
required: true
|
||||
type: string
|
||||
url_data_source_id:
|
||||
description: |
|
||||
The UUID of the data source.
|
||||
in: path
|
||||
required: true
|
||||
type: string
|
||||
data_source_id:
|
||||
description: |
|
||||
The UUID of the data source.
|
||||
in: path
|
||||
required: false
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
hints:
|
||||
description: |
|
||||
@ -31,43 +37,61 @@ hints:
|
||||
in: path
|
||||
required: false
|
||||
type: boolean
|
||||
image_id:
|
||||
url_image_id:
|
||||
description: |
|
||||
The UUID of the image.
|
||||
in: path
|
||||
required: false
|
||||
required: true
|
||||
type: string
|
||||
url_job_binary_id:
|
||||
description: |
|
||||
The UUID of the job binary.
|
||||
in: path
|
||||
required: true
|
||||
type: string
|
||||
job_binary_id:
|
||||
description: |
|
||||
The UUID of the job binary.
|
||||
in: path
|
||||
required: false
|
||||
required: true
|
||||
type: string
|
||||
url_job_binary_internals_id:
|
||||
description: |
|
||||
The UUID of the job binary internal.
|
||||
in: path
|
||||
required: true
|
||||
type: string
|
||||
job_binary_internals_id:
|
||||
description: |
|
||||
The UUID of the job binary internal.
|
||||
in: path
|
||||
required: false
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
job_execution_id:
|
||||
url_job_execution_id:
|
||||
description: |
|
||||
The UUID of the job execution.
|
||||
in: path
|
||||
required: false
|
||||
required: true
|
||||
type: string
|
||||
job_id:
|
||||
url_job_id:
|
||||
description: |
|
||||
The UUID of the job.
|
||||
in: path
|
||||
required: false
|
||||
required: true
|
||||
type: string
|
||||
name_3:
|
||||
url_job_binary_internals_name:
|
||||
description: |
|
||||
The name of the job binary internal.
|
||||
in: path
|
||||
required: false
|
||||
required: true
|
||||
type: string
|
||||
node_group_template_id:
|
||||
job_binary_internals_name:
|
||||
description: |
|
||||
The name of the job binary internal.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
url_node_group_template_id:
|
||||
description: |
|
||||
The UUID of the node group template.
|
||||
in: path
|
||||
@ -79,7 +103,7 @@ plugin:
|
||||
in: path
|
||||
required: false
|
||||
type: string
|
||||
plugin_name_1:
|
||||
url_plugin_name:
|
||||
description: |
|
||||
Name of the plugin.
|
||||
in: path
|
||||
@ -401,13 +425,13 @@ description:
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
description_1:
|
||||
data_source_description:
|
||||
description: |
|
||||
The description of the data source object.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
description_2:
|
||||
job_description:
|
||||
description: |
|
||||
The description of the job object.
|
||||
in: body
|
||||
@ -419,19 +443,19 @@ description_3:
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
description_4:
|
||||
job_binary_description:
|
||||
description: |
|
||||
The description of the job binary object.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
description_5:
|
||||
image_description:
|
||||
description: |
|
||||
The description of the image.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
description_6:
|
||||
description_plugin:
|
||||
description: |
|
||||
The full description of the plugin.
|
||||
in: body
|
||||
@ -443,6 +467,18 @@ description_7:
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
cluster_template_description:
|
||||
description: |
|
||||
Description of the cluster template
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
node_group_template_description:
|
||||
description: |
|
||||
Description of the node group template
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
domain_name:
|
||||
description: |
|
||||
Domain name for internal and external hostname resolution.
|
||||
@ -506,24 +542,24 @@ id_1:
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
id_2:
|
||||
description: |
|
||||
The UUID of the node in the cluster.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
id_3:
|
||||
job_execution_id:
|
||||
description: |
|
||||
The UUID of the job execution object.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
id_4:
|
||||
image_id:
|
||||
description: |
|
||||
The UUID of the image.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
node_group_template_id:
|
||||
description: |
|
||||
The UUID of the node group template.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
image:
|
||||
description: |
|
||||
A set of key and value pairs that contain image
|
||||
@ -531,12 +567,6 @@ image:
|
||||
in: body
|
||||
required: true
|
||||
type: object
|
||||
image_id_1:
|
||||
description: |
|
||||
The UUID of the image.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
images:
|
||||
description: |
|
||||
The list of images and their properties.
|
||||
@ -575,20 +605,13 @@ is_default:
|
||||
in: body
|
||||
required: true
|
||||
type: boolean
|
||||
is_default_1:
|
||||
description: |
|
||||
If set to ``True`` the node is the default node
|
||||
in the cluster.
|
||||
in: body
|
||||
required: true
|
||||
type: boolean
|
||||
is_protected:
|
||||
description: |
|
||||
If set to ``true``, the cluster is protected.
|
||||
in: body
|
||||
required: true
|
||||
type: boolean
|
||||
is_protected_1:
|
||||
object_is_protected:
|
||||
description: |
|
||||
If set to ``true``, the object is protected.
|
||||
in: body
|
||||
@ -620,20 +643,13 @@ is_public:
|
||||
in: body
|
||||
required: true
|
||||
type: boolean
|
||||
is_public_1:
|
||||
object_is_public:
|
||||
description: |
|
||||
If set to ``true``, the object is public.
|
||||
in: body
|
||||
required: true
|
||||
type: boolean
|
||||
is_public_2:
|
||||
description: |
|
||||
If set to ``True``, the node is public in the
|
||||
cluster.
|
||||
in: body
|
||||
required: true
|
||||
type: boolean
|
||||
is_public_3:
|
||||
job_execution_is_public:
|
||||
description: |
|
||||
If set to ``true``, the job execution object is
|
||||
public.
|
||||
@ -659,12 +675,18 @@ job_executions:
|
||||
in: body
|
||||
required: true
|
||||
type: array
|
||||
job_id_1:
|
||||
job_id:
|
||||
description: |
|
||||
The UUID of the job object.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
job_name:
|
||||
description: |
|
||||
The name of the job object.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
job_types:
|
||||
description: |
|
||||
The list of plugins and their job types.
|
||||
@ -735,21 +757,33 @@ name_1:
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
name_2:
|
||||
job_binary_name:
|
||||
description: |
|
||||
The name of the node.
|
||||
The name of the object.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
name_4:
|
||||
data_source_name:
|
||||
description: |
|
||||
The name of the data source.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
image_name:
|
||||
description: |
|
||||
The name of the operating system image.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
name_5:
|
||||
node_group_template_name:
|
||||
description: |
|
||||
The name of the plugin.
|
||||
The name of the node group template.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
cluster_template_name:
|
||||
description: |
|
||||
The name of the cluster template.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
@ -859,7 +893,7 @@ shares:
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
shares_1:
|
||||
object_shares:
|
||||
description: |
|
||||
The sharing of resources in the cluster.
|
||||
in: body
|
||||
|
@ -26,7 +26,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: url_project_id
|
||||
- plugin_name: plugin_name
|
||||
- plugin_name: url_plugin_name
|
||||
|
||||
|
||||
Response Parameters
|
||||
@ -36,8 +36,8 @@ Response Parameters
|
||||
|
||||
- versions: versions
|
||||
- title: title
|
||||
- description: description
|
||||
- name: name
|
||||
- description: description_plugin
|
||||
- name: plugin_name
|
||||
|
||||
|
||||
|
||||
@ -79,8 +79,8 @@ Response Parameters
|
||||
- title: title
|
||||
- versions: versions
|
||||
- plugins: plugins
|
||||
- description: description
|
||||
- name: name
|
||||
- description: description_plugin
|
||||
- name: plugin_name
|
||||
|
||||
|
||||
|
||||
@ -111,7 +111,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: url_project_id
|
||||
- plugin_name: plugin_name
|
||||
- plugin_name: url_plugin_name
|
||||
- version: version
|
||||
|
||||
|
||||
@ -122,8 +122,8 @@ Response Parameters
|
||||
|
||||
- versions: versions
|
||||
- title: title
|
||||
- description: description
|
||||
- name: name
|
||||
- description: description_plugin
|
||||
- name: plugin_name
|
||||
|
||||
|
||||
|
||||
@ -154,7 +154,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: url_project_id
|
||||
- plugin_name: plugin_name
|
||||
- plugin_name: url_plugin_name
|
||||
|
||||
|
||||
Request Example
|
||||
@ -172,8 +172,8 @@ Response Parameters
|
||||
|
||||
- title: title
|
||||
- versions: versions
|
||||
- description: description
|
||||
- name: name
|
||||
- description: description_plugin
|
||||
- name: plugin_name
|
||||
|
||||
|
||||
Response Example
|
||||
|
Loading…
Reference in New Issue
Block a user