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

Schema representation improvements #253

Closed

Conversation

zlondrej
Copy link
Contributor

I made some changes to the way schemas are visualized to better fit my use cases, but I think they're more general use cases and are in-line with what OpenAPI is describing.

image

I also added new schema-compact-single-x-of-option option for more compact display of single item xxxOf. It would be better to move the schema link to the type column, but internal representation is a too messy for that and I can't spend that much extra time on it, as that would require substantial rewrite.

image

Additional details can be found in the documentation and changelog.

@wparad
Copy link
Member

wparad commented May 24, 2024

I'm concerned that there is just too much going on in this PR in order to test, validate, and review it effectively. Can you split this and start with just the smallest one change you consider to be most important, and then we can work on it from there?

Right now I have too many questions and the individuals discussions are going to get conflated as we try to discuss each one.

Copy link
Member

@wparad wparad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Re comment, please split.

@zlondrej
Copy link
Contributor Author

Well, I was expecting this a bit but it was worth a try. I will try to split them once I have some more time to spare on this.

@wparad
Copy link
Member

wparad commented May 24, 2024

Well, I was expecting this a bit but it was worth a try. I will try to split them once I have some more time to spare on this.

Sorry. Fwiw, there about 70% which is great, and 30% I have concerns with. Maybe PR everything that's refactoring, and open issues for the functional changes where we can discuss each one. In general, we like to avoid:

  • input parameters - they add confusion
  • Open transparency - think "as a user of the spec" rather than "as the developer of the spec"
  • Undetermined form - a feature can be great, but if we can't figure out how to display it perfectly then, it will be a struggle for users to not have unnecessary cognito overhead

Instead optimize for:

  • sane default
  • usability over features
  • clarity over transparency

@wparad
Copy link
Member

wparad commented May 31, 2024

Closing in favor of smaller PRs. Looking forward to them.

@wparad wparad closed this May 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants