Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide appropriate error message on attempt to provide link of invalid openAPI specification file. #3237

Closed
Nazarah opened this issue Dec 14, 2017 · 2 comments
Assignees

Comments

@Nazarah
Copy link
Contributor

Nazarah commented Dec 14, 2017

Description:

When attempt is made to provide link of an API documentation file having different extension than json, yaml, or yml, the s-alert shows error message [[Object object]].
This is not intuitive enough and doesn't tell users the reason for failed add operation (different file extension).

So if attempt is made to add link for an invalid file type, on clicking import, s-alert should alert the user about the incorrect form type and prompt the user to use json, yaml or yml file.

User Story:
"As an API owner, I wish to see intuitive error message, so that I can be aware of the incorrect file type that I attempted to provide for adding an API."

Solution
Have the following error message in s-alert: "Invalid file type. Please provide link of a json, yaml or yml file containing atleast API name and Endpoint URL."

@marla-singer
Copy link
Contributor

@Nazarah Add details about environment and version of application

@Nazarah
Copy link
Contributor Author

Nazarah commented Dec 14, 2017

@marla-singer I tested and found this behavior in Vamos site, where release 0.52 had been deployed.
https://vamos.apinf.io
However, this can also be obtained from nightly.
That is why it is reported as an enhancement issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants