api-ref: document the list of valid sort_keys

[Hongbin Lu]

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

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/560635

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/560681

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/561069

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/561682

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/562811

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/562824

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/561069
Committed: https://git.openstack.org/cgit/openstack/neutron-lib/commit/?id=43405bff268149fb382cbce9c659acedcbbd1099
Submitter: Zuul
Branch: master

commit 43405bff268149fb382cbce9c659acedcbbd1099
Author: Hongbin Lu <email address hidden>
Date: Thu Apr 12 22:44:46 2018 +0000

    api-ref: document sorting parameters for security

    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 l2 networking resources, including rbac policy, security group
    and security group rule.

    Change-Id: I985734e7f7bed56aabd8420f46dec2aa25958e02
    Partial-Bug: #1749024

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/560681
Committed: https://git.openstack.org/cgit/openstack/neutron-lib/commit/?id=75d9d80950eb0e4852e2c27489518e3be65866d2
Submitter: Zuul
Branch: master

commit 75d9d80950eb0e4852e2c27489518e3be65866d2
Author: Hongbin Lu <email address hidden>
Date: Wed Apr 11 22:51:20 2018 +0000

    api-ref: document sorting parameters for l3

    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 l3 networking resources, including floatingip, router, subnet,
    and subnetpool.

    Change-Id: I3f1a6fa6f9e3d30882986e8c6c9e80c033d03525
    Partial-Bug: #1749024

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/562824
Committed: https://git.openstack.org/cgit/openstack/neutron-lib/commit/?id=61f812bf4f80c0283708c1db74f2ed5e763dd806
Submitter: Zuul
Branch: master

commit 61f812bf4f80c0283708c1db74f2ed5e763dd806
Author: Hongbin Lu <email address hidden>
Date: Thu Apr 19 20:33:33 2018 +0000

    api-ref: document sorting for log management

    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 log endpoints.

    Change-Id: I3f8a92348c54171e1dd6f7b6471e67df40d3d789
    Partial-Bug: #1749024

[OpenStack Infra (hudson-openstack)]

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

commit e9578d9bfa78118a6573ba3a760ce65c11fdc1e2
Author: Hongbin Lu <email address hidden>
Date: Thu Apr 19 19:44:28 2018 +0000

    api-ref: document sorting for qos resources

    API users can use the 'sort_key' and 'sort_dir' to do the sorting
    on list result. This patch adds documentation of these two parameters
    for QOS related endpoints, including QoS policy and various
    qos rules.

    Change-Id: I8d85b986effce59cfaae248aa95a95e9fc5db88a
    Partial-Bug: #1749024

[OpenStack Infra (hudson-openstack)]

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

commit f9badcd66e41750adc35f2add249cdede6c79dbb
Author: Hongbin Lu <email address hidden>
Date: Wed Apr 11 20:38:10 2018 +0000

    api-ref: document sorting parameters for l2

    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 l2 networking resources, including port, segment, and trunk.

    Depends-On: I325396bb0256196ee6c6fc42cc812a0c75ae3827
    Change-Id: I7f3b9811c8b72dfbee87335ff0a56fae3148c366
    Partial-Bug: #1749024

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/561682
Committed: https://git.openstack.org/cgit/openstack/neutron-lib/commit/?id=341f8a18c93c0157b933e53d9ec309b62ae0c0fa
Submitter: Zuul
Branch: master

commit 341f8a18c93c0157b933e53d9ec309b62ae0c0fa
Author: Hongbin Lu <email address hidden>
Date: Mon Apr 16 17:50:16 2018 +0000

    api-ref: document sorting for resource management

    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 resource management endpoints, including flavor, service_profile,
    metering label and metering label rule.

    Partial-Bug: #1749024
    Change-Id: I2acf7fd11acd25b94cdeaf185a2be4ef5d51916a

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/567005

[OpenStack Infra (hudson-openstack)]

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 <email address hidden>
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

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/neutron-lib 1.15.0 release.