Documentation

Models

List

Data structure for all responses that return array of data.
In case you get single item your will get it directly.

{
data: Array(Model)
total: number(total items in DB)
page: number(current page)
limit: number(number of items on page)
}

User Preview

User as a part of list or other data like post/comment.

{
id: string(autogenerated)
title: string("mr", "ms", "mrs", "miss", "dr", "")
firstName: string(length: 2-50)
lastName: string(length: 2-50)
picture: string(url)
}

User Full

Full user data returned by id.

{
id: string(autogenerated)
title: string("mr", "ms", "mrs", "miss", "dr", "")
firstName: string(length: 2-50)
lastName: string(length: 2-50)
gender: string("male", "female", "other", "")
email: string(email)
dateOfBirth: string(ISO Date - value: 1/1/1900 - now)
registerDate: string(autogenerated)
phone: string(phone number - any format)
picture: string(url)
location: object(Location)
}

Location

Using only as a part of full user data.

{
street: string(length: 5-100)
city: string(length: 2-30)
state: string(length: 2-30)
country: string(length: 2-30)
timezone: string(Valid timezone value ex. +7:00, -1:00)
}

Post Create

Post data for create request.

{
text: string(length: 6-50, preview only)
image: string(url)
likes: number(init value: 0)
tags: array(string)
owner: string(User id)
}

Post Preview

Post data as a part of list.

{
id: string(autogenerated)
text: string(length: 6-50, preview only)
image: string(url)
likes: number(init value: 0)
tags: array(string)
publishDate: string(autogenerated)
owner: object(User Preview)
}

Post

Post data returned by id.

{
id: string(autogenerated)
text: string(length: 6-1000)
image: string(url)
likes: number(init value: 0)
link: string(url, length: 6-200)
tags: array(string)
publishDate: string(autogenerated)
owner: object(User Preview)
}

Comment Create

Comment data to create new item.

{
message: string(length: 2-500)
owner: string(User Id)
post: string(Post Id)
}

Comment

{
id: string(autogenerated)
message: string(length: 2-500)
owner: object(User Preview)
post: string(Post Id)
publishDate: string(autogenerated)
}

Tag

Plain type. Array of strings.