/users

get

The following data can be received:

  • new users: ?sort=-created&page[offset]=0&page[limit]=5
  • users with my tags ?filter[byMyTags]
  • users by tags ?filter[tag]=tag1,tag2,tag3 TODO rename
  • new users with my tags: ?sort=-created&filter[withMyTags]=2&page[offset]=5&page[limit]=3
  • users within a rectangle: ?filter[location]=-1.0,-1.0,1.0,1.0
post

Create a new user with unverified email. Verification message will be sent to the provided email.

get
patch

Edit user profile (givenName, familyName, description, location).

get

Get an avatar image of an user. Specifying size is supported.

patch

Upload avatar image. Maximum size is 2MB.

get

Get a list of user's tags (with story and relevance).

post

Add a tag to self and specify story and relevance.

get

Show a tag and user's story and relevance.

patch

Update user's story and/or relevance to a tag.

delete

Remove a tag from a user.

/auth

get

Send Basic auth header and receive JWT token.

get

Get time till a provided token's expiration [seconds].

/account

patch

The following actions are supported:

  • send email with code for resetting forgotten password
  • reset forgotten password with reset code
  • update unverified email and send verification link
  • verify email
  • change password

/contacts

get

Show trust and reference which user gave or received. Don't show unconfirmed contacts to 3rd users. Don't show trust and reference to user who received contact request and didn't confirm, yet.

post

Create a contact request.

get

Show a contact between two users including reference and trust given by :from to :to

  • the requester should see unconfirmed contact including message
  • the requested should see only the message of the unconfirmed contact
  • every other logged user can see only confirmed contacts (trust and reference)
patch

The following actions are supported:

  • confirm a contact request
  • update a contact from self
delete

Delete a contact.

/messages

post

Create a new message to another user.

get

The following information can be retrieved:

  • messages with another user
  • threads
  • amount of threads with unread messages
patch

Set read to true on the message and all the previous unread messages.

/tags

get

The following data can be received

  • tags with names similar to a given string (similarity = one of the words in tagname starts with the given string) (?filter[tagname][like]=fraction-of-tag-name)
  • tags related to my tags ?filter[relatedToMyTags]
  • tags related to given tags ?filter[relatedToTags]=tag1,tag2,tag3
  • random tags ?filter[random]
  • popular tags by amount of uses ?sort=-popularityByUses TODO: new tags (which have some uses)
post

Create a new tag.

get

Read a tag.

/ideas

post

Create a new idea.

get

Read an idea by id.

post

Add tag to idea.

get

Get tags of idea.

delete

Remove tag from idea.