Home Reference Source Repository

public class | source

Method

Swagger Method

Method Summary

Public Methods
public	getResponse(name: string): object Get a response by name
public	hasDescription(): boolean Check if the method has a description
public	hasSummary(): boolean Check if the method has a summaty
public	hasTags(): boolean Check if the method has tags
public	walkParameters(fn: function) Walk through all parameters
public	walkResponses(fn: function) Walk through all responses

Public Methods

public getResponse(name: string): object source

Get a response by name

Params:

Name	Type	Attribute	Description
name	string		The name of the response element

Return:

public hasDescription(): boolean source

Check if the method has a description

Return:

public hasSummary(): boolean source

Check if the method has a summaty

Return:

public hasTags(): boolean source

Check if the method has tags

Return:

public walkParameters(fn: function) source

Walk through all parameters

Params:

Name	Type	Attribute	Description
fn	function		function to exectute for each parameter element. taking three arguments:

public walkResponses(fn: function) source

Walk through all responses

Params:

Name	Type	Attribute	Description
fn	function		function to exectute for each response element. taking three arguments: