NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-07-14 09:51:22 -06:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity

API Filtering Documentation Changes

Browse Source 
* Fixed typo
* Clarified documentation regarding filtering multiple times (some filters can, some cannot)
This commit is contained in:
dansheps 2019-03-11 15:09:36 -05:00
parent 28331dfd53
commit 332487efcd
2 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
CHANGELOG.md
View File

@ -1,3 +1,10 @@
v2.5.9 (FUTURE)
## Bug Fixes
* [#2577](https://github.com/digitalocean/netbox/issues/2577) - Clarification of wording in API regarding filtering
* [#2991](https://github.com/digitalocean/netbox/issues/2991) - Correct documentation for API Filtering
v2.5.8 (2019-03-11) v2.5.8 (2019-03-11)
## Enhancements ## Enhancements

2
docs/api/overview.md
View File

@ -261,7 +261,7 @@ A list of objects retrieved via the API can be filtered by passing one or more q
GET /api/ipam/prefixes/?status=1 GET /api/ipam/prefixes/?status=1
``` ```
The same filter can be incldued multiple times. These will effect a logical OR and return objects matching any of the given values. For example, the following will return all active and reserved prefixes: Certain filters can be included multiple times within a single request. These will effect a logical OR and return objects matching any of the given values. For example, the following will return all active and reserved prefixes:
``` ```
GET /api/ipam/prefixes/?status=1&status=2 GET /api/ipam/prefixes/?status=1&status=2