Feature/add title #871
Feature/add title #871
Conversation
integration test code coverage
Coverage Breakdown • (19%)
|
unit test code coverage
Coverage Breakdown • (89%)
|
libV2/schemaUtils.js
Outdated
| utils.addToJsonPath(currentPath, [compositeKeyword, index])); | ||
| }) }; | ||
| return { | ||
| title: schema.title, |
There was a problem hiding this comment.
We should only add title and description fields if they have a valid value.
Let's do this for all other places where we're adding title and description
There was a problem hiding this comment.
you mean undefined title and description ?
The key is already dropped when we do stringification of the type data right ? and thats why we never get undefined in types
There was a problem hiding this comment.
Yes it doesn't affect the type information. But you're adding unnecessary fields into the schema object that is passed and used everywhere in the module. The undefined fields are not just added for the type information.
Which I'm trying to avoid.
libV2/schemaUtils.js
Outdated
| */ | ||
| if (resolveFor === TYPES_GENERATION) { | ||
| return { | ||
| title: schema.title, |
There was a problem hiding this comment.
Why don't we add all of the content from schema object ?
| title: schema.title, | |
| ...schema |
There was a problem hiding this comment.
Agreed, but since spread of objects wasn't supported here (due to some problem related to ES version required vs present in .eslintrc), i used it explicitly which i felt to be fine as well 😅 .
| createProperties = (param) => { | ||
| const { schema } = param; | ||
| return { | ||
| description: schema.description, |
There was a problem hiding this comment.
Q: Should we add title and description to the param fields ? How does this affect the types UI in the collection for the params ?
There was a problem hiding this comment.
It doesn't affect the types UI for params
Added title and description to type schema for 2-way-sync