Add deprecated field to Input #2360
Merged
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
- Allow inputs to be marked as deprecated
- If they are, declare them deprecated in the openapi schema
* Allow inputs to be marked as deprecated * If they are, declare them deprecated in the openapi schema
erbridge
reviewed
May 23, 2025
| @@ -73,6 +73,7 @@ def Input( # pylint: disable=invalid-name, too-many-arguments | |||
| max_length: Optional[int] = None, | |||
| regex: Optional[str] = None, | |||
| choices: Optional[List[Union[str, int]]] = None, | |||
| deprecated: Optional[bool] = None, | |||
There was a problem hiding this comment.
Does this need to be optional? Couldn't it be this?
Suggested change
| deprecated: Optional[bool] = None, | |
| deprecated: bool = False, |
and only set field_kwargs["deprecated"] at all if it's True?
There was a problem hiding this comment.
I'd rather it be Optional to minimise the impact to the openapi schema unless the user wants to explicitly declare the deprecation
There was a problem hiding this comment.
That's what I mean, too. Only ever set field_kwargs["deprecated"] = True if deprecated == True, otherwise, treat False like you currently treat None?
There was a problem hiding this comment.
I think Optional captures this behaviour in a clearer way, only writing the new field if it is explicitly invoked by the user.
erbridge
approved these changes
May 23, 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.