memphis icon indicating copy to clipboard operation
memphis copied to clipboard

Feature: Document "convert to JSON schema" option in UI

Open rnowling-memphis opened this issue 1 year ago • 2 comments

Current behavior

The documentation for schema verse configuration for JSON does not describe what the "Convert to JSON Schema" button does or provided examples for how to use it. This seems like a great feature that will make life easier for developers given that JSONSchema has a somewhat steep learning curve.

Suggested solution

Describe the functionality of the "Convert to JSON Schema" button and provide examples with screenshots.

Additional context

No response

Code of Conduct

  • [X] I agree to follow this project's Code of Conduct

Contributing Docs

  • [X] I agree to follow this project's Contribution Docs

rnowling-memphis avatar May 10 '23 01:05 rnowling-memphis

Adding @avrhamNeeman to this thread as well. @avrhamNeeman @rnowling-memphis , I am thinking about a different angle. Most developers just write JSON, right? So maybe we can remove that button, put the conversation "behind the stage", and write a plain json example instead of the official JSON Schema? Much easier to understand I think than the current situation.

yanivbh1 avatar May 10 '23 06:05 yanivbh1

@yanivbh1 I like this! We can let you write any JSON type; If you've written a JSON schema, we'll keep it AS-IS; If not, we will convert it.

avrhamNeeman avatar May 10 '23 08:05 avrhamNeeman