Skip to main content
Version: Next 🚧

[I] MetadataInfoOptions

Properties

PropertyTypeDescription
canonicalVisibility?VisibilityThe visibility to be used as the baseline against which MetadataInfo.isEmptied and MetadataInfo.isTransformed are computed. If not specified, Visibility.None is used, which will consider that any model that has fields that are only visible to some visibilities as transformed.

Methods

canShareProperty()?

optional canShareProperty(property): boolean

Optional callback to indicate that a property can be shared with the canonical representation even for visibilities where it is not visible.

This is used, for example, in OpenAPI emit where a property can be marked readOnly: true to represent @visibility("read") without creating a separate schema schema for Visibility.Read.

Parameters

ParameterType
propertyModelProperty

Returns

boolean