Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SerializeOptions

Hierarchy

  • SerializeOptions

Index

Properties

Properties

Optional dumpSchemaContents

dumpSchemaContents: boolean

Optional dumpXMLRepresentationOfExamples

dumpXMLRepresentationOfExamples: boolean

Optional rootNodeDetails

rootNodeDetails: boolean

For root nodes additional details can be included into output. If the option is set to true, node content is returned as value of the specification root property. Other root properties are:

  • ramlVersion version of RAML used by the specification represented by the node
  • type type of the node: Api, Overlay, Extension, Library, or any other RAML type in fragments case
  • errors errors of the specification represented by the node
default

false

Optional serializeMetadata

serializeMetadata: boolean

Whether to serialize metadata

default

true

Generated using TypeDoc