This PR adds a description field on base-type, which serves to take the descriptive burden off name so that it can more properly be used to identify types for the purposes of rendering them.
For schema generators already in the code base where such specializations do not warrant a distinct name (string derivatives and number derivatives), the new description field is used instead.
For schema generators for more complicated types (array, either, dictionary) name is constant and description takes the burden of describing child schema.
The codebase has been reviewed for any opportunities to include information in the schema itself rather than guess what type it is (i.e., make schemas more characteristic). I think I managed to get them all, but in reviewing, I do think the choice type might be better reworked into a type more properly than through assertions.
To do:
[ ] Update changelog to reflect any breaking changes
This PR adds a
descriptionfield on base-type, which serves to take the descriptive burden offnameso that it can more properly be used to identify types for the purposes of rendering them.For schema generators already in the code base where such specializations do not warrant a distinct
name(string derivatives and number derivatives), the newdescriptionfield is used instead.For schema generators for more complicated types (array, either, dictionary)
nameis constant anddescriptiontakes the burden of describing child schema.The codebase has been reviewed for any opportunities to include information in the schema itself rather than guess what type it is (i.e., make schemas more characteristic). I think I managed to get them all, but in reviewing, I do think the
choicetype might be better reworked into a type more properly than through assertions.To do: