Skip to content
This repository has been archived by the owner on Aug 19, 2022. It is now read-only.

API Interface Documentation

Sabien edited this page Apr 2, 2020 · 16 revisions

Routes

/Blogs/blog-id

Authentication

  • google
  • github

Data Types

User

  • username: String
  • password: String
  • social: SocialInformation

Social Information

  • User name: String (required, or anonymous users with posts that aren't public)
  • First name: String
  • Last name: String
  • email address: String
  • discord username: String
  • github username: String
  • tags: [String] (have some presets, or let them use custom ones)
  • profile picture: Image
  • bio: String
  • links: [String] (linkedin, github, etc)
  • location/address: String (used for the team map), optional

/register (POST): Register

  • username: String
  • password: String

/login (POST): Login

  • username: String
  • password: String

/api/social (POST): Update Profile

  • social

Post

  • title: String
  • description: String
  • Last modified date: Timestamp
  • Created date: Timestamp
  • Author: User
  • Tags: [String]
  • URL: String
  • Content: MarkdownString
  • PostType : Enum (Post, DevDog, ActiveProject, UserProfile)