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

Optionally render object schema title and descriptions #1497

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

aleung
Copy link

@aleung aleung commented Jan 12, 2021

It's a followup of #1035. Fixes #598, #720, #752.

Shown in operations but hidden in <SchemaDefinition> by default.

Before the fix:
Selection_012

After the fix:
Selection_013

@andriyl andriyl force-pushed the master branch 2 times, most recently from cc0c845 to 3c4ece9 Compare April 9, 2021 19:18
@aleung
Copy link
Author

aleung commented Apr 19, 2021

@RomanHotsiy Would you spend some time to review this PR?

@RomanHotsiy
Copy link
Member

Hey @aleung!

Thanks for your PR and thanks for a ping!

I'll try to review it on weekends.

@RomanHotsiy
Copy link
Member

Hey @aleung,

The PR looks great! thanks. I just don't fully like the UI part of it (especially the h3 heading).

Let me play with it on weekends and I'll merge it. Sorry for the delay, this should be merged soon.

@RomanHotsiy RomanHotsiy self-assigned this Apr 29, 2021
@alonsohki
Copy link

👀

@AnthonySuper
Copy link

This would be a very useful feature! Hope to see it merged soon.

@RomanHotsiy
Copy link
Member

Hey @aleung...

Sorry, we're super busy 🙈... We definitely plan to add support for this but a little bit later. Before, we want to clean up other PRs and release 2.0.

@RomanHotsiy RomanHotsiy modified the milestone: API console Mar 23, 2022
@aleung
Copy link
Author

aleung commented Mar 24, 2022

@RomanHotsiy Understood. Please let me know when you need me to rebase the PR on latest.

@RomanHotsiy
Copy link
Member

@aleung. Not. We'll ping you when we're done with the release.

@santialbo
Copy link

It's a pity this never got merged. It was certainly helpful.

@ddluke
Copy link

ddluke commented Jan 4, 2024

Is there any chance to get this merged? 2.x appears to be out by now. Or are there other ways to achieve this?

@aleung aleung force-pushed the fix/schema-description branch from 2505d81 to 6338fdc Compare January 10, 2024 05:40
@aleung aleung requested review from a team as code owners January 10, 2024 05:40
@aleung
Copy link
Author

aleung commented Jan 10, 2024

This PR is 4 years old. The main branch has a lot of changes and the merge conflict is difficult to resolve. I have managed to re-apply the changes on the latest main branch.

I must admit that the UI implementation is an ugly hack, and I lack expertise in UI development. I hope someone from Redocly could assist in improving it to align with the overall look and feel.

I am optimistic that this PR will be reviewed and merged.

@lornajane lornajane removed the request for review from a team January 10, 2024 15:08
@aleung
Copy link
Author

aleung commented Jan 26, 2024

For anyone who wants to use this feature, you can temporarily use my fork before this pull request gets merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

No description on schemas (e.g. response body schemas)
7 participants