NAS-133728 / 25.10 / Add NotRequired default value to our API

[creatorcary]

Pydantic does not allow named fields to be omitted entirely from models; in order for a field to be not required, it must have a default. NotRequired default value is a workaround to the problem. Any fields that are set to NotRequired will be excluded from model serialization.

Example:

class A(BaseModel):
    a: int
    b: int = 4
    c: int = NotRequired

A(a=1).model_dump()
# {'a': 1, 'b': 4}
A(a=1, c=2).model_dump()
# {'a': 1, 'b': 4, 'c': 2}

http://jenkins.eng.ixsystems.net:8080/job/tests/job/api_tests/2702/

[bugclerk]

Jira URL: https://ixsystems.atlassian.net/browse/NAS-133728

[yocalebo]

ping @themylogin what do you think? I like this idea. I believe it will become valuable when we start migrating APIs like our network plugin 😬

[themylogin]

Do integration tests pass with these changes?

[bugclerk]

JIRA ticket https://ixsystems.atlassian.net/browse/NAS-133728 is targeted to the following versions which have not received their corresponding PRs: 25.10

[bugclerk]

This PR has been merged and conversations have been locked.
If you would like to discuss more about this issue please use our forums or raise a Jira ticket.