yahoo-eng-team team mailing list archive

[OpenStack Infra <1749024@xxxxxxxxxxxxxxxxxx>]

Reviewed:  https://review.openstack.org/567005
Committed: https://git.openstack.org/cgit/openstack/neutron-lib/commit/?id=6ad1a623e30b487bb81543fbfc51f53a375b2b9b
Submitter: Zuul
Branch:    master

commit 6ad1a623e30b487bb81543fbfc51f53a375b2b9b
Author: Hongbin Lu <hongbin.lu@xxxxxxxxxx>
Date:   Tue May 8 19:08:14 2018 +0000

    api-ref: document sorting parameters for address scope
    
    API users can use the 'sort_key' and 'sort_dir' to do the sorting
    on list result. This patch add documentation of these two parameters
    for address scope resource.
    
    Change-Id: I2016812fccc870900fb70fa9cf0358b98a7356b3
    Closes-Bug: #1749024


** Changed in: neutron
       Status: In Progress => Fix Released

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

Title:
  api-ref: document the list of valid sort_keys

Status in neutron:
  Fix Released

Bug description:
  The api-ref describe how the sorting works in general:
  https://developer.openstack.org/api-ref/network/v2/#sorting . However,
  it doesn't explicitly list all the valid sort_keys for each API
  resources.

  Listing all the sort_keys for each API resources is necessary because
  the list are different across resources. End-users cannot predict
  which sort_key will work for which resource unless the information is
  explicitly documented.

  We could refer how nova's did for documenting the sorting feature:
  https://developer.openstack.org/api-ref/compute/#list-servers-detailed

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