search

Alfresco / rest-api-explorer

Public REST API Explorer
Apache License 2.0
37 stars 25 forks source link

Feature/ACS-937 migrate swagger UI to v3 #118

Closed andrea-ligios closed 3 years ago

andrea-ligios commented 3 years ago

The main goal of this PR is to migrate the REST API Explorer from the legacy Swagger UI 2 (which is EOL) to the new Swagger UI 3.

Other than that, it's also a good idea to upgrade all the libraries used and to replace the legacy Tomcat7 Maven Plugin with the latest Jetty Maven Plugin.

CLAassistant commented 3 years ago

CLA assistant check
All committers have signed the CLA.

mauriziovitale commented 3 years ago

Hi @andrea-ligios if you could add some description also for future memory thanks

Do you mean doc?

eromano commented 3 years ago

Hi @andrea-ligios if you could add some description also for future memory thanks

Do you mean doc?

I mean here in the PR: No description provided.

andrea-ligios commented 3 years ago

@gavincornwell it's likely a Swagger UI 3 issue, nothing we should be able to address:

image

If you agree and approve the PR, we can merge.

gavincornwell commented 3 years ago

@andrea-ligios Thanks for investigating and digging deeper, we have indeed had to live with bugs in the older version too.

However, this one is quite prominent :-( Is it actually still possible to use the "Try it Out" button despite the error? The response mentions circular references, have you done a quick check of our definition?

andrea-ligios commented 3 years ago

@andrea-ligios Thanks for investigating and digging deeper, we have indeed had to live with bugs in the older version too.

However, this one is quite prominent :-( Is it actually still possible to use the "Try it Out" button despite the error? The response mentions circular references, have you done a quick check of our definition?

It is possible to use the "Try it Out" button, and I've not found any problem in the API definition. The pivot element is just rendered differently than before (null instead of{})

Swagger UI 2: image

Swagger UI 3: image

In either case, it needs to get populated properly before being passed as a parameter, so I'm going to document this error in the API definition and then wait for your final review to merge the PR.