Skip to main content

description_of

Function description_of 

Source
pub fn description_of(
    schema: &ReferenceOr<Schema>,
    components: &Components,
) -> Result<Option<String>, RefError>
Expand description

What a property says about itself, and what it inherits by pointing somewhere else.

The field’s own sentence wins: it is about this field, where the named schema’s is about every field that shares the rule. A field that says nothing of its own takes the named schema’s, which is better than nothing and is all a bare $ref can leave behind.