search

b2ihealthcare / snow-owl

:owl: Snow Owl Terminology Server - a production-ready, scalable, FHIR Terminology Service compliant server that supports SNOMED CT International and Extensions, LOINC, RxNorm, UMLS, ICD-10, custom code systems and many others
https://docs.b2ihealthcare.com/snow-owl/
Apache License 2.0
258 stars 32 forks source link

API Doc "try it out" function hangs for API Path- /snomed-ct/v3/{path}/concepts #656

Closed colin-e-nhsd closed 3 years ago

colin-e-nhsd commented 4 years ago

SnowOwl Version: 7.8.2 (I believe, see earlier feature request)

Steps to Reproduce

  1. Open a browser window on the server API documentation pages (/snowowl/)

  2. Select the SNOEMED CT API page from the navigation

  3. Select the interface to GET Concepts from a branch (/snomed-ct/v3/{path}/concepts)

  4. Click the "Try it out" button

The interface will now hang, and then time out with a "This page is not responding" error.

This is reproducible in Firefox 68.11.0ESR and Edge 84.0.522.63 browsers.

Expected behavior The page section for the API should "enable", allowing parameters to be entered and the API tested.

Version

Additional context Behaviour is the same whether the user is authenticated (via Basic Auth) or not.

colin-e-nhsd commented 4 years ago

This was reproducible yesterday in multiple browsers, but not this morning. Closing as it is not reproducible.

cmark commented 4 years ago

Hi @colin-e-nhsd,

Thank you for reporting this issue. Yes, this happens sometimes, because the SNOMED CT model has a recursion in it, and the current Swagger UI version does not support them very well. Opening up multiple endpoints can crash the API docs site and require a full page refresh in order to open the specific endpoint. We are planning to migrate the current version to the new one, to see if that resolves the issue or not, and also move the specification from the current OpenAPI v2 to the v3 format. That might have better support in the latest Swagger UI release than v2.

I'd like to keep this issue open to track the progress of the new Swagger API docs version update.

Cheers, Mark

cmark commented 3 years ago

This issue is currently being investigated and improved on this branch: https://github.com/b2ihealthcare/snow-owl/tree/improvement/replace-swagger-ui-rapidoc

Swagger UI is a bit hard to handle and manage at this point and the responsiveness of the interface became unbearable (and non-deterministic) in the past few months, so we are thinking about replacing it with a better alternative that offers a cleaner interface, easier controls, better documentation and most importantly speed.

The planned release version for the new REST API UI is 7.17.0.

cmark commented 3 years ago

The fix for this issue has been pushed to the 8.0.0 major release, which is expected around the end of July/early August.

cmark commented 3 years ago

Hi @colin-e-nhsd,

The new, improved API documentation site is now available in the latest 8.0.0 release. Feel free to check it out, if you have the time.

Cheers, Mark