oas-schema-walker

v1.0.2
Library to walk OAS 3 schema objects and call a callback
openapi swagger oas schema json-schema

OAS-Schema-Walker

Functions

getDefaultState()

obtains the default starting state for the state object used by walkSchema

walkSchema(parent, state, callback,)

begins the walk of a schema object, or the state object used by walkSchema

getDefaultState() ⇒

obtains the default starting state for the state object used by walkSchema

Kind: global function Returns: the state object suitable for use in walkSchema

walkSchema(parent, state, callback,) ⇒

begins the walk of a schema object, or the state object used by walkSchema

Kind: global function Returns: the schema object

Param Description
parent the parent schema, if any. Use empty object if none
state the initial starting state of the walker, usually obtained from getDefaultState
callback, a function taking a schema, parent and state to be called on this and all subschemas

Metadata

Downloads

Maintainers