Swagger::PathItemObject Class Reference

Describes the operations available on a single path. More...

Inheritance diagram for Swagger::PathItemObject:

Public Member Methods
	constructor (string path, hash< auto > oh, SwaggerSchema swagger)
	Constructor. More...
softlist	getMethods ()
	returns a list of HTTP methods supported by this object More...
OperationObject	getOperation (string method, string path)
	returns the operation object for the given method More...
hash< string, AbstractParameterObject >	parameters ()
	A hash of parameters that are applicable for all the operations described under this path. More...
Public Member Methods inherited from Swagger::ObjectBase
	constructor ()
	Constructor.
	constructor (hash< auto > oh)
	Constructor. More...
	constructor (ObjectBase other)
	copy constructor
	initialize (hash< auto > oh)
	Initialize. More...

Public Attributes
AbstractParameterObject	body
	The body parameter, if defined for this path.
*string	ref
	Allows for an external definition of this path item. More...
Public Attributes inherited from Swagger::ObjectBase
hash< auto >	vendorExtensions
	Allows extensions to the Swagger Schema. More...

Private Attributes
hash< string, OperationObject >	operations
	A hash of OperationObjects correspoding to different methods. More...

Detailed Description

Describes the operations available on a single path.

A Path Item may be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.

Member Function Documentation

constructor()

Swagger::PathItemObject::constructor	(	string	path,
		hash< auto >	oh,
		SwaggerSchema	swagger
	)

Constructor.

Parameters

path	the URI path for the object
oh	deserialized hash from the source schema description describing the operations available on a single path
swagger	the REST schema for resolving references

Exceptions

INVALID-FIELD-TYPE	field has invalid type
INVALID-FIELD-VALUE	field has invalid value
REQUIRED-FIELD-MISSING	required field is missing

getMethods()

softlist Swagger::PathItemObject::getMethods

(

)

returns a list of HTTP methods supported by this object

Returns

a list of HTTP methods supported by this object

getOperation()

OperationObject Swagger::PathItemObject::getOperation	(	string	method,
		string	path
	)

returns the operation object for the given method

Parameters

path	the path to be used in any error message
method	the HTTP method name

Returns

the OperationObject corresponding to the arguments

Exceptions

INVALID-METHOD

the given path does not have any operation defined for the given method

parameters()

hash<string, AbstractParameterObject> Swagger::PathItemObject::parameters

(

)

A hash of parameters that are applicable for all the operations described under this path.

Hash values are AbstractParameterObjects

These parameters can be overridden at the operation level, but cannot be removed there. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. There can be one body parameter at most.

Member Data Documentation

operations

hash<string, OperationObject> Swagger::PathItemObject::operations

private

A hash of OperationObjects correspoding to different methods.

Keys are lowercase method names, with possible values being:

• "get"
• "put"
• "post"
• "delete"
• "options"
• "head"
• "patch"

ref

*string Swagger::PathItemObject::ref

Allows for an external definition of this path item.

The referenced structure MUST be in the format of a PathItemObject. If there are conflicts between the referenced definition and this PathItem's definition, the behavior is undefined.