Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BUG] arp API endpoint lacks proper documentation on valid values for the ip field #3215

Open
lunkwill42 opened this issue Nov 19, 2024 · 0 comments
Labels
bug documentation Related to documentation of NAV

Comments

@lunkwill42
Copy link
Member

Describe the bug

This is the docstring used to generate the on-line API documentation:

"""Lists ARP records.
*Because the number of ARP records often is huge, the API does not support
fetching all and will ask you to use a filter if you try.*
Filters
-------
- `active`: *set this to list only records that are still active. Enabling
this will **ignore** any start- and endtime filters present in the same
request.*
- `starttime`: *if set without endtime: lists all active records at that
timestamp*
- `endtime`: *must be set with starttime: lists all active records in the
period between starttime and endtime*
- `ip`
- `mac`: *supports prefix filtering - for instance "mac=aa:aa:aa" will
return all records where the mac address starts with aa:aa:aa*
- `netbox`
- `prefix`
For timestamp formats, see the [iso8601 module
doc](https://pypi.python.org/pypi/iso8601) and <https://xkcd.com/1179/>.
`end_time` timestamps shown as `"9999-12-31T23:59:59.999"` denote records
that are still active.
"""

This lacks information about what values are valid for the ip field. In particular, it does not promote the "hidden" ability to search for subnet addresses (i.e. ip=10.0.42.0/24 is a valid filter value)

Expected behavior

The online documentation should include a paragraph about valid ip values.

Environment (please complete the following information):

  • NAV version installed: 5.11.0
@lunkwill42 lunkwill42 added bug documentation Related to documentation of NAV labels Nov 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug documentation Related to documentation of NAV
Projects
None yet
Development

No branches or pull requests

1 participant