define default values in openapi spec

NetBox version

v2.11.1

Feature type

Data model extension

Proposed functionality

It would be nice if the default values for each property (if any) are also defined in the Netbox OpenAPI spec. They are, so far I can see, not defined for each and every object.

For example:

        "status": {
          "title": "Status",
          "type": "string",
          "enum": [
            "planned",
            "provisioning",
            "active",
            "offline",
            "deprovisioning",
            "decommissioned"
          ]
        },

could be defined as

        "status": {
          "title": "Status",
          "type": "string",
          "default": "active",
          "enum": [
            "planned",
            "provisioning",
            "active",
            "offline",
            "deprovisioning",
            "decommissioned"
          ]
        },

Since active value for status is the default returned by the API.

Use case

This helps us updating various netbox resources using OpenAPI libs.

Database changes

No response

External dependencies

No response

[FalcoSuessgott]

@jeremystretch nvm, I found an example:

https://github.com/netbox-community/netbox/blob/28ca815c8855b06e4250e7610fadc7c968c91dcb/netbox/dcim/api/serializers.py#L902-L920

I will look into it this week then

[github-actions[bot]]

This issue has been automatically closed due to lack of activity. In an effort to reduce noise, please do not comment any further. Note that the core maintainers may elect to reopen this issue at a later date if deemed necessary.