Class MediaTreeBuilderBaseAbstract

MediaTreeBuilderBase generates HTTP Body information from openapi, add description for all properties and information about AllOf, AnyOf, OneOf. Also It include composition of DescriptionBuilder and can be extended by multiple descriptionBuilder realisations with any variatives.

Hierarchy

Constructors

constructor

Properties

_descriptionBuilder _options?

Methods

_genKeyDef _genTree _getSchemaObj build

Constructors

constructor

Properties

Protected _descriptionBuilder

_descriptionBuilder: DescriptionBuilder

Protected Optional _options

_options?: IRavageOptions

Methods

Protected Abstract _genKeyDef

  • _genKeyDef(obj, openapi, prevKey): Promise<Content>

  • Generates open bracket and desctiption of open schema block

    Parameters

    Returns Promise<Content>

Protected Abstract _genTree

  • _genTree(obj, openapi, prevKey?, required?): Promise<Content>

  • Generates Body tree by OpenAPIV3.ReferenceObject or OpenAPIV3.SchemaObject

    Parameters

    • obj: ReferenceObject | SchemaObject
    • openapi: OpenapiInfoV3
    • Optional prevKey: string
    • Optional required: boolean

    Returns Promise<Content>

Protected Abstract _getSchemaObj

  • _getSchemaObj(obj, openapi): Promise<SchemaObject>

  • Get schema by $ref from openapi.components.schemas if it's OpenAPIV3.ReferenceObject or reutrns obj if it's not OpenAPIV3.ReferenceObject

    Parameters

    Returns Promise<SchemaObject>

Abstract build

  • Build Content block for OpenAPI Body schema

    Parameters

    Returns Promise<Content>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc