Class DescriptionBuilderBaseAbstract

Protected Optional _options

Protected Abstract _genConstraints

• _genConstraints(prop): Promise<Content>

• Generates Content block with min, max, inclusiveMax, inclusiveMin from OpenAPIV3.SchemaObject if it exists

  Parameters

  • prop: SchemaObject

  Returns Promise<Content>

Protected Abstract _genDefault

• _genDefault(prop): Promise<Content>

• Generates Content block with default value for propertie from OpenAPIV3.SchemaObject if it exists

  Parameters

  • prop: SchemaObject

  Returns Promise<Content>

Protected Abstract _genDescr

• _genDescr(prop): Promise<Content>

• Generates Content block with description from OpenAPIV3.SchemaObject if it exists

  Parameters

  • prop: SchemaObject

  Returns Promise<Content>

Protected Abstract _genName

• _genName(prop): Promise<Content>

• Generates Content block with title from OpenAPIV3.SchemaObject if it exists

  Parameters

  • prop: SchemaObject

  Returns Promise<Content>

Protected Abstract _genPattern

• _genPattern(prop): Promise<Content>

• Generates Content block with pattern value from OpenAPIV3.SchemaObject if it exists

  Parameters

  • prop: SchemaObject

  Returns Promise<Content>

Protected Abstract _genReadOrWrite

• _genReadOrWrite(prop): Promise<Content>

• Generates Content block with read only or write only from OpenAPIV3.SchemaObject if it exists

  Parameters

  • prop: SchemaObject

  Returns Promise<Content>

Protected Abstract _genRequired

• _genRequired(required): Promise<Content>

• Generates Content blcok with required red flag from OpenAPIV3.SchemaObject if it exists

  Parameters

  • required: boolean

  Returns Promise<Content>