Swagger::XmlObject Class Reference

A metadata object that allows for more fine-tuned XML model definitions. More...

#include <Swagger.qm.dox.h>

Inheritance diagram for Swagger::XmlObject:

Public Member Methods
void	constructor (hash< auto > oh)
	Constructor.
Public Member Methods inherited from Swagger::ObjectBase
void	constructor ()
	Constructor.
void	constructor (hash< auto > oh)
	Constructor.
void	constructor (ObjectBase other)
	Copy constructor.

Public Attributes
soft< string >	name
	Replaces the name of the element/attribute used for the described schema property.
soft< string >	ns
	The URL of the namespace definition. Value SHOULD be in the form of a URL.
soft< string >	prefix
	The prefix to be used for the XmlObject::name "name".

Detailed Description

A metadata object that allows for more fine-tuned XML model definitions.

When using arrays, XML element names are not inferred (for singular/plural forms) and the XmlObject::name "name" property should be used to add that information. See examples for expected behavior.

Member Function Documentation

constructor()

void Swagger::XmlObject::constructor

(

hash< auto >

oh

)

Constructor.

Parameters

oh	deserialized hash from the source schema description describing XML model definitions

Exceptions

INVALID-FIELD-TYPE

field has invalid type

Member Data Documentation

name

soft<string> Swagger::XmlObject::name

Replaces the name of the element/attribute used for the described schema property.

When defined within the items, it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true. If wrapped is false, it will be ignored.