Allow swagger URL and not just swagger file

[SkedGoDeploy]

Context

Currently, Apinf only allows API Managers to upload Swagger file to be rendered in the documentation browser.

User story

As an API Manager
I would like for Apinf to render a Swagger file hosted on a third party server
so I can develop and host my swagger file elsewhere and not have to manually upload changes

Feature request

Allow API Managers to specify a URL pointing to a Swagger file somewhere on the Internet. When the URL is provided, the Swagger file should be rendered in the Swagger UI.

Definition of done

• User can choose whether they want to upload a file or add a URL for showing a Swagger document in the Swagger UI
• If the user adds a URL, it needs to be stored for the purpose of showing the file in the Swagger UI
• When the user has made a selection, the other option should be disabled

Note: this solution should not affect the possibility of adding external documentation links

Original request

This is so that when we update our swagger file on our site, we don't have to remember to upload it to apinf.io

Wireframe

On opening the Manage dialog, user will now see Documentation link option and Documentation upload function appearing as radio buttons.
Selecting one option would disable the other option and vice versa. This is mentioned with instruction texts.
A feedback using S-alert can be shown mentioning which option has been enabled and which one disabled.

[bajiat]

Thanks for you interest in Apinf! This is a good idea and we can definitely consider this. I think it would be worthwhile to provide an option to either upload a file or to provide a link. Both of these would render in the Swagger UI. Does this meet your needs?

[bajiat]

Definition of done

• User can choose whether they want to upload a file or add a URL for showing a Swagger document in the Swagger UI
• If the user adds a URL, it needs to be stored for the purpose of showing the file in the Swagger UI
• When the user has made a selection, the other option should be disabled

Note: this solution should not affect the possibility of adding external documentation links

[brylie]

@bajiat and @SkedGoDeploy I updated the task description, moving the Definition of done and adding some more context.

[bajiat]

Comment for the Documentation URL: Note that the URL field could be used both for Swagger link and link to any other external documentation. If the URL points to a Swagger file, it is shown in the Swagger UI. If the URL points to any other resource, it is displayed as a link in the external documentation section.