Syndesis: OpenAPI v3.0 customization freezes Syndesis frontend

Created on 5 Feb 2019  路  9Comments  路  Source: syndesisio/syndesis

This is a...


[ ] Feature request
[ ] Regression (a behavior that used to work and stopped working in a new release)
[x] Bug report  
[ ] Documentation issue or request

Description

Trying to create an API client connector with OpenAPI v3.0 to freezes the frontend of Syndesis.
Note that nowhere in the page is specified which version should be used.
As an example I used https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml.
No link can be clicked, only way to get out of that situation is to enter a new URL or refresh.
OpenAPI v2.0 work just fine.

cabug closeverified grouuxd prip2 sourcqe

All 9 comments

Requirement to use OpenAPI 2.0 is documented in 7.1. Develop REST API client connectors and in 5.3. Create a REST API connector.

This seems straightforward to me. The UI shouldn't "freeze" if a file type is not recognized. We should instead raise an error message or warning that that API version of the selected file is not supported.
@zregvart is that possible to do from the backend?
@gashcrumb to see how feasible it would be to bring up an error message in the UI once the user has tried to add a file that uses an unsupported API version
@TovaCohen for the actual wording to use in an error message

For the error message, maybe:
This document cannot be uploaded. Provide an OpenAPI 2.0 document.

The provided file is validated against the OpenAPI 2.0 schema. So right now this generates errors:

Screenshot_2019-04-01 Syndesis

I think this was improvement that we made via #4542.

(And) We can add additional validation that the user provided file is an OpenAPI 2.0 (not OpenAPI 3.0) on the backend and create a more meaningful error for the user.

@zregvart may i reassign this to you then so you can do that additional validation?

With #5587 the error will look like:
Screenshot_2019-06-04 Syndesis(2)
Screenshot_2019-06-04 Syndesis(1)

Looks great to me! Thanks @zregvart!

Works even on react, great work @zregvart !

Was this page helpful?
0 / 5 - 0 ratings