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

Improve JSON Schema Editor #1105

Open
6 tasks
Tracked by #748
KhudaDad414 opened this issue May 29, 2024 · 2 comments
Open
6 tasks
Tracked by #748

Improve JSON Schema Editor #1105

KhudaDad414 opened this issue May 29, 2024 · 2 comments
Assignees

Comments

@KhudaDad414
Copy link
Member

KhudaDad414 commented May 29, 2024

Problem

The work started in #1065 is a great start, but in my opinion, a functional visual JSON Schema editor needs more attention. There are some missing features I think are essential for it to be considered production-ready.

Solution

First of all, I propose creating a separate package for the visual JSON Schema editor. This will help us to publish it separately and create a separation of concerns in the studio as well.

Rabbit holes

...

Scope

  • Move the JSON Schema editor to a separate package.
  • Improve the JSON Schema editor's "Add New Property" feature.
  • Make the JSON Schema editor field names editable.
  • Make the JSON Schema editor's look and feel follow the provided design.
  • Support combiners (anyOf, oneOf, allOf) in the JSON Schema editor.
  • Design and implement a basic type selector for the JSON Schema editor.

Out of bounds

Supporting $refs is out of scope.
A complete type editor would be out of scope. (too complex and should be considered in a separate pitch after the design is finalized)

Success criteria

  • Have a published package called @asyncapi/json-schema-editor that contains a React component for editing JSON Schemas.
  • Make adding a new field easier. When I click on "New Property", a new empty property should appear with the default type of string.
  • Make the property names editable.
  • Make the JSON Schema editor look and behave like the provided design.
  • Support anyOf, oneOf, and allOf combiners in objects as well as in arrays.
@KhudaDad414 KhudaDad414 self-assigned this May 29, 2024
@KhudaDad414 KhudaDad414 changed the title [PITCH]: JSON Schema Editor Improvements JSON Schema Editor Improvements Jun 11, 2024
@KhudaDad414 KhudaDad414 changed the title JSON Schema Editor Improvements Improve JSON Schema Editor Jun 11, 2024
@KhudaDad414
Copy link
Member Author

/progress 50

DropdownMenu has been refactored to be more flexible to be used in JSON Schema Type Editor. #1108

Copy link

This issue has been automatically marked as stale because it has not had recent activity 😴

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 ❤️

@github-actions github-actions bot added the stale label Oct 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Backlog
Development

No branches or pull requests

1 participant