Add docs with more details on testing tools and update behavior for optional values #356
+191
−20
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
olaservo
changed the title
olaservo
commented
Apr 30, 2025
| | ------------------------- | ------------------------------ | --------------------------------- | | ||
| | Optional field (any type) | `{"required": false}` | Omit field entirely from request | | ||
| | Nullable field | `{"type": ["string", "null"]}` | May explicitly set to `null` | | ||
| | Empty array (when set) | `{"type": "array"}` | Send `[]` if explicitly set empty | |
There was a problem hiding this comment.
Related to the above changes - want some feedback on if this should be the expected behavior for optional objects and arrays.
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.
This is related to a few recurring issues and recent changes with how the Tools UI is working (or not) in certain scenarios. The intention of this doc is to call out more explicitly what is by design, and what to expect in the UI when using Inspector when testing different types of input parameters.
How Has This Been Tested?
Tests are updated, but doc needs to be reviewed to ensure its consistent with what we actually want to happen in the UI.
Breaking Changes
See:
docs/tools-testing.mdfor proposal for expected behavior.Types of changes
Checklist