Jump to: navigation, search

Difference between revisions of "API Special Interest Group/Current Design/State vs Status"

(Created page with "= Current Design = == Methodology == <pre><nowiki> git clone https://github.com/openstack/api-site.git cd api-ref/src/wadls/ grep -nR "param .*state.*" * grep -nR "param .*s...")
 
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
= Analysis =
 +
 +
13 calls that take a param with the word '''state''' in it
 +
 +
20 call that take a param with the word '''status''' in it
 +
 +
Nova and Neutron have calls with both state and status
 +
 
= Current Design =
 
= Current Design =
  
Line 9: Line 17:
 
grep -nR "param .*status.*" *
 
grep -nR "param .*status.*" *
 
</nowiki></pre>
 
</nowiki></pre>
 +
 +
== State ==
 +
 +
{| class="wikitable"
 +
|-
 +
! WADL !! Line !! Param
 +
|-
 +
| [https://github.com/openstack/api-site/tree/master/api-ref/src/wadls/compute-api/src/v2/ext/os-admin-actions.wadl#L527 compute-api/src/v2/ext/os-admin-actions.wadl] || 527 || state
 +
|-
 +
| [https://github.com/openstack/api-site/tree/master/api-ref/src/wadls/compute-api/src/v2/ext/os-interface.wadl#L109 compute-api/src/v2/ext/os-interface.wadl] || 109 || port_state
 +
|-
 +
| [https://github.com/openstack/api-site/tree/master/api-ref/src/wadls/compute-api/src/v2/ext/os-interface.wadl#L134 compute-api/src/v2/ext/os-interface.wadl] || 134 || port_state
 +
|-
 +
| [https://github.com/openstack/api-site/tree/master/api-ref/src/wadls/netconn-api/src/common.ent#L220 netconn-api/src/common.ent] || 220 || admin_state_up
 +
|-
 +
| [https://github.com/openstack/api-site/tree/master/api-ref/src/wadls/netconn-api/src/os-networks.wadl#L217 netconn-api/src/os-networks.wadl] || 217 || admin_state_up
 +
|-
 +
| [https://github.com/openstack/api-site/tree/master/api-ref/src/wadls/netconn-api/src/os-networks.wadl#L291 netconn-api/src/os-networks.wadl] || 291 || admin_state_up
 +
|-
 +
| [https://github.com/openstack/api-site/tree/master/api-ref/src/wadls/netconn-api/src/os-networks.wadl#L345 netconn-api/src/os-networks.wadl] || 345 || admin_state_up
 +
|-
 +
| [https://github.com/openstack/api-site/tree/master/api-ref/src/wadls/netconn-api/src/os-networks.wadl#L439 netconn-api/src/os-networks.wadl] || 439 || admin_state_up
 +
|-
 +
| [https://github.com/openstack/api-site/tree/master/api-ref/src/wadls/netconn-api/src/os-networks.wadl#L518 netconn-api/src/os-networks.wadl] || 518 || admin_state_up
 +
|-
 +
| [https://github.com/openstack/api-site/tree/master/api-ref/src/wadls/netconn-api/src/os-networks.wadl#L608 netconn-api/src/os-networks.wadl] || 608 || admin_state_up
 +
|-
 +
| [https://github.com/openstack/api-site/tree/master/api-ref/src/wadls/telemetry-api/src/v2/os-telemetry-api-2.0.wadl#L420 telemetry-api/src/v2/os-telemetry-api-2.0.wadl] || 420 || state
 +
|-
 +
| [https://github.com/openstack/api-site/tree/master/api-ref/src/wadls/volume-api/src/v2/os-attach.wadl#L142 volume-api/src/v2/os-attach.wadl] || 142 || port_state
 +
|-
 +
| [https://github.com/openstack/api-site/tree/master/api-ref/src/wadls/volume-api/src/v2/os-attach.wadl#L174 volume-api/src/v2/os-attach.wadl] || 174 || port_state
 +
|}
 +
 +
== Status ==
 +
 +
{| class="wikitable"
 +
|-
 +
! WADL !! Line !! Param
 +
|-
 +
| [https://github.com/openstack/api-site/tree/master/api-ref/src/wadls/compute-api/src/v2/ext/os-hosts.wadl#L118 compute-api/src/v2/ext/os-hosts.wadl]  || 118 || status
 +
|-
 +
| [https://github.com/openstack/api-site/tree/master/api-ref/src/wadls/compute-api/src/v2/ext/os-migrations.wadl#L29 compute-api/src/v2/ext/os-migrations.wadl] || 29 || status
 +
|-
 +
| [https://github.com/openstack/api-site/tree/master/api-ref/src/wadls/compute-api/src/v2/ext/os-migrations.wadl#L138 compute-api/src/v2/ext/os-migrations.wadl] || 138 || status
 +
|-
 +
| [https://github.com/openstack/api-site/tree/master/api-ref/src/wadls/identity-api/src/v3/wadl/common.ent#L128 identity-api/src/v3/wadl/common.ent] || 128 || status
 +
|-
 +
| [https://github.com/openstack/api-site/tree/master/api-ref/src/wadls/image-api/src/v2/common.ent#L98 image-api/src/v2/common.ent] || 98 || member_status
 +
|-
 +
| [https://github.com/openstack/api-site/tree/master/api-ref/src/wadls/image-api/src/v2/common.ent#L118 image-api/src/v2/common.ent] || 118 || status
 +
|-
 +
| [https://github.com/openstack/api-site/tree/master/api-ref/src/wadls/image-api/src/v2/common.ent#L186 image-api/src/v2/common.ent] || 186 || status
 +
|-
 +
| [https://github.com/openstack/api-site/tree/master/api-ref/src/wadls/netconn-api/src/common.ent#L202 image-api/src/v2/common.ent] || 202 || status
 +
|-
 +
| [https://github.com/openstack/api-site/tree/master/api-ref/src/wadls/netconn-api/src/os-networks.wad#L245l netconn-api/src/os-networks.wadl] || 245 || status
 +
|-
 +
| [https://github.com/openstack/api-site/tree/master/api-ref/src/wadls/netconn-api/src/os-networks.wadl#L373 netconn-api/src/os-networks.wadl] || 373 || status
 +
|-
 +
| [https://github.com/openstack/api-site/tree/master/api-ref/src/wadls/netconn-api/src/os-networks.wadl#L467 netconn-api/src/os-networks.wadl] || 467 || status
 +
|-
 +
| [https://github.com/openstack/api-site/tree/master/api-ref/src/wadls/netconn-api/src/os-networks.wadl#L546 netconn-api/src/os-networks.wadl] || 546 || status
 +
|-
 +
| [https://github.com/openstack/api-site/tree/master/api-ref/src/wadls/netconn-api/src/os-networks.wadl#L636 netconn-api/src/os-networks.wadl] || 636 || status
 +
|-
 +
| [https://github.com/openstack/api-site/tree/master/api-ref/src/wadls/orchestration-api/src/v1/orchestration-api.wadl#L285 orchestration-api/src/v1/orchestration-api.wadl] || 285 || status
 +
|-
 +
| [https://github.com/openstack/api-site/tree/master/api-ref/src/wadls/orchestration-api/src/v1/orchestration-api.wadl#L1105 orchestration-api/src/v1/orchestration-api.wadl] || 1105 || resource_status
 +
|-
 +
| [https://github.com/openstack/api-site/tree/master/api-ref/src/wadls/orchestration-api/src/v1/orchestration-api.wadl#L1208 orchestration-api/src/v1/orchestration-api.wadl] || 1208 || resource_status
 +
|-
 +
| [https://github.com/openstack/api-site/tree/master/api-ref/src/wadls/orchestration-api/src/v1/orchestration-api.wadl#L1491 orchestration-api/src/v1/orchestration-api.wadl] || 1491 || status
 +
|-
 +
| [https://github.com/openstack/api-site/tree/master/api-ref/src/wadls/orchestration-api/src/v1/orchestration-api.wadl#L1499 orchestration-api/src/v1/orchestration-api.wadl] || 1499 || status_reason
 +
|-
 +
| [https://github.com/openstack/api-site/tree/master/api-ref/src/wadls/orchestration-api/src/v1/orchestration-api.wadl#L1567 orchestration-api/src/v1/orchestration-api.wadl] || 1567 || status
 +
|-
 +
| [https://github.com/openstack/api-site/tree/master/api-ref/src/wadls/orchestration-api/src/v1/orchestration-api.wadl#L1575 orchestration-api/src/v1/orchestration-api.wadl] || 1575 || status_reason
 +
|}

Latest revision as of 15:40, 14 June 2018

Analysis

13 calls that take a param with the word state in it

20 call that take a param with the word status in it

Nova and Neutron have calls with both state and status

Current Design

Methodology

git clone https://github.com/openstack/api-site.git
cd api-ref/src/wadls/
grep -nR "param .*state.*" *
grep -nR "param .*status.*" *

State

WADL Line Param
compute-api/src/v2/ext/os-admin-actions.wadl 527 state
compute-api/src/v2/ext/os-interface.wadl 109 port_state
compute-api/src/v2/ext/os-interface.wadl 134 port_state
netconn-api/src/common.ent 220 admin_state_up
netconn-api/src/os-networks.wadl 217 admin_state_up
netconn-api/src/os-networks.wadl 291 admin_state_up
netconn-api/src/os-networks.wadl 345 admin_state_up
netconn-api/src/os-networks.wadl 439 admin_state_up
netconn-api/src/os-networks.wadl 518 admin_state_up
netconn-api/src/os-networks.wadl 608 admin_state_up
telemetry-api/src/v2/os-telemetry-api-2.0.wadl 420 state
volume-api/src/v2/os-attach.wadl 142 port_state
volume-api/src/v2/os-attach.wadl 174 port_state

Status

WADL Line Param
compute-api/src/v2/ext/os-hosts.wadl 118 status
compute-api/src/v2/ext/os-migrations.wadl 29 status
compute-api/src/v2/ext/os-migrations.wadl 138 status
identity-api/src/v3/wadl/common.ent 128 status
image-api/src/v2/common.ent 98 member_status
image-api/src/v2/common.ent 118 status
image-api/src/v2/common.ent 186 status
image-api/src/v2/common.ent 202 status
netconn-api/src/os-networks.wadl 245 status
netconn-api/src/os-networks.wadl 373 status
netconn-api/src/os-networks.wadl 467 status
netconn-api/src/os-networks.wadl 546 status
netconn-api/src/os-networks.wadl 636 status
orchestration-api/src/v1/orchestration-api.wadl 285 status
orchestration-api/src/v1/orchestration-api.wadl 1105 resource_status
orchestration-api/src/v1/orchestration-api.wadl 1208 resource_status
orchestration-api/src/v1/orchestration-api.wadl 1491 status
orchestration-api/src/v1/orchestration-api.wadl 1499 status_reason
orchestration-api/src/v1/orchestration-api.wadl 1567 status
orchestration-api/src/v1/orchestration-api.wadl 1575 status_reason
Retrieved from "https://wiki.openstack.org/w/index.php?title=API_Special_Interest_Group/Current_Design/State_vs_Status&oldid=161998"