openstack
/
senlin
Code Issues Proposed changes

Fix parameters 'required' status 

This patch fixes the 'required' status where we were using 'optional'.

Change-Id: I4c6bf2d5679af27ff7a28a6880286d8a47cc8dcc
This commit is contained in:
tengqm 2016-05-23 09:59:52 -04:00
parent 7c77cf0d7f
commit 3f7f23eacb
8 changed files with 301 additions and 170 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
api-ref/source/actions.inc
View File

@ -36,7 +36,6 @@ Request Parameters
- action: action_action_query
- status: action_status_query
Reponse Parameters
------------------
@ -59,8 +58,8 @@ Reponse Parameters
- owner: action_owner
- status: action_status
- status_reason: status_reason
- target: target
- timeout: timeout
- target: action_target
- timeout: action_timeout
- updated_at: updated_at
Response Example
@ -116,8 +115,8 @@ Response Parameters:
- owner: action_owner
- status: action_status
- status_reason: status_reason
- target: target
- timeout: timeout
- target: action_target
- timeout: action_timeout
- updated_at: updated_at
Response Example

4
api-ref/source/cluster_policies.inc
View File

@ -42,7 +42,7 @@ Response Parameters
- id: cluster_policy_id
- policy_id: policy_id
- policy_name: policy_name
- policy_type: policy_type_property
- policy_type: policy_type_name
Response Example
----------------
@ -89,7 +89,7 @@ Response Parameters
- id: cluster_policy_id
- policy_id: policy_id
- policy_name: policy_name
- policy_type: policy_type_property
- policy_type: policy_type_name
Response Example
----------------

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

@ -13,7 +13,6 @@ List clusters
Lists clusters.
Normal response codes: 200
Error response codes:
@ -43,33 +42,25 @@ Response Parameters
- clusters: clusters
- created_at: created_at
in: cluster
- data: cluster_data
- desired_capacity: desired_capacity
- domain: domain
in: cluster
- id: cluster_id
- init_at: init_at
- max_size: max_size
- metadata: metadata
in: cluster
- min_size: min_size
- name: cluster_name
in: cluster
- name: name
- nodes: cluster_nodes
- policies: cluster_policies_property
- profile_id: cluster_profile_id
- profile_name: cluster_profile_name
- profile_id: profile_id
- profile_name: profile_name
- project: project
in: cluster
- status: cluster_status
- status_reason: status_reason
in: cluster
- timeout: timeout
- updated_at: updated_at
in: cluster
- user: user
in: cluster
Response Example
----------------
@ -103,11 +94,11 @@ Request Parameters
- cluster: cluster
- name: name
- desired_capacity: desired_capacity
- profile_id: profile_id_url
- min_size: min_size
- timeout: timeout
- max_size: max_size
- metadata: metadata
- profile_id: profile_identity_req
- min_size: min_size_req
- timeout: timeout_req
- max_size: max_size_req
- metadata: metadata_req
Request Example
---------------
@ -132,13 +123,12 @@ Response Parameters
- max_size: max_size
- metadata: metadata
- min_size: min_size
- name: cluster_name
- name: name
- nodes: cluster_nodes
- policies: cluster_policies_property
- profile_id: cluster_profile_id
- profile_name: cluster_profile_name
- profile_id: profile_id
- profile_name: profile_name
- project: project
in: cluster
- status: cluster_status
- status_reason: status_reason
- timeout: timeout
@ -184,7 +174,6 @@ Response Parameters
- cluster: cluster
- created_at: created_at
in: cluster
- data: cluster_data
- desired_capacity: desired_capacity
- domain: domain
@ -193,11 +182,11 @@ Response Parameters
- max_size: max_size
- metadata: metadata
- min_size: min_size
- name: cluster_name
- name: name
- nodes: cluster_nodes
- policies: cluster_policies_property
- profile_id: cluster_profile_id
- profile_name: cluster_profile_name
- profile_id: profile_id
- profile_name: profile_name
- project: project
- status: cluster_status
- status_reason: status_reason
@ -237,11 +226,10 @@ Request
- OpenStack-API-Version: microversion
- cluster_id: cluster_id_url
- cluster: cluster
- name: cluster_name
- profile_id: cluster_profile_identity
- timeout: timeout
- metadata: metadata
- name: name_req
- profile_id: profile_identity
- timeout: timeout_req
- metadata: metadata_req
Request Example
---------------
@ -266,11 +254,11 @@ Response Parameters
- max_size: max_size
- metadata: metadata
- min_size: min_size
- name: cluster_name
- name: name
- nodes: cluster_nodes
- policies: cluster_policies_property
- profile_id: cluster_profile_id
- profile_name: cluster_profile_name
- profile_id: profile_id
- profile_name: profile_name
- project: project
- status: cluster_status
- status_reason: status_reason

56
api-ref/source/nodes.inc
View File

@ -52,8 +52,8 @@ Response Parameters
- metadata: metadata
- name: name
- physical_id: physical_id
- profile_id: node_profile_id
- profile_name: node_profile_name
- profile_id: profile_id
- profile_name: profile_name
- project: project
- role: role
- status: node_status
@ -91,11 +91,11 @@ Request Parameters
- OpenStack-API-Version: microversion
- node: node
- role: role
- profile_id: profile_identity
- cluster_id: cluster_identity
- role: role_req
- profile_id: profile_identity_req
- cluster_id: node_cluster_identity
- name: name
- metadata: metadata
- metadata: metadata_req
Request Example
---------------
@ -120,8 +120,8 @@ Response Parameters
- metadata: metadata
- name: name
- physical_id: physical_id
- profile_id: node_profile_id
- profile_name: node_profile_name
- profile_id: profile_id
- profile_name: profile_name
- project: project
- role: role
- status: node_status
@ -163,6 +163,31 @@ Request Parameters
- node_id: node_id_url
- show_details: show_details
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- node: node
- cluster_id: cluster_id
- created_at: created_at
- data: node_data
- domain: domain
- id: node_id
- index: index
- init_at: init_at
- metadata: metadata
- name: name
- physical_id: physical_id
- profile_id: profile_id
- profile_name: profile_name
- project: project
- role: role
- status: node_status
- status_reason: status_reason
- updated_at: updated_at
- user: user
Response Example
----------------
@ -188,18 +213,18 @@ Error response codes:
- serviceUnavailable (503)
Request
-------
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- OpenStack-API-Version: microversion
- node_id: node_id_url
- node: node
- name: name
- name: name_req
- profile_id: profile_identity
- role: role
- metadata: metadata
- role: role_req
- metadata: metadata_req
Request Example
---------------
@ -224,8 +249,8 @@ Response Parameters
- metadata: metadata
- name: name
- physical_id: physical_id
- profile_id: node_profile_id
- profile_name: node_profile_name
- profile_id: profile_id
- profile_name: profile_name
- project: project
- role: role
- status: node_status
@ -265,7 +290,6 @@ Request Parameters
- OpenStack-API-Version: microversion
- node_id: node_id_url
Response Parameters
-------------------

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

File diff suppressed because it is too large Load Diff

23
api-ref/source/policies.inc
View File

@ -48,7 +48,7 @@ Response Parameters
- name: name
- project: project
- spec: policy_spec
- type: policy_type_property
- type: policy_type_name
- updated_at: updated_at
- user: user
@ -98,21 +98,15 @@ Response Parameters
- policy: policy
- created_at: created_at
in: policy
- data: policy_data
- domain: domain
in: policy
- id: policy_id
- name: name
in: policy
- project: project
in: policy
- spec: policy_spec
- type: policy_type_property
- type: policy_type_name
- updated_at: updated_at
in: policy
- user: user
in: policy
Response Example
----------------
@ -159,7 +153,7 @@ Response Parameters
- name: name
- project: project
- spec: policy_spec
- type: policy_type_property
- type: policy_type_name
- updated_at: updated_at
- user: user
@ -196,7 +190,9 @@ Request Parameters
- policy_id: policy_id_url
- policy: policy
- name: name
in: policy
Note that the only property that can be updated on a policy object after
creation is ``name``.
Request Example
---------------
@ -214,18 +210,13 @@ Response Parameters
- created_at: created_at
- data: policy_data
- domain: domain
in: policy
- id: policy_id
- name: name
in: policy
- project: project
in: policy
- spec: policy_spec
- type: policy_type_property
- type: policy_type_name
- updated_at: updated_at
in: policy
- user: user
in: policy
Response Example
----------------

14
api-ref/source/profiles.inc
View File

@ -46,7 +46,7 @@ Response Parameters
- name: name
- project: project
- spec: profile_spec
- type: profile_type_property
- type: profile_type_name
- updated_at: updated_at
- user: user
@ -81,7 +81,7 @@ Request Parameters
- OpenStack-API-Version: microversion
- profile: profile
- name: name
- metadata: metadata
- metadata: metadata_req
- spec: profile_spec
Request Example
@ -103,7 +103,7 @@ Response Parameters
- name: name
- project: project
- spec: profile_spec
- type: profile_type_property
- type: profile_type_name
- updated_at: updated_at
- user: user
@ -153,7 +153,7 @@ Response Parameters
- name: name
- project: project
- spec: profile_spec
- type: profile_type_property
- type: profile_type_name
- updated_at: updated_at
- user: user
@ -189,8 +189,8 @@ Request Parameters
- OpenStack-API-Version: microversion
- profile_id: profile_id_url
- profile: profile
- metadata: metadata
- name: name
- metadata: metadata_req
- name: name_req
Request Example
---------------
@ -211,7 +211,7 @@ Response Parameters
- name: name
- project: project
- spec: profile_spec
- type: profile_type_property
- type: profile_type_name
- updated_at: updated_at
- user: user

6
api-ref/source/receivers.inc
View File

@ -89,11 +89,11 @@ Request Parameters
- OpenStack-API-Version: microversion
- receiver: receiver
- name: name
- cluster_id: cluster_identity
- type: receiver_type
- cluster_id: receiver_cluster_identity
- type: receiver_type_req
- action: receiver_action
- actor: receiver_actor
- params: receiver_params
- params: receiver_params_req
Request Example
---------------