Playing with OpenAPI documents as a binded volume

swagger-api / swagger-editor

Swagger Editor

https://editor.swagger.io

Apache License 2.0

8.93k stars 2.26k forks source link

Playing with OpenAPI documents as a binded volume #1679

Open hadrien-toma opened 6 years ago

hadrien-toma commented 6 years ago

Q	A
Bug or feature request?	X
Which Swagger/OpenAPI version?	All
Which Swagger-Editor version?	All
How did you install Swagger-Editor?	Docker image
Which browser & version?	All
Which operating system?	Ubuntu

Expected Behavior

I would like to be able to override the default OpenAPI document, running :

docker run -d -p 80:8080 --mount type=bind,src=$PWD/my-open_api-document,dst=/default-open_api-document swagger-editor

When an edition of the document will be made from the UI, it will updates the binded volume.

Current Behavior

Importing/exporting documents is only available from the UI.

Context

I really would like to separate the Swagger editor docker image from the OpenAPI document it is processing.

shockey commented 6 years ago

When an edition of the document will be made from the UI, it will updates the binded volume.

This is currently out of Swagger Editor's scope - it exclusively lives in the browser. Filesystem sync for editing would require a new application server to live within the Docker container, to mediate changes on the volume.

For now, Swagger Editor Live exists, but it currently lacks a Docker image. Maybe you would contribute that feature? 😄

I'm going to keep this open as type: out of scope so that we can hang onto this as an idea for a project that lives outside of Swagger Editor itself.

hadrien-toma commented 6 years ago

Alright, thank you for explanations, this is currently what I am doing but this implies adding another docker image to my workflow and I thought it may be avoided. It seems that it can't for the moment, no problem, thank you again for your answer 😉.

hadrien-toma commented 4 years ago

Hello @shockey, is it still out of scope :innocent:? Swagger Editor Live lacks popularity and support but works really well and I feel so comfortable working with it that I think it will be a great added value of swagger-editor core. Moreover, if it is not out of scope, I would be happy to help developing this feature :grin:. :crossed_fingers:

webron commented 4 years ago

@hadrien-toma At the moment, it is not within our immediate scope, and I can't say for sure it will be in 2020 as we have quite an impressive roadmap to work on. That said, I'm happy to explore this further as an option. Feel free to ping me again if you don't hear back. Thanks1