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

default to property name for title #371

Open
red8888 opened this issue Nov 19, 2021 · 2 comments
Open

default to property name for title #371

red8888 opened this issue Nov 19, 2021 · 2 comments

Comments

@red8888
Copy link

red8888 commented Nov 19, 2021

I don't want to have to add a title for every object so I don't see "Untitled object" everywhere. Its really redundant because all my object names are what I would title them anyway. Is there config option to just plug in the object name in the docs if title field is absent?

@trieloff
Copy link
Collaborator

No, but this would be a good default if you are in the mood for a PR.

chrisdeely added a commit to chrisdeely/jsonschema2md that referenced this issue Jan 29, 2023
@chrisdeely
Copy link

I have been attempting to implement this enhancement via modifications to the schemaProxy, but it is clunky an error prone.

I'm not familiar enough with the patterns in use, but it seems that a more effective path forward would be to default each element's title property to the element's name during the schema transversal. The approach I have in the schemaProxy will likely require ensuring the element being interrogated is actually a property and not a reserved keyword.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants