apiaryio / api-blueprint

API Blueprint
https://apiblueprint.org
MIT License
8.63k stars 2.14k forks source link

Description inheritance of BaseType #417

Open ephrin opened 6 years ago

ephrin commented 6 years ago

As MSON allows to define Named Base Types with its own descriptions it would be nice to have it available in render result when it used without additional descriptions of property.

Examples follows:

# Data Structures

## hash (string) - a unique identifier

## Entity (object)
+ id: FFFF (hash, sample)

The idea is when rendering of the Entity structure happens I should see description from type definition instead of just only it's real type (string). In case when description is provided for id field of Entity it will override inherited one from type definition.

Thanks.