Skip to content
New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom

Additional parameter to start studio using core package with readOnly parameter. #1166

Open
neoandmatrix opened this issue Feb 28, 2025 · 1 comment · May be fixed by #1167
Open

Additional parameter to start studio using core package with readOnly parameter. #1166

neoandmatrix opened this issue Feb 28, 2025 · 1 comment · May be fixed by #1167
Labels
enhancement New feature or request

Comments

@neoandmatrix
Copy link

neoandmatrix commented Feb 28, 2025 •
edited
Loading

Reason/Context

Please try answering few of those questions

  • Why we need this improvement?
    As discussed here onwards a new command asyncapi start preview needs to be implemented for which studio has to be started in readOnly mode.

This should be done over existing implementation of mechanism of loading file and no extra websocket connections to be started and the readOnly should still only work with base64 string or url parameter or share when used outside of the to be implemented command asyncapi start preview.

Description

Please try answering few of those questions

  • What changes have to be introduced?
    An additional type in IncomingMessage needs to be added which when sent through existing websocket connection will allow to modify the state of frontend to readOnly.

  • Will this be a breaking change?

    NO
@neoandmatrix neoandmatrix added the enhancement New feature or request label Feb 28, 2025
@github-actions GitHub Actions
Copy link

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.

@neoandmatrix neoandmatrix linked a pull request Feb 28, 2025 that will close this issue
Draft
@github-actions github-actions bot mentioned this issue Mar 1, 2025
Open
# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
Studio - Kanban
Status: Backlog
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: additional changes for implementation of new preview command neoandmatrix/async-api-studio
1 participant
@neoandmatrix