search

Apicurio / apicurio-studio

Open Source API Design
https://www.apicur.io/studio/
Apache License 2.0
987 stars 497 forks source link

Live documentation does not display summary #1112

Open chisholmd opened 4 years ago

chisholmd commented 4 years ago

I am tested products to be used by our team and yours fits our needs best. However, the live documentation looks like it has this bug.

Here is the repro https://studio.apicur.io/preview?aid=25747

Says but summary is present for both test calls.

EricWittmann commented 4 years ago

Unfortunately the link you sent is the "private" view of the generated documentation. If you want other users to see the documentation, you must "share" it by doing this:

image

That said, you should also know that we use the ReDoc project to display the documentation. If there is a bug/feature for the generated docs then I'm afraid you will need to open an issue with ReDoc here:

https://github.com/Redocly/redoc/issues

chisholmd commented 4 years ago

Got it, thanks

On Mon, Apr 13, 2020 at 10:38 AM Eric Wittmann notifications@github.com wrote:

Unfortunately the link you sent is the "private" view of the generated documentation. If you want other users to see the documentation, you must "share" it by doing this:

[image: image] https://user-images.githubusercontent.com/1890703/79131794-2f844800-7d77-11ea-9309-c35916f4784a.png

That said, you should also know that we use the ReDoc project to display the documentation. If there is a bug/feature for the generated docs then I'm afraid you will need to open an issue with ReDoc here:

https://github.com/Redocly/redoc/issues

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/Apicurio/apicurio-studio/issues/1112#issuecomment-613006068, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADHG555PT4CRXYPS7X44EQLRMNEYTANCNFSM4MGFRD2Q .

--

Dave Chisholm http://lonecrow.net/

Mobile: 604-865-0704

4879 Sunshine Coast Hwy, Sechelt BC V0N 3A2

hyzyla commented 3 years ago

Hi, the same for me. Steps to reproduce

  1. Create new project
  2. Create new path
  3. Add summary
  4. Click "Live documentation"

image

hyzyla commented 3 years ago

I found the root of the problem, I have created path summary instead of operation summary OnPaste 20210429-184028

hyzyla commented 3 years ago

Created related PR in ReDoc for improving this situation https://github.com/Redocly/redoc/pull/1596