Jump to: navigation, search

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

Line 1: Line 1:
 
= Analysis =
 
= 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 22: Line 26:
 
| [https://github.com/openstack/api-site/tree/master/api-ref/src/wadls/compute-api/src/v2/ext/os-admin-actions.wadl 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-admin-actions.wadl compute-api/src/v2/ext/os-admin-actions.wadl] || 527 || state
 
|-
 
|-
| 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 compute-api/src/v2/ext/os-interface.wadl] || 109 || port_state
 
|-
 
|-
| compute-api/src/v2/ext/os-interface.wadl || 134 || port_state
+
| [https://github.com/openstack/api-site/tree/master/api-ref/src/wadls/compute-api/src/v2/ext/os-interface.wadl compute-api/src/v2/ext/os-interface.wadl] || 134 || port_state
 
|-
 
|-
| netconn-api/src/common.ent || 220 || admin_state_up
+
| [https://github.com/openstack/api-site/tree/master/api-ref/src/wadls/netconn-api/src/common.ent netconn-api/src/common.ent] || 220 || admin_state_up
 
|-
 
|-
| 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 netconn-api/src/os-networks.wadl] || 217 || admin_state_up
 
|-
 
|-
| 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 netconn-api/src/os-networks.wadl] || 291 || admin_state_up
 
|-
 
|-
| 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 netconn-api/src/os-networks.wadl] || 345 || admin_state_up
 
|-
 
|-
| 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 netconn-api/src/os-networks.wadl] || 439 || admin_state_up
 
|-
 
|-
| 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 netconn-api/src/os-networks.wadl] || 518 || admin_state_up
 
|-
 
|-
| netconn-api/src/os-networks.wadl || 608 || admin_state_up
+
| [https://github.com/openstack/api-site/tree/master/api-ref/src/wadls/netconn-api/src/os-networks.wadl netconn-api/src/os-networks.wadl] || 608 || admin_state_up
 
|-
 
|-
| telemetry-api/src/v2/os-telemetry-api-2.0.wadl || 420 || state
+
| [https://github.com/openstack/api-site/tree/master/api-ref/src/wadls/telemetry-api/src/v2/os-telemetry-api-2.0.wadl telemetry-api/src/v2/os-telemetry-api-2.0.wadl] || 420 || state
 
|-
 
|-
| 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 volume-api/src/v2/os-attach.wadl] || 142 || port_state
 
|-
 
|-
| volume-api/src/v2/os-attach.wadl || 174 || port_state
+
| [https://github.com/openstack/api-site/tree/master/api-ref/src/wadls/volume-api/src/v2/os-attach.wadl volume-api/src/v2/os-attach.wadl] || 174 || port_state
 
|}
 
|}
  

Revision as of 20:33, 21 January 2015

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