fix: added stronger wording to pagination and fields #48
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR strengthens documentation messaging around pagination awareness and the use of the fields parameter to optimize API responses. The changes emphasize important behavioral aspects that users should be aware of when working with these API functions.
- Added explicit warning about paginated results in
netbox_get_objects - Reformatted function signature for better readability in
netbox_get_object_by_id - Strengthened recommendation to use
fieldsparameter innetbox_search_objects
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
ltucker
approved these changes
Oct 27, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.