yahoo-eng-team team mailing list archive

Thread
Date
[Bug 1603020] [NEW] There is no help info of the new filter "changed-since" added to Neutron resources list API

To: yahoo-eng-team@xxxxxxxxxxxxxxxxxxx
From: xiewj <xie.wenjun2@xxxxxxxxxx>
Date: Thu, 14 Jul 2016 10:04:21 -0000
Reply-to: Bug 1603020 <1603020@xxxxxxxxxxxxxxxxxx>
Sender: bounces@xxxxxxxxxxxxx
Public bug reported:

In Mitaka,
The spec of add-port-timestamp.rst introduces a new filter "changed-since",but in the help message of neutron resources list command.
However,this filter can actually work.
I think we should add the new filter "changed-since" to the help message of Neutron resources list API,
so can guide users to use correctly


The url add-port-timestamp.rst spec is as follows: 
https://github.com/openstack/neutron-specs/blob/master/specs/mitaka/add-port-timestamp.rst


[root@devstack218 devstack]# neutron port-list --changed-since 2016-07-14T03:46:37
+--------------------------------------+------------+-------------------+--------------------------------------------------------+
| id                                   | name       | mac_address       | fixed_ips                                              |
+--------------------------------------+------------+-------------------+--------------------------------------------------------+
| ea79eaef-d294-4527-b24c-5b9fe16a1f6c | port2_net1 | fa:16:3e:e7:38:a6 | {"subnet_id": "481cadf6-fa52-4739-80b2-331a3b90d7b6",  |
|                                      |            |                   | "ip_address": "198.51.100.7"}                          |
|                                      |            |                   | {"subnet_id": "60f56f75-ce94-498f-b4ad-0383db2796a8",  |
|                                      |            |                   | "ip_address":                                          |
|                                      |            |                   | "2001:db8:80d2:c4d3:f816:3eff:fee7:38a6"}              |
+--------------------------------------+------------+-------------------+--------------------------------------------------------+
[root@devstack218 devstack]# 

[root@devstack218 devstack]# neutron help port-list  
usage: neutron port-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                         [--max-width <integer>] [--noindent]
                         [--quote {all,minimal,none,nonnumeric}]
                         [--request-format {json}] [-D] [-F FIELD] [-P SIZE]
                         [--sort-key FIELD] [--sort-dir {asc,desc}]

List ports that belong to a given tenant.

optional arguments:
  -h, --help            show this help message and exit
  --request-format {json}
                        DEPRECATED! Only JSON request format is supported.
  -D, --show-details    Show detailed information.
  -F FIELD, --field FIELD
                        Specify the field(s) to be returned by server. You can
                        repeat this option.
  -P SIZE, --page-size SIZE
                        Specify retrieve unit of each request, then split one
                        request to several requests.
  --sort-key FIELD      Sorts the list by the specified fields in the
                        specified directions. You can repeat this option, but
                        you must specify an equal number of sort_dir and
                        sort_key values. Extra sort_dir options are ignored.
                        Missing sort_dir options use the default asc value.
  --sort-dir {asc,desc}
                        Sorts the list in the specified direction. You can
                        repeat this option.

output formatters:
  output formatter options

  -f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}
                        the output format, defaults to table
  -c COLUMN, --column COLUMN
                        specify the column(s) to include, can be repeated

table formatter:
  --max-width <integer>
                        Maximum display width, <1 to disable. You can also use
                        the CLIFF_MAX_TERM_WIDTH environment variable, but the
                        parameter takes precedence.

json formatter:
  --noindent            whether to disable indenting the JSON

CSV Formatter:
  --quote {all,minimal,none,nonnumeric}
                        when to include quotes, defaults to nonnumeric
[root@devstack218 devstack]#

** Affects: neutron
     Importance: Undecided
     Assignee: Yan Songming (songmingyan)
         Status: New

** Changed in: neutron
     Assignee: (unassigned) => xiewj (36429515-3)

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to neutron.
https://bugs.launchpad.net/bugs/1603020

Title:
  There is no help info of the new filter "changed-since" added to
  Neutron resources list API

Status in neutron:
  New

Bug description:
  In Mitaka,
  The spec of add-port-timestamp.rst introduces a new filter "changed-since",but in the help message of neutron resources list command.
  However,this filter can actually work.
  I think we should add the new filter "changed-since" to the help message of Neutron resources list API,
  so can guide users to use correctly

  
  The url add-port-timestamp.rst spec is as follows: 
  https://github.com/openstack/neutron-specs/blob/master/specs/mitaka/add-port-timestamp.rst

  
  [root@devstack218 devstack]# neutron port-list --changed-since 2016-07-14T03:46:37
  +--------------------------------------+------------+-------------------+--------------------------------------------------------+
  | id                                   | name       | mac_address       | fixed_ips                                              |
  +--------------------------------------+------------+-------------------+--------------------------------------------------------+
  | ea79eaef-d294-4527-b24c-5b9fe16a1f6c | port2_net1 | fa:16:3e:e7:38:a6 | {"subnet_id": "481cadf6-fa52-4739-80b2-331a3b90d7b6",  |
  |                                      |            |                   | "ip_address": "198.51.100.7"}                          |
  |                                      |            |                   | {"subnet_id": "60f56f75-ce94-498f-b4ad-0383db2796a8",  |
  |                                      |            |                   | "ip_address":                                          |
  |                                      |            |                   | "2001:db8:80d2:c4d3:f816:3eff:fee7:38a6"}              |
  +--------------------------------------+------------+-------------------+--------------------------------------------------------+
  [root@devstack218 devstack]# 

  [root@devstack218 devstack]# neutron help port-list  
  usage: neutron port-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                           [--max-width <integer>] [--noindent]
                           [--quote {all,minimal,none,nonnumeric}]
                           [--request-format {json}] [-D] [-F FIELD] [-P SIZE]
                           [--sort-key FIELD] [--sort-dir {asc,desc}]

  List ports that belong to a given tenant.

  optional arguments:
    -h, --help            show this help message and exit
    --request-format {json}
                          DEPRECATED! Only JSON request format is supported.
    -D, --show-details    Show detailed information.
    -F FIELD, --field FIELD
                          Specify the field(s) to be returned by server. You can
                          repeat this option.
    -P SIZE, --page-size SIZE
                          Specify retrieve unit of each request, then split one
                          request to several requests.
    --sort-key FIELD      Sorts the list by the specified fields in the
                          specified directions. You can repeat this option, but
                          you must specify an equal number of sort_dir and
                          sort_key values. Extra sort_dir options are ignored.
                          Missing sort_dir options use the default asc value.
    --sort-dir {asc,desc}
                          Sorts the list in the specified direction. You can
                          repeat this option.

  output formatters:
    output formatter options

    -f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}
                          the output format, defaults to table
    -c COLUMN, --column COLUMN
                          specify the column(s) to include, can be repeated

  table formatter:
    --max-width <integer>
                          Maximum display width, <1 to disable. You can also use
                          the CLIFF_MAX_TERM_WIDTH environment variable, but the
                          parameter takes precedence.

  json formatter:
    --noindent            whether to disable indenting the JSON

  CSV Formatter:
    --quote {all,minimal,none,nonnumeric}
                          when to include quotes, defaults to nonnumeric
  [root@devstack218 devstack]#

To manage notifications about this bug go to:
https://bugs.launchpad.net/neutron/+bug/1603020/+subscriptions
Follow ups

[Bug 1603020] Re: There is no help info of the new filter "changed-since" added to Neutron resources list API
From: Brandon Logan, 2016-07-15