Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

remove the string option from Model definitions in the schema and enforce the object with model property. #1238

Open
vordimous opened this issue Sep 10, 2024 · 0 comments
Labels
devx Effects the Developer Experience

Comments

@vordimous
Copy link
Contributor

Describe the solution you'd like
When referencing a model, the current options allow for a shortcut definition of a primitive model.

            - status:
                - 401
                - 404
              content-type: 
                - text/plain
              content: string

This shortcut is a net neutral or slightly worse given the added complexity of explaining the cases this is allowed and the overall readability of the config.

Using the object definition for all cases adds very little extra code for a more consistent DX:

            - status:
                - 401
                - 404
              content-type: 
                - text/plain
              content:
                model: string
@vordimous vordimous added devx Effects the Developer Experience needs_triage Unknowns need to be addressed labels Sep 10, 2024
@vordimous vordimous removed the needs_triage Unknowns need to be addressed label Sep 17, 2024
@vordimous vordimous self-assigned this Sep 17, 2024
@vordimous vordimous removed their assignment Oct 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devx Effects the Developer Experience
Projects
None yet
Development

No branches or pull requests

1 participant