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

Enable validation of an example payload #200

Closed
ThanksForAllTheFish opened this issue Dec 3, 2021 · 7 comments
Closed

Enable validation of an example payload #200

ThanksForAllTheFish opened this issue Dec 3, 2021 · 7 comments
Labels
enhancement New feature or request stale

Comments

@ThanksForAllTheFish
Copy link

It would be cool to enable Studio to validate an example payload against the message schema.

This would enable quick prototyping and move into a direction of one tool to rule them all, as currently it is possible to use third party validator like https://www.jsonschemavalidator.net

@ThanksForAllTheFish ThanksForAllTheFish added the enhancement New feature or request label Dec 3, 2021
@github-actions
Copy link

github-actions bot commented Dec 3, 2021

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.

@magicmatatjahu
Copy link
Member

Thanks for the feature proposal! :)

I don’t know, I thought it might help me, but not sure if someone feels the same restrictions since in the there are many json schema validators online (did not think of using those somehow)

Don't worry, it will be needed. Most likely we will do it as a separate panel where you can select a message/channel/scheme and validate the necessary inputs anyway.

@boyney123
Copy link
Contributor

Thanks for the idea @ThanksForAllTheFish , think this is a great idea ➕

@magicmatatjahu
Copy link
Member

Action points:

  • create new component to render new "view" where we will support mentioned possibility:
    • it should have one textarea section where people will be able to pass the example payload/headers.
    • it should have select section where people will be able to select given payload/headers from existing AsyncAPI doc
    • it should have section where we will show possible errors.
  • it should look like https://www.jsonschemavalidator.net/ but without that left input (there should be select section)
  • the style should be consistent with the style of the rest of the application
  • unit tests are welcome
  • please don't focus on the integration (panel switching etc). It's nice to have but not required. We can make integration as followup after writing that new panel.

Before contribution please start discussion to clarify implementation and your questions/problems :)

This problem is involved in the OpenForce event. Please don't contribute if you are not participating in this event. If the problem is not solved at the end of the event, feel free to contribute :)

@github-actions
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
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
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 Feb 16, 2023
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Jun 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request stale
Projects
None yet
Development

No branches or pull requests

3 participants