redoc icon indicating copy to clipboard operation
redoc copied to clipboard
verified publisher icon Redocly

Optionally render object schema title and descriptions

Open aleung opened this issue 5 years ago • 12 comments

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

aleung avatar Jan 12 '21 10:01 aleung

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

aleung avatar Apr 19 '21 08:04 aleung

Hey @aleung!

Thanks for your PR and thanks for a ping!

I'll try to review it on weekends.

RomanHotsiy avatar Apr 23 '21 10:04 RomanHotsiy

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 avatar Apr 29 '21 20:04 RomanHotsiy

👀

alonsohki avatar Aug 30 '21 13:08 alonsohki

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

AnthonySuper avatar Nov 18 '21 17:11 AnthonySuper

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 avatar Mar 23 '22 15:03 RomanHotsiy

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

aleung avatar Mar 24 '22 05:03 aleung

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

RomanHotsiy avatar Mar 28 '22 14:03 RomanHotsiy

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

santialbo avatar Oct 04 '23 10:10 santialbo

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

ddluke avatar Jan 04 '24 08:01 ddluke

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.

aleung avatar Jan 10 '24 05:01 aleung

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

  • NPM: https://www.npmjs.com/package/@aleung/redoc
  • CDN: https://unpkg.com/@aleung/redoc@latest/bundles/redoc.standalone.js
  • Source: https://github.com/aleung/redoc

aleung avatar Jan 26 '24 09:01 aleung