57 lines
2.5 KiB
JSON
57 lines
2.5 KiB
JSON
{
|
|
"type": "API Response Field",
|
|
"definition": {
|
|
"text": "The API responds with a JSON object. Each property of the object is mapped as node of this type. This node can have children of the same type allowing users to map a complex data structure.",
|
|
"updated": 1621021740145
|
|
},
|
|
"paragraphs": [
|
|
{
|
|
"style": "Subtitle",
|
|
"text": "Configuration",
|
|
"updated": 1621021763335
|
|
},
|
|
{
|
|
"style": "List",
|
|
"text": "codeName: The codeName needs to be the exact name of the property at the response JSON object holding the value. For the first object, since it is a special case, we usually use the codeName of rootObject.",
|
|
"updated": 1621021843683
|
|
},
|
|
{
|
|
"style": "List",
|
|
"text": "fieldType: This property declares if the data is number, a string, an object, or an array, those are the 4 possible values.",
|
|
"updated": 1622315306276
|
|
},
|
|
{
|
|
"style": "List",
|
|
"text": "description: The API Map is expected to be used not only by the user who created, but once contributed as a Plugin, by all other users. This property is useful to store the description of this field as it was written at the API Server documentation, to avoid other users to go and look for it."
|
|
},
|
|
{
|
|
"style": "Subtitle",
|
|
"text": "Field Type Possible Values"
|
|
},
|
|
{
|
|
"style": "Text",
|
|
"text": "This property is very important and needs to be defined very well. This property defines the structure of the response data structure and needs to be very precise. It's possible values are:",
|
|
"updated": 1621953383545
|
|
},
|
|
{
|
|
"style": "List",
|
|
"text": "number: Any type of numbers fall into this category, including dates timestamps in numbers.",
|
|
"updated": 1621953444809
|
|
},
|
|
{
|
|
"style": "List",
|
|
"text": "string: Any strings falls into this category, including dates in string format.",
|
|
"updated": 1621953470163
|
|
},
|
|
{
|
|
"style": "List",
|
|
"text": "object: Use this value when you find that the field holds a JSON object enclosed in { and }",
|
|
"updated": 1621953515163
|
|
},
|
|
{
|
|
"style": "List",
|
|
"text": "array: Use this type when the value of the field is a JSON array enclosed in [ and ]",
|
|
"updated": 1621953569329
|
|
}
|
|
]
|
|
} |