Quantum-api-filters
Filters for Quantum API
Summary
The goal of this blueprint is to improve the Quantum API by providing a mechanism allowing users to specify filters to be applied on responses. Such mechanism would be particularly useful for "list" API operations, which might return large amounts of data.
Typical Use Cases
We list in this section situations in which API filters might be employed by users of the Quantum API. Please feel free to add your own use cases here.
- Retrieve only ports in a specific administrative state
- Retrieve only ports in a specific operational state
- Retrieve only ports with an interface plugged
- Retrieve only networks with operational ports
- Retrieve only networks with interfaces plugged
- Retrieve only networks matching specific names or name patterns
Specification
It makes sense for users to specify these filters using the request URI's query string. For instance:
1) Get only ports operationally UP
