Public bug reported: Currently, the only documentation about filters is: https://developer.openstack.org/api-ref/network/v2/#filtering-and- column-selection . It explains the high level behavior about filters but doesn't have detailed information about the exact list of filters for each resource.
It would be nice if neutron can document all the filters for each API resources. This is desirable because the behavior of each filter is heterogeneous across different API resources. From end-users point of view, they need to know exactly which filter is supported by which resource and how to specify each filter value. If the filters documentation is missing or incomplete, it is hard to predict the API behavior which will cause issue like: https://bugs.launchpad.net/neutron/+bug/1418635 . ** Affects: neutron Importance: Undecided Assignee: Hongbin Lu (hongbin.lu) Status: New ** Changed in: neutron Assignee: (unassigned) => Hongbin Lu (hongbin.lu) ** Description changed: It would be nice if neutron can document all the filters for each API resources. This is desirable because the behavior of each filter is heterogeneous across different API resources. From end-users point of view, they need to know exactly which filter is supported by which resource and how to specify each filter value. If the filters documentation is missing or incomplete, it is hard to predict the API behavior which will cause issue like: - https://developer.openstack.org/api-ref/network/v2/#filtering-and- - column-selection . + https://bugs.launchpad.net/neutron/+bug/1418635 . ** Description changed: + Currently, the only documentation about filters is: + https://developer.openstack.org/api-ref/network/v2/#filtering-and- + column-selection . It explains the high level behavior about filters but + doesn't have detailed information about the exact list of filters for + each resource. + It would be nice if neutron can document all the filters for each API resources. This is desirable because the behavior of each filter is heterogeneous across different API resources. From end-users point of view, they need to know exactly which filter is supported by which resource and how to specify each filter value. If the filters documentation is missing or incomplete, it is hard to predict the API behavior which will cause issue like: https://bugs.launchpad.net/neutron/+bug/1418635 . -- You received this bug notification because you are a member of Yahoo! Engineering Team, which is subscribed to neutron. https://bugs.launchpad.net/bugs/1747995 Title: api-ref: document all the filters of each resource Status in neutron: New Bug description: Currently, the only documentation about filters is: https://developer.openstack.org/api-ref/network/v2/#filtering-and- column-selection . It explains the high level behavior about filters but doesn't have detailed information about the exact list of filters for each resource. It would be nice if neutron can document all the filters for each API resources. This is desirable because the behavior of each filter is heterogeneous across different API resources. From end-users point of view, they need to know exactly which filter is supported by which resource and how to specify each filter value. If the filters documentation is missing or incomplete, it is hard to predict the API behavior which will cause issue like: https://bugs.launchpad.net/neutron/+bug/1418635 . To manage notifications about this bug go to: https://bugs.launchpad.net/neutron/+bug/1747995/+subscriptions -- Mailing list: https://launchpad.net/~yahoo-eng-team Post to : [email protected] Unsubscribe : https://launchpad.net/~yahoo-eng-team More help : https://help.launchpad.net/ListHelp
