1.1) Object

Summary

Warning:

The documentation of "Objet" and "Rest" is not up to date! It is currently being changed. Please refer to the examples or the Java class diagram.

Global structure

Objects definition

• Object object
• Property object
• Item object

Rest definition

• Rest object
• Info object
• Path object
• Method object
• Response object
• Schema object
• Parameter object
• Tag object
• ExternalDocs object

---

Object

Field Name	Type	Required	Description
<name>	String	true	Name of the object
<properties>	[Property object]	true	List of properties

Structure

<object>

     <name>...</name>

     <properties>

     ...

     </properties>

</object>

---

Property object

Field Name	Type	Required	Description
<name>	String	true	Name of the property
<type>	Data type	true if <ref> is not present	Type of the property. If <ref> is present, this tag will not be considered
<items>	Item object	true if <type> = "array"	Item of the property. Tag to use only if the type is equal to "array"
<ref>	String	false	Name of the object to which the property refers. The name must correspond to the name of an object (the one to which it refers)

Structure

<property>

     <name>...</name>

     <type>...</type>

     <item>

     ...

     </item>
     <ref>...</ref>

</property>

---

Item object

Field Name	Type	Required	Description
<type>	Data type	true	Data type of the items

Structure

<item>

     <type>...</type>

</item>