studio
studio copied to clipboard
Add the ability to launch studio without editor and new file options
Reason/Context
We are tooling up the AsyncAPI API lifecycle in our organization and we think that stdio is a great tool for local development. We envision the DX being that a developer works on a spec locally and renders the visual form in Studio (locally) before raising a PR. We would love to use Studio as the IDE but because it does not support local $ref we are struggling with this part.
As we render studio locally we would like to use studio to show a live view of what the developer has defined in their asyncAPI similar to redoc-cli server opeanapi.yaml --watch
https://github.com/Redocly/redoc/blob/master/cli/README.md.
Because studio does not allow you to use local $ref we need to fully resolve the async api before we launch studio and "watch" the local file to resolve it again on change. With the $ref limitation we have a path forward but we would like to hide the Editor
and the New File
options in the left nav toolbar so that we can set better expectations with the local development that developers can use studio just to visually see what they have done in their IDE.
We also think that once the $ref limitation is addressed that we might still advocate to using the IDE to edit the files vs Studio but that all depends on how the $ref is supported in Studio.
Description
We think the changes are pretty simple. Just add some toolbar configuration that allows the user to define what toolbar options are visible. We would also need to update cli to allow these options or refer to a config file.
This can be done with reasonable defaults as to not make a breaking change.
The below image depicts what we are looking to support.
If we can get some consensus on this we are happy to contribute.
Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.
This issue has been automatically marked as stale because it has not had recent activity :sleeping:
It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.
There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.
Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.
Thank you for your patience :heart:
@magicmatatjahu Any thoughts on this? I see some progress has been made on $ref support.
@JSSAggie Can I work on this issue ?
This issue has been automatically marked as stale because it has not had recent activity :sleeping:
It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.
There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.
Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.
Thank you for your patience :heart: