More humble doc comments.

This commit is contained in:
Alexey Skobkin 2016-03-29 10:50:49 +03:00
parent ce9019d9e5
commit fc30e4b27f
5 changed files with 5 additions and 0 deletions

View file

@ -1,5 +1,6 @@
package point package point
// MetaPost represents the meta-post object in API response. It contains the post object and some user dependent data
type MetaPost struct { type MetaPost struct {
Bookmarked bool `json:"bookmarked"` Bookmarked bool `json:"bookmarked"`
Uid int `json:"uid"` Uid int `json:"uid"`

View file

@ -1,5 +1,6 @@
package point package point
// Page represents the basic feed API response which contains array of posts and has_next flag
type Page struct { type Page struct {
HasNext bool `json:"has_next"` HasNext bool `json:"has_next"`
Posts []MetaPost `json:"posts"` Posts []MetaPost `json:"posts"`

View file

@ -1,5 +1,6 @@
package point package point
// Post represents the basic post data
type Post struct { type Post struct {
Id string `json:"id"` Id string `json:"id"`
Author User `json:"author"` Author User `json:"author"`

View file

@ -1,5 +1,6 @@
package point package point
// Token represents the login API method response and contains important login data
type Token struct { type Token struct {
AuthToken string `json:"token"` AuthToken string `json:"token"`
CsRfToken string `json:"csrf_token"` CsRfToken string `json:"csrf_token"`

View file

@ -1,5 +1,6 @@
package point package point
// User represents the user object in API response
type User struct { type User struct {
Id int `json:"id"` Id int `json:"id"`
Login string `json:"login"` Login string `json:"login"`