Skip to content

Capture rules relative to required fields and how they should be modeled in OpenAPI #237

@markweitzel

Description

@markweitzel

The following rules need to be captured, either in a section on JSON models OR in a complementary document on OpenAPI.

If you also support PUT then, then model depends on whether you have a required fields or not.
If you have no required fields, then again, you can use 1 model for everything.
If you have some required fields, then create a model with the required fields for PUT request/response, GET response, and PATCH response. Use a separate model where NO fields are required for PATCH request.

Also, note that you can never add new required fields to a model as this is a breaking change.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions