Public bug reported: 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 ** Affects: neutron Importance: Undecided Assignee: Hongbin Lu (hongbin.lu) Status: New ** Changed in: neutron Assignee: (unassigned) => Hongbin Lu (hongbin.lu) ** Description changed: The api-ref describe how the pagination works in general: https://developer.openstack.org/api-ref/network/v2/#pagination . 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. - NOTE: nova's api-ref does list all the sort_keys: + We could refer how nova's did for documenting the sorting feature: https://developer.openstack.org/api-ref/compute/#list-servers-detailed ** Description changed: - The api-ref describe how the pagination works in general: - https://developer.openstack.org/api-ref/network/v2/#pagination . - However, it doesn't explicitly list all the valid sort_keys for each API + 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. + 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 -- 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: New 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 -- Mailing list: https://launchpad.net/~yahoo-eng-team Post to : yahoo-eng-team@lists.launchpad.net Unsubscribe : https://launchpad.net/~yahoo-eng-team More help : https://help.launchpad.net/ListHelp
