API Endpoints

Header Required: "Content-Type: application/json"
POST /auth/login
POST /auth/githubLogin
POST /auth/refresh
GET /auth/payload
GET /comment/{comment_id}
GET /comments/{entity_id}
GET /comment/replies/{comment_id}
GET /comments/{entity_id}/page/{page}
GET /comment/replies/{comment_id}/page/{page}
POST /comment/reply/{comment_id}
POST /comment/{entity_id}
GET /comments/contextual/{comment_id}
POST /entity/getForFeed
POST /follow/{entity_id}
DELETE /follow/{entity_id}
GET /follows/{user_id}
GET /list/topics
GET /oauth/github/auth/url/{state}
GET /organisation/{id}
POST /pay/pledge/{pledge_id}/stripeToken
POST /pay/pledge/{pledge_id}/paymentMethod
POST /pay/method/stripe/create
GET /pay/stripe/apiKey
POST /problem/create
PATCH /problem/{problem_id}
GET /problem/{problem_id}
GET /problems/user/{user_id}
POST /problem/{problem_id}/solution
POST /problem/{problem_id}/pledge
GET /public/user/{username}
GET /public/solution/{solution_id}
GET /public/github/id/{github_id}
GET /public/github/{user_id}
GET /server/datetime
GET /server/methods
GET /server/endpoints
GET /status/{status_id}
POST /status/create
GET /statuses/user/{user_id}
POST /user/createFromEmailPassword
POST /user/createFromGitHub
POST /user/checkUsernameAvailability
POST /user/updatePassword/{user_id}
POST /user/updateGitHub/{user_id}
PATCH /user/{user_id}
POST /user/createStripePaymentMethod/{user_id}
GET /user/paymentMethods/{user_id}
GET /user/pledges/{user_id}

POST /auth/login

Requirements

Header Required: "Origin-Auth: {origin_token}"

Example Request

{
    "username": "CoolGuy121",
    "password": "myextremelySAFEpassword!z**"
}

Example Response

{
    "token": "eyJhbGciOiJTSEEyNTYiLCJ0eXAiOiJKV1QifQ.eyJ0dGwiOjE1NDAwMzkyNTUsInR0ciI6MTU0MDkzOTI1NSwiZGF0YSI6eyJ1c2VyX2lkIjoidXNyLTEzYTNhYzZjLTUyYWQtNDAxYS05ZDcyLWMwZWVmZDY2NWY4OSIsIm5hbWUiOiJKb2hubnkgRGV2SGVhZCIsImVtYWlsIjoiam9obm5kZXZoZWFkQGdtYWlsLmNvbSIsImdpdGh1Yl9pZCI6bnVsbCwiZGF0YSI6Int9IiwidXNlcm5hbWUiOiJKb2hubnlEZXZIZWFkIiwibW9kaWZpZWQiOiIyMDE4LTEwLTE5IDA4OjU0OjE1IiwiY3JlYXRlZCI6IjIwMTgtMTAtMTkgMDg6NTQ6MTUiLCJhdmF0YXJfdXJsIjpudWxsLCJwZXJtaXNzaW9ucyI6W119fQ.573430fd9ffd81e0e77c4571f224a434e1c72b59ecbc9de553e6b965c03eaf90"
}

POST /auth/githubLogin

Requirements

Header Required: "Origin-Auth: {origin_token}"

Example Request

{
    "code": "987ygnedjdmdlajhda",
    "state": "nd98ydahedkjabsdkjb"
}

Example Response

{
    "token": "eyJhbGciOiJTSEEyNTYiLCJ0eXAiOiJKV1QifQ.eyJ0dGwiOjE1NDAwMzkyNTUsInR0ciI6MTU0MDkzOTI1NSwiZGF0YSI6eyJ1c2VyX2lkIjoidXNyLTEzYTNhYzZjLTUyYWQtNDAxYS05ZDcyLWMwZWVmZDY2NWY4OSIsIm5hbWUiOiJKb2hubnkgRGV2SGVhZCIsImVtYWlsIjoiam9obm5kZXZoZWFkQGdtYWlsLmNvbSIsImdpdGh1Yl9pZCI6bnVsbCwiZGF0YSI6Int9IiwidXNlcm5hbWUiOiJKb2hubnlEZXZIZWFkIiwibW9kaWZpZWQiOiIyMDE4LTEwLTE5IDA4OjU0OjE1IiwiY3JlYXRlZCI6IjIwMTgtMTAtMTkgMDg6NTQ6MTUiLCJhdmF0YXJfdXJsIjpudWxsLCJwZXJtaXNzaW9ucyI6W119fQ.573430fd9ffd81e0e77c4571f224a434e1c72b59ecbc9de553e6b965c03eaf90"
}

POST /auth/refresh

Requirements

Header Required: "Authorization: Bearer {access_token}"

Example Request

{}

Example Response

{
    "token": "eyJhbGciOiJTSEEyNTYiLCJ0eXAiOiJKV1QifQ.eyJ0dGwiOjE1NDAwMzkyNTUsInR0ciI6MTU0MDkzOTI1NSwiZGF0YSI6eyJ1c2VyX2lkIjoidXNyLTEzYTNhYzZjLTUyYWQtNDAxYS05ZDcyLWMwZWVmZDY2NWY4OSIsIm5hbWUiOiJKb2hubnkgRGV2SGVhZCIsImVtYWlsIjoiam9obm5kZXZoZWFkQGdtYWlsLmNvbSIsImdpdGh1Yl9pZCI6bnVsbCwiZGF0YSI6Int9IiwidXNlcm5hbWUiOiJKb2hubnlEZXZIZWFkIiwibW9kaWZpZWQiOiIyMDE4LTEwLTE5IDA4OjU0OjE1IiwiY3JlYXRlZCI6IjIwMTgtMTAtMTkgMDg6NTQ6MTUiLCJhdmF0YXJfdXJsIjpudWxsLCJwZXJtaXNzaW9ucyI6W119fQ.573430fd9ffd81e0e77c4571f224a434e1c72b59ecbc9de553e6b965c03eaf90"
}

GET /auth/payload

Requirements

Header Required: "Authorization: Bearer {access_token}"

Example Response

{
    "payload": {
        "permissions": [
            {
                "permission_id": "prm-b681ec73-d91e-4485-b651-73996210fc53",
                "resource": "problems",
                "resource_id": null,
                "action": "create"
            },
            {
                "permission_id": "prm-86bb7042-cb21-4781-a3d6-8d368290c815",
                "resource": "organisations",
                "resource_id": null,
                "action": "create"
            },
            {
                "permission_id": "prm-7c67e921-256d-4408-ab40-57326e248317",
                "resource": "solutions",
                "resource_id": null,
                "action": "create"
            }
        ]
    }
}

GET /comment/{comment_id}

Example Response

{
    "comment_id": "cmt-7a571f94-51dc-47a3-aad0-8d1c4ec4bc12",
    "parent_comment_id": null,
    "comment": "My awesome comment! <a href=\"http:\/\/www.google.com\" target=\"_blank\">http:\/\/www.google.com<\/a> link to stuff",
    "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
    "organisation_id": null,
    "entity_id": "prb-9e81df01-a2a7-438a-8f1d-f0b37267688d",
    "modified": "2018-10-19 08:54:15",
    "created": "2018-10-19 08:54:15",
    "last_five_replies": [],
    "total_replies": 0,
    "comment_type": "comment_on_entity",
    "user": {
        "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
        "name": "Johnny DevHead",
        "github_id": null,
        "username": "JohnnyDevHead",
        "modified": "2018-10-19 08:54:15",
        "created": "2018-10-19 08:54:15",
        "avatar_url": null
    }
}

GET /comments/{entity_id}

Example Response

{
    "comments": [
        {
            "comment_id": "cmt-7a571f94-51dc-47a3-aad0-8d1c4ec4bc12",
            "parent_comment_id": null,
            "comment": "My awesome comment! <a href=\"http:\/\/www.google.com\" target=\"_blank\">http:\/\/www.google.com<\/a> link to stuff",
            "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
            "organisation_id": null,
            "entity_id": "prb-9e81df01-a2a7-438a-8f1d-f0b37267688d",
            "modified": "2018-10-19 08:54:15",
            "created": "2018-10-19 08:54:15",
            "last_five_replies": [],
            "total_replies": 0,
            "comment_type": "comment_on_entity",
            "user": {
                "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
                "name": "Johnny DevHead",
                "github_id": null,
                "username": "JohnnyDevHead",
                "modified": "2018-10-19 08:54:15",
                "created": "2018-10-19 08:54:15",
                "avatar_url": null
            }
        },
        {
            "comment_id": "cmt-7a571f94-51dc-47a3-aad0-8d1c4ec4bc12",
            "parent_comment_id": null,
            "comment": "My awesome comment! <a href=\"http:\/\/www.google.com\" target=\"_blank\">http:\/\/www.google.com<\/a> link to stuff",
            "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
            "organisation_id": null,
            "entity_id": "prb-9e81df01-a2a7-438a-8f1d-f0b37267688d",
            "modified": "2018-10-19 08:54:15",
            "created": "2018-10-19 08:54:15",
            "last_five_replies": [],
            "total_replies": 0,
            "comment_type": "comment_on_entity",
            "user": {
                "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
                "name": "Johnny DevHead",
                "github_id": null,
                "username": "JohnnyDevHead",
                "modified": "2018-10-19 08:54:15",
                "created": "2018-10-19 08:54:15",
                "avatar_url": null
            }
        }
    ]
}

GET /comment/replies/{comment_id}

Example Response

{
    "comments": [
        {
            "comment_id": "cmt-7a571f94-51dc-47a3-aad0-8d1c4ec4bc12",
            "parent_comment_id": null,
            "comment": "My awesome comment! <a href=\"http:\/\/www.google.com\" target=\"_blank\">http:\/\/www.google.com<\/a> link to stuff",
            "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
            "organisation_id": null,
            "entity_id": "prb-9e81df01-a2a7-438a-8f1d-f0b37267688d",
            "modified": "2018-10-19 08:54:15",
            "created": "2018-10-19 08:54:15",
            "last_five_replies": [],
            "total_replies": 0,
            "comment_type": "comment_on_entity",
            "user": {
                "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
                "name": "Johnny DevHead",
                "github_id": null,
                "username": "JohnnyDevHead",
                "modified": "2018-10-19 08:54:15",
                "created": "2018-10-19 08:54:15",
                "avatar_url": null
            }
        },
        {
            "comment_id": "cmt-7a571f94-51dc-47a3-aad0-8d1c4ec4bc12",
            "parent_comment_id": null,
            "comment": "My awesome comment! <a href=\"http:\/\/www.google.com\" target=\"_blank\">http:\/\/www.google.com<\/a> link to stuff",
            "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
            "organisation_id": null,
            "entity_id": "prb-9e81df01-a2a7-438a-8f1d-f0b37267688d",
            "modified": "2018-10-19 08:54:15",
            "created": "2018-10-19 08:54:15",
            "last_five_replies": [],
            "total_replies": 0,
            "comment_type": "comment_on_entity",
            "user": {
                "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
                "name": "Johnny DevHead",
                "github_id": null,
                "username": "JohnnyDevHead",
                "modified": "2018-10-19 08:54:15",
                "created": "2018-10-19 08:54:15",
                "avatar_url": null
            }
        }
    ]
}

GET /comments/{entity_id}/page/{page}

Example Response

{
    "comments": [
        {
            "comment_id": "cmt-7a571f94-51dc-47a3-aad0-8d1c4ec4bc12",
            "parent_comment_id": null,
            "comment": "My awesome comment! <a href=\"http:\/\/www.google.com\" target=\"_blank\">http:\/\/www.google.com<\/a> link to stuff",
            "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
            "organisation_id": null,
            "entity_id": "prb-9e81df01-a2a7-438a-8f1d-f0b37267688d",
            "modified": "2018-10-19 08:54:15",
            "created": "2018-10-19 08:54:15",
            "last_five_replies": [],
            "total_replies": 0,
            "comment_type": "comment_on_entity",
            "user": {
                "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
                "name": "Johnny DevHead",
                "github_id": null,
                "username": "JohnnyDevHead",
                "modified": "2018-10-19 08:54:15",
                "created": "2018-10-19 08:54:15",
                "avatar_url": null
            }
        },
        {
            "comment_id": "cmt-7a571f94-51dc-47a3-aad0-8d1c4ec4bc12",
            "parent_comment_id": null,
            "comment": "My awesome comment! <a href=\"http:\/\/www.google.com\" target=\"_blank\">http:\/\/www.google.com<\/a> link to stuff",
            "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
            "organisation_id": null,
            "entity_id": "prb-9e81df01-a2a7-438a-8f1d-f0b37267688d",
            "modified": "2018-10-19 08:54:15",
            "created": "2018-10-19 08:54:15",
            "last_five_replies": [],
            "total_replies": 0,
            "comment_type": "comment_on_entity",
            "user": {
                "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
                "name": "Johnny DevHead",
                "github_id": null,
                "username": "JohnnyDevHead",
                "modified": "2018-10-19 08:54:15",
                "created": "2018-10-19 08:54:15",
                "avatar_url": null
            }
        }
    ]
}

GET /comment/replies/{comment_id}/page/{page}

Example Response

{
    "comments": [
        {
            "comment_id": "cmt-7a571f94-51dc-47a3-aad0-8d1c4ec4bc12",
            "parent_comment_id": null,
            "comment": "My awesome comment! <a href=\"http:\/\/www.google.com\" target=\"_blank\">http:\/\/www.google.com<\/a> link to stuff",
            "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
            "organisation_id": null,
            "entity_id": "prb-9e81df01-a2a7-438a-8f1d-f0b37267688d",
            "modified": "2018-10-19 08:54:15",
            "created": "2018-10-19 08:54:15",
            "last_five_replies": [],
            "total_replies": 0,
            "comment_type": "comment_on_entity",
            "user": {
                "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
                "name": "Johnny DevHead",
                "github_id": null,
                "username": "JohnnyDevHead",
                "modified": "2018-10-19 08:54:15",
                "created": "2018-10-19 08:54:15",
                "avatar_url": null
            }
        },
        {
            "comment_id": "cmt-7a571f94-51dc-47a3-aad0-8d1c4ec4bc12",
            "parent_comment_id": null,
            "comment": "My awesome comment! <a href=\"http:\/\/www.google.com\" target=\"_blank\">http:\/\/www.google.com<\/a> link to stuff",
            "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
            "organisation_id": null,
            "entity_id": "prb-9e81df01-a2a7-438a-8f1d-f0b37267688d",
            "modified": "2018-10-19 08:54:15",
            "created": "2018-10-19 08:54:15",
            "last_five_replies": [],
            "total_replies": 0,
            "comment_type": "comment_on_entity",
            "user": {
                "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
                "name": "Johnny DevHead",
                "github_id": null,
                "username": "JohnnyDevHead",
                "modified": "2018-10-19 08:54:15",
                "created": "2018-10-19 08:54:15",
                "avatar_url": null
            }
        }
    ]
}

POST /comment/reply/{comment_id}

Requirements

Header Required: "Authorization: Bearer {access_token}"

Example Request

{
    "comment": "My awesome comment! http:\/\/www.google.com link to stuff"
}

Example Response

{
    "comment_id": "cmt-7a571f94-51dc-47a3-aad0-8d1c4ec4bc12",
    "parent_comment_id": null,
    "comment": "My awesome comment! <a href=\"http:\/\/www.google.com\" target=\"_blank\">http:\/\/www.google.com<\/a> link to stuff",
    "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
    "organisation_id": null,
    "entity_id": "prb-9e81df01-a2a7-438a-8f1d-f0b37267688d",
    "modified": "2018-10-19 08:54:15",
    "created": "2018-10-19 08:54:15",
    "last_five_replies": [],
    "total_replies": 0,
    "comment_type": "comment_on_entity",
    "user": {
        "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
        "name": "Johnny DevHead",
        "github_id": null,
        "username": "JohnnyDevHead",
        "modified": "2018-10-19 08:54:15",
        "created": "2018-10-19 08:54:15",
        "avatar_url": null
    }
}

POST /comment/{entity_id}

Requirements

Header Required: "Authorization: Bearer {access_token}"

Example Request

{
    "comment": "My awesome comment! http:\/\/www.google.com link to stuff"
}

Example Response

{
    "comment_id": "cmt-7a571f94-51dc-47a3-aad0-8d1c4ec4bc12",
    "parent_comment_id": null,
    "comment": "My awesome comment! <a href=\"http:\/\/www.google.com\" target=\"_blank\">http:\/\/www.google.com<\/a> link to stuff",
    "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
    "organisation_id": null,
    "entity_id": "prb-9e81df01-a2a7-438a-8f1d-f0b37267688d",
    "modified": "2018-10-19 08:54:15",
    "created": "2018-10-19 08:54:15",
    "last_five_replies": [],
    "total_replies": 0,
    "comment_type": "comment_on_entity",
    "user": {
        "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
        "name": "Johnny DevHead",
        "github_id": null,
        "username": "JohnnyDevHead",
        "modified": "2018-10-19 08:54:15",
        "created": "2018-10-19 08:54:15",
        "avatar_url": null
    }
}

GET /comments/contextual/{comment_id}

Example Response

{
    "comments": [
        {
            "comment_id": "cmt-7a571f94-51dc-47a3-aad0-8d1c4ec4bc12",
            "parent_comment_id": null,
            "comment": "My awesome comment! <a href=\"http:\/\/www.google.com\" target=\"_blank\">http:\/\/www.google.com<\/a> link to stuff",
            "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
            "organisation_id": null,
            "entity_id": "prb-9e81df01-a2a7-438a-8f1d-f0b37267688d",
            "modified": "2018-10-19 08:54:15",
            "created": "2018-10-19 08:54:15",
            "last_five_replies": [],
            "total_replies": 0,
            "comment_type": "comment_on_entity",
            "user": {
                "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
                "name": "Johnny DevHead",
                "github_id": null,
                "username": "JohnnyDevHead",
                "modified": "2018-10-19 08:54:15",
                "created": "2018-10-19 08:54:15",
                "avatar_url": null
            }
        },
        {
            "comment_id": "cmt-7a571f94-51dc-47a3-aad0-8d1c4ec4bc12",
            "parent_comment_id": null,
            "comment": "My awesome comment! <a href=\"http:\/\/www.google.com\" target=\"_blank\">http:\/\/www.google.com<\/a> link to stuff",
            "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
            "organisation_id": null,
            "entity_id": "prb-9e81df01-a2a7-438a-8f1d-f0b37267688d",
            "modified": "2018-10-19 08:54:15",
            "created": "2018-10-19 08:54:15",
            "last_five_replies": [],
            "total_replies": 0,
            "comment_type": "comment_on_entity",
            "user": {
                "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
                "name": "Johnny DevHead",
                "github_id": null,
                "username": "JohnnyDevHead",
                "modified": "2018-10-19 08:54:15",
                "created": "2018-10-19 08:54:15",
                "avatar_url": null
            }
        }
    ]
}

POST /entity/getForFeed

Example Request

"coming soon"

Example Response

"coming soon"

POST /follow/{entity_id}

Requirements

Header Required: "Authorization: Bearer {access_token}"

Example Request

{}

Example Response

{
    "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
    "entity_id": "prb-9e81df01-a2a7-438a-8f1d-f0b37267688d",
    "entity": "problem",
    "created": "2018-10-19 08:54:15"
}

DELETE /follow/{entity_id}

Requirements

Header Required: "Authorization: Bearer {access_token}"

Example Request

"coming soon"

Example Response

{
    "deleted": true
}

GET /follows/{user_id}

Example Response

{
    "follows": [
        {
            "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
            "entity_id": "prb-9e81df01-a2a7-438a-8f1d-f0b37267688d",
            "entity": "problem",
            "created": "2018-10-19 08:54:15"
        },
        {
            "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
            "entity_id": "prb-9e81df01-a2a7-438a-8f1d-f0b37267688d",
            "entity": "problem",
            "created": "2018-10-19 08:54:15"
        },
        {
            "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
            "entity_id": "prb-9e81df01-a2a7-438a-8f1d-f0b37267688d",
            "entity": "problem",
            "created": "2018-10-19 08:54:15"
        }
    ]
}

GET /list/topics

Example Response

{
    "topics": [
        {
            "topic_id": "top-Framework",
            "name": "Framework",
            "parent_name": null,
            "description": null,
            "example": null
        },
        {
            "topic_id": "top-Language",
            "name": "Language",
            "parent_name": null,
            "description": null,
            "example": null
        },
        {
            "topic_id": "top-Technology",
            "name": "Technology",
            "parent_name": null,
            "description": null,
            "example": null
        },
        {
            "topic_id": "top-PHP",
            "name": "PHP",
            "parent_name": "Language",
            "description": null,
            "example": null
        },
        {
            "topic_id": "top-HTML",
            "name": "HTML",
            "parent_name": "Language",
            "description": null,
            "example": null
        },
        {
            "topic_id": "top-JS",
            "name": "JS",
            "parent_name": "Language",
            "description": null,
            "example": null
        },
        {
            "topic_id": "top-Python",
            "name": "Python",
            "parent_name": "Language",
            "description": null,
            "example": null
        },
        {
            "topic_id": "top-CSS",
            "name": "CSS",
            "parent_name": "Language",
            "description": null,
            "example": null
        },
        {
            "topic_id": "top-Shell",
            "name": "Shell",
            "parent_name": "Language",
            "description": null,
            "example": null
        },
        {
            "topic_id": "top-Swift",
            "name": "Swift",
            "parent_name": "Language",
            "description": null,
            "example": null
        },
        {
            "topic_id": "top-Go",
            "name": "Go",
            "parent_name": "Language",
            "description": null,
            "example": null
        },
        {
            "topic_id": "top-C-23",
            "name": "C#",
            "parent_name": "Language",
            "description": null,
            "example": null
        },
        {
            "topic_id": "top-C",
            "name": "C",
            "parent_name": "Language",
            "description": null,
            "example": null
        },
        {
            "topic_id": "top-Objective-C",
            "name": "Objective-C",
            "parent_name": "Language",
            "description": null,
            "example": null
        },
        {
            "topic_id": "top-Docker-Compose",
            "name": "Docker Compose",
            "parent_name": "Language",
            "description": null,
            "example": null
        },
        {
            "topic_id": "top-Docker-File",
            "name": "Docker File",
            "parent_name": "Language",
            "description": null,
            "example": null
        },
        {
            "topic_id": "top-Java",
            "name": "Java",
            "parent_name": "Language",
            "description": null,
            "example": null
        },
        {
            "topic_id": "top-SCSS",
            "name": "SCSS",
            "parent_name": "Language",
            "description": null,
            "example": null
        },
        {
            "topic_id": "top-SASS",
            "name": "SASS",
            "parent_name": "Language",
            "description": null,
            "example": null
        },
        {
            "topic_id": "top-LESS",
            "name": "LESS",
            "parent_name": "Language",
            "description": null,
            "example": null
        },
        {
            "topic_id": "top-Laravel",
            "name": "Laravel",
            "parent_name": "Framework",
            "description": "PHP Framework",
            "example": null
        },
        {
            "topic_id": "top-Code-Igniter",
            "name": "Code Igniter",
            "parent_name": "Framework",
            "description": "PHP Framework",
            "example": null
        },
        {
            "topic_id": "top-Zend",
            "name": "Zend",
            "parent_name": "Framework",
            "description": "PHP Framework",
            "example": null
        },
        {
            "topic_id": "top-React",
            "name": "React",
            "parent_name": "Framework",
            "description": "JS Framework",
            "example": null
        },
        {
            "topic_id": "top-Vue",
            "name": "Vue",
            "parent_name": "Framework",
            "description": "JS Framework",
            "example": null
        },
        {
            "topic_id": "top-Word-Press",
            "name": "Word Press",
            "parent_name": "Framework",
            "description": "PHP Framework",
            "example": null
        },
        {
            "topic_id": "top-Kubernetes",
            "name": "Kubernetes",
            "parent_name": "Technology",
            "description": "Container Orchestration",
            "example": null
        },
        {
            "topic_id": "top-Docker-Swarm",
            "name": "Docker Swarm",
            "parent_name": "Technology",
            "description": "Container Orchestration",
            "example": null
        },
        {
            "topic_id": "top-Docker",
            "name": "Docker",
            "parent_name": "Technology",
            "description": "Container",
            "example": null
        },
        {
            "topic_id": "top-Apache",
            "name": "Apache",
            "parent_name": "Technology",
            "description": "Server Technologies",
            "example": null
        },
        {
            "topic_id": "top-Nginx",
            "name": "Nginx",
            "parent_name": "Technology",
            "description": "PHP Framework",
            "example": null
        },
        {
            "topic_id": "top-Web-Sockets",
            "name": "Web Sockets",
            "parent_name": "Technology",
            "description": "Protocol",
            "example": null
        },
        {
            "topic_id": "top-TCP",
            "name": "TCP",
            "parent_name": "Technology",
            "description": "Protocol",
            "example": null
        },
        {
            "topic_id": "top-SSL",
            "name": "SSL",
            "parent_name": "Technology",
            "description": "Security Protocol",
            "example": null
        },
        {
            "topic_id": "top-Swoole",
            "name": "Swoole",
            "parent_name": "Technology",
            "description": "Server Technologies",
            "example": null
        },
        {
            "topic_id": "top-System-Administration",
            "name": "System Administration",
            "parent_name": "Technology",
            "description": "Taking care of Server Technologies",
            "example": null
        },
        {
            "topic_id": "top-Ansible",
            "name": "Ansible",
            "parent_name": "Technology",
            "description": "Server Orchestration",
            "example": null
        }
    ]
}

GET /oauth/github/auth/url/{state}

Requirements

Header Required: "Origin-Auth: {origin_token}"

Example Response

{
    "url": "https:\/\/github.com\/login\/oauth\/authorize?client_id=&redirect_uri=&state=aSt2taateYouGeenerAtEd00"
}

GET /organisation/{id}

Requirements

Header Required: "Authorization: Bearer {access_token}"

Example Response

"coming soon"

POST /pay/pledge/{pledge_id}/stripeToken

Requirements

Header Required: "Authorization: Bearer {access_token}"
Header Required: "Origin-Auth: {origin_token}"

Example Request

{
    "token": "98yg3nrkfud8ew92okKnrfmcU8ujNmT"
}

Example Response

{
    "payment_id": "pay-433ae455-e16e-4415-9a5b-5597a1c3c371",
    "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
    "organisation_id": null,
    "value": 2.9,
    "currency": "USD",
    "gateway": "Stripe",
    "reference": "TransRef0987656789032q",
    "data": "{}",
    "created": "2018-10-19 08:54:15",
    "modified": "2018-10-19 08:54:15"
}

POST /pay/pledge/{pledge_id}/paymentMethod

Requirements

Header Required: "Authorization: Bearer {access_token}"
Header Required: "Origin-Auth: {origin_token}"

Example Request

"coming soon"

Example Response

"coming soon"

POST /pay/method/stripe/create

Requirements

Header Required: "Authorization: Bearer {access_token}"
Header Required: "Origin-Auth: {origin_token}"

Example Request

"coming soon"

Example Response

"coming soon"

GET /pay/stripe/apiKey

Requirements

Header Required: "Authorization: Bearer {access_token}"
Header Required: "Origin-Auth: {origin_token}"

Example Response

{
    "api_key": "woiugbdwef923hoascdkjcn"
}

POST /problem/create

Requirements

Header Required: Authorization: Bearer {access_token}
User must have "create" on "problems" permission

Example Request

{
    "title": "My Problems Title",
    "description": "Description of Problem",
    "specification": "Outline of Specification Needed",
    "make_active": true,
    "active_datetime": "2018-01-01 01:00:00",
    "deadline_datetime": "2018-01-01 01:00:00",
    "topics": [
        "PHP",
        "JS"
    ]
}

Example Response

{
    "problem_id": "prb-9e81df01-a2a7-438a-8f1d-f0b37267688d",
    "user_id": null,
    "organisation_id": null,
    "title": "My Problems Title",
    "description": "Description of Problem",
    "specification": "Outline of Specification Needed",
    "data": "{}",
    "active_datetime": null,
    "deadline_datetime": null,
    "deleted": 0,
    "modified": "2018-10-19 08:54:15",
    "created": "2018-10-19 08:54:15",
    "is_active": false,
    "topics": [],
    "solutions": [
        {
            "solution_id": "sol-38a19f9f-ec1f-4869-a93d-9d5dec8c238b",
            "problem_solution_group_id": null,
            "solution_group_id": null,
            "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
            "name": "My Super Solution name",
            "problem_id": "prb-9e81df01-a2a7-438a-8f1d-f0b37267688d",
            "open_source_location": "https:\/\/mylinktogithub.com\/mycoolsolution",
            "modified": "2018-10-19 08:54:15",
            "created": "2018-10-19 08:54:15",
            "user": {
                "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
                "name": "Johnny DevHead",
                "github_id": null,
                "username": "JohnnyDevHead",
                "modified": "2018-10-19 08:54:15",
                "created": "2018-10-19 08:54:15",
                "avatar_url": null
            },
            "last_five_comments": [],
            "total_comments": 0
        }
    ],
    "user": {
        "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
        "name": "Johnny DevHead",
        "github_id": null,
        "username": "JohnnyDevHead",
        "modified": "2018-10-19 08:54:15",
        "created": "2018-10-19 08:54:15",
        "avatar_url": null
    },
    "pledges_count": 0,
    "pledges_value": 0,
    "latest_pledges": []
}

PATCH /problem/{problem_id}

Requirements

Header Required: Authorization: Bearer {access_token}
User must have "create" on "problems" permission

Example Request

{
    "title": "My Problems Title",
    "description": "Description of Problem",
    "specification": "Outline of Specification Needed",
    "make_active": true,
    "active_datetime": "2018-01-01 01:00:00",
    "deadline_datetime": "2018-01-01 01:00:00",
    "topics": [
        "PHP",
        "JS"
    ]
}

Example Response

{
    "problem_id": "prb-9e81df01-a2a7-438a-8f1d-f0b37267688d",
    "user_id": null,
    "organisation_id": null,
    "title": "My Problems Title",
    "description": "Description of Problem",
    "specification": "Outline of Specification Needed",
    "data": "{}",
    "active_datetime": null,
    "deadline_datetime": null,
    "deleted": 0,
    "modified": "2018-10-19 08:54:15",
    "created": "2018-10-19 08:54:15",
    "is_active": false,
    "topics": [],
    "solutions": [
        {
            "solution_id": "sol-38a19f9f-ec1f-4869-a93d-9d5dec8c238b",
            "problem_solution_group_id": null,
            "solution_group_id": null,
            "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
            "name": "My Super Solution name",
            "problem_id": "prb-9e81df01-a2a7-438a-8f1d-f0b37267688d",
            "open_source_location": "https:\/\/mylinktogithub.com\/mycoolsolution",
            "modified": "2018-10-19 08:54:15",
            "created": "2018-10-19 08:54:15",
            "user": {
                "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
                "name": "Johnny DevHead",
                "github_id": null,
                "username": "JohnnyDevHead",
                "modified": "2018-10-19 08:54:15",
                "created": "2018-10-19 08:54:15",
                "avatar_url": null
            },
            "last_five_comments": [],
            "total_comments": 0
        }
    ],
    "user": {
        "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
        "name": "Johnny DevHead",
        "github_id": null,
        "username": "JohnnyDevHead",
        "modified": "2018-10-19 08:54:15",
        "created": "2018-10-19 08:54:15",
        "avatar_url": null
    },
    "pledges_count": 0,
    "pledges_value": 0,
    "latest_pledges": []
}

GET /problem/{problem_id}

Example Response

"coming soon"

GET /problems/user/{user_id}

Example Response

"coming soon"

POST /problem/{problem_id}/solution

Requirements

Header Required: Authorization: Bearer {access_token}
User must have "create" on "solutions" permission

Example Request

{
    "name": "My Super Solution name",
    "open_source_location": "https:\/\/mylinktogithub.com\/mycoolsolution"
}

Example Response

{
    "solution_id": "sol-38a19f9f-ec1f-4869-a93d-9d5dec8c238b",
    "problem_solution_group_id": null,
    "solution_group_id": null,
    "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
    "name": "My Super Solution name",
    "problem_id": "prb-9e81df01-a2a7-438a-8f1d-f0b37267688d",
    "open_source_location": "https:\/\/mylinktogithub.com\/mycoolsolution",
    "modified": "2018-10-19 08:54:15",
    "created": "2018-10-19 08:54:15",
    "user": {
        "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
        "name": "Johnny DevHead",
        "github_id": null,
        "username": "JohnnyDevHead",
        "modified": "2018-10-19 08:54:15",
        "created": "2018-10-19 08:54:15",
        "avatar_url": null
    }
}

POST /problem/{problem_id}/pledge

Requirements

Header Required: "Authorization: Bearer {access_token}"

Example Request

{
    "comment": "A Solution for this problem will be greatly appreciated! <img src=\"http:\/\/monkey.com\/pic.jpg\" \/>",
    "value": "2.50",
    "currency": "USD"
}

Example Response

{
    "pledge_id": "plg-655cbef2-130e-44d7-91c2-e81cf85a0ca8",
    "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
    "organisation_id": null,
    "problem_id": "prb-9e81df01-a2a7-438a-8f1d-f0b37267688d",
    "kudos_points": 0,
    "value": 2.5,
    "currency": "USD",
    "comment": "A Solution for this problem will be greatly appreciated! ",
    "data": "{}",
    "payment_id": null,
    "solution_id": null,
    "created": "2018-10-19 08:54:15",
    "modified": "2018-10-19 08:54:15",
    "user": {
        "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
        "name": "Johnny DevHead",
        "github_id": null,
        "username": "JohnnyDevHead",
        "modified": "2018-10-19 08:54:15",
        "created": "2018-10-19 08:54:15",
        "avatar_url": null
    },
    "is_paid": false,
    "is_verified": false,
    "is_awarded_to_solution": false
}

GET /public/user/{username}

Example Response

{
    "user": {
        "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
        "name": "Johnny DevHead",
        "github_id": null,
        "username": "JohnnyDevHead",
        "modified": "2018-10-19 08:54:15",
        "created": "2018-10-19 08:54:15",
        "avatar_url": null
    },
    "github_user": {
        "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
        "id": 5678765,
        "login": "JohnnyDevHead100",
        "node_id": "hgy78gifrjwemdc",
        "avatar_url": "http:\/\/github.com\/myprofilepic.jpg",
        "gravatar_id": null,
        "type": "User",
        "site_admin": false,
        "name": null,
        "company": null,
        "blog": null,
        "bio": "20 Years Experience Developing Software, Websites & Apps.",
        "location": "Kent",
        "email": "johnndevhead@gmail.com",
        "hireable": null,
        "public_repos": 0,
        "public_gists": 0,
        "followers": 0,
        "following": 0,
        "created_at": "2018-10-19 08:54:15",
        "updated_at": "2018-10-19 08:54:15"
    },
    "problems": [
        {
            "problem_id": "prb-9e81df01-a2a7-438a-8f1d-f0b37267688d",
            "user_id": null,
            "organisation_id": null,
            "title": "My Problems Title",
            "description": "Description of Problem",
            "specification": "Outline of Specification Needed",
            "data": "{}",
            "active_datetime": null,
            "deadline_datetime": null,
            "deleted": 0,
            "modified": "2018-10-19 08:54:15",
            "created": "2018-10-19 08:54:15",
            "is_active": false,
            "topics": [],
            "solutions": [
                {
                    "solution_id": "sol-38a19f9f-ec1f-4869-a93d-9d5dec8c238b",
                    "problem_solution_group_id": null,
                    "solution_group_id": null,
                    "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
                    "name": "My Super Solution name",
                    "problem_id": "prb-9e81df01-a2a7-438a-8f1d-f0b37267688d",
                    "open_source_location": "https:\/\/mylinktogithub.com\/mycoolsolution",
                    "modified": "2018-10-19 08:54:15",
                    "created": "2018-10-19 08:54:15",
                    "user": {
                        "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
                        "name": "Johnny DevHead",
                        "github_id": null,
                        "username": "JohnnyDevHead",
                        "modified": "2018-10-19 08:54:15",
                        "created": "2018-10-19 08:54:15",
                        "avatar_url": null
                    },
                    "last_five_comments": [],
                    "total_comments": 0
                }
            ],
            "user": {
                "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
                "name": "Johnny DevHead",
                "github_id": null,
                "username": "JohnnyDevHead",
                "modified": "2018-10-19 08:54:15",
                "created": "2018-10-19 08:54:15",
                "avatar_url": null
            },
            "pledges_count": 0,
            "pledges_value": 0,
            "latest_pledges": []
        }
    ],
    "solutions": [
        {
            "solution_id": "sol-38a19f9f-ec1f-4869-a93d-9d5dec8c238b",
            "problem_solution_group_id": null,
            "solution_group_id": null,
            "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
            "name": "My Super Solution name",
            "problem_id": "prb-9e81df01-a2a7-438a-8f1d-f0b37267688d",
            "open_source_location": "https:\/\/mylinktogithub.com\/mycoolsolution",
            "modified": "2018-10-19 08:54:15",
            "created": "2018-10-19 08:54:15",
            "user": {
                "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
                "name": "Johnny DevHead",
                "github_id": null,
                "username": "JohnnyDevHead",
                "modified": "2018-10-19 08:54:15",
                "created": "2018-10-19 08:54:15",
                "avatar_url": null
            }
        }
    ],
    "statuses": [
        {
            "comment_id": "cmt-7a571f94-51dc-47a3-aad0-8d1c4ec4bc12",
            "parent_comment_id": null,
            "comment": "My awesome comment! <a href=\"http:\/\/www.google.com\" target=\"_blank\">http:\/\/www.google.com<\/a> link to stuff",
            "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
            "organisation_id": null,
            "entity_id": "prb-9e81df01-a2a7-438a-8f1d-f0b37267688d",
            "modified": "2018-10-19 08:54:15",
            "created": "2018-10-19 08:54:15",
            "last_five_replies": [],
            "total_replies": 0,
            "comment_type": "comment_on_entity",
            "user": {
                "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
                "name": "Johnny DevHead",
                "github_id": null,
                "username": "JohnnyDevHead",
                "modified": "2018-10-19 08:54:15",
                "created": "2018-10-19 08:54:15",
                "avatar_url": null
            }
        }
    ],
    "pledges_count": 20
}

GET /public/solution/{solution_id}

Example Response

{
    "solution_id": "sol-38a19f9f-ec1f-4869-a93d-9d5dec8c238b",
    "problem_solution_group_id": null,
    "solution_group_id": null,
    "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
    "name": "My Super Solution name",
    "problem_id": "prb-9e81df01-a2a7-438a-8f1d-f0b37267688d",
    "open_source_location": "https:\/\/mylinktogithub.com\/mycoolsolution",
    "modified": "2018-10-19 08:54:15",
    "created": "2018-10-19 08:54:15",
    "user": {
        "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
        "name": "Johnny DevHead",
        "github_id": null,
        "username": "JohnnyDevHead",
        "modified": "2018-10-19 08:54:15",
        "created": "2018-10-19 08:54:15",
        "avatar_url": null
    }
}

GET /public/github/id/{github_id}

Example Response

{
    "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
    "id": 5678765,
    "login": "JohnnyDevHead100",
    "node_id": "hgy78gifrjwemdc",
    "avatar_url": "http:\/\/github.com\/myprofilepic.jpg",
    "gravatar_id": null,
    "type": "User",
    "site_admin": false,
    "name": null,
    "company": null,
    "blog": null,
    "bio": "20 Years Experience Developing Software, Websites & Apps.",
    "location": "Kent",
    "email": "johnndevhead@gmail.com",
    "hireable": null,
    "public_repos": 0,
    "public_gists": 0,
    "followers": 0,
    "following": 0,
    "created_at": "2018-10-19 08:54:15",
    "updated_at": "2018-10-19 08:54:15"
}

GET /public/github/{user_id}

Example Response

{
    "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
    "id": 5678765,
    "login": "JohnnyDevHead100",
    "node_id": "hgy78gifrjwemdc",
    "avatar_url": "http:\/\/github.com\/myprofilepic.jpg",
    "gravatar_id": null,
    "type": "User",
    "site_admin": false,
    "name": null,
    "company": null,
    "blog": null,
    "bio": "20 Years Experience Developing Software, Websites & Apps.",
    "location": "Kent",
    "email": "johnndevhead@gmail.com",
    "hireable": null,
    "public_repos": 0,
    "public_gists": 0,
    "followers": 0,
    "following": 0,
    "created_at": "2018-10-19 08:54:15",
    "updated_at": "2018-10-19 08:54:15"
}

GET /server/datetime

Example Response

"coming soon"

GET /server/methods

Example Response

"coming soon"

GET /server/endpoints

Example Response

"coming soon"

GET /status/{status_id}

Example Response

{
    "comment_id": "sts-6633815e-6737-46ce-9819-3db22bb4e8a5",
    "parent_comment_id": null,
    "comment": "My awesome comment about php vs python! <a href=\"http:\/\/www.google.com\" target=\"_blank\">http:\/\/www.google.com<\/a> link to stuff",
    "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
    "organisation_id": null,
    "entity_id": "prb-9e81df01-a2a7-438a-8f1d-f0b37267688d",
    "modified": "2018-10-19 08:54:15",
    "created": "2018-10-19 08:54:15",
    "comment_type": "status",
    "user": {
        "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
        "name": "Johnny DevHead",
        "github_id": null,
        "username": "JohnnyDevHead",
        "modified": "2018-10-19 08:54:15",
        "created": "2018-10-19 08:54:15",
        "avatar_url": null
    },
    "status_id": "sts-6633815e-6737-46ce-9819-3db22bb4e8a5",
    "last_five_comments": [],
    "total_comments": 0,
    "topics": [
        "PHP",
        "Python"
    ]
}

POST /status/create

Requirements

Header Required: "Authorization: Bearer {access_token}"

Example Request

{
    "comment": "My awesome comment about php vs python! http:\/\/www.google.com link to stuff",
    "topics": [
        "PHP",
        "Python"
    ]
}

Example Response

{
    "comment_id": "sts-6633815e-6737-46ce-9819-3db22bb4e8a5",
    "parent_comment_id": null,
    "comment": "My awesome comment about php vs python! <a href=\"http:\/\/www.google.com\" target=\"_blank\">http:\/\/www.google.com<\/a> link to stuff",
    "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
    "organisation_id": null,
    "entity_id": "prb-9e81df01-a2a7-438a-8f1d-f0b37267688d",
    "modified": "2018-10-19 08:54:15",
    "created": "2018-10-19 08:54:15",
    "comment_type": "status",
    "user": {
        "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
        "name": "Johnny DevHead",
        "github_id": null,
        "username": "JohnnyDevHead",
        "modified": "2018-10-19 08:54:15",
        "created": "2018-10-19 08:54:15",
        "avatar_url": null
    },
    "status_id": "sts-6633815e-6737-46ce-9819-3db22bb4e8a5",
    "last_five_comments": [],
    "total_comments": 0,
    "topics": [
        "PHP",
        "Python"
    ]
}

GET /statuses/user/{user_id}

Example Response

"coming soon"

POST /user/createFromEmailPassword

Requirements

Header Required: "Origin-Auth: {origin_token}"

Example Request

{
    "email": "johnndevhead@gmail.com",
    "password": "MyPrettyBloodyAmazing!Password",
    "username": "JohnnyDevHead"
}

Example Response

{
    "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
    "username": "JohnnyDevHead",
    "token": "eyJhbGciOiJTSEEyNTYiLCJ0eXAiOiJKV1QifQ.eyJ0dGwiOjE1NDAwMzkyNTUsInR0ciI6MTU0MDkzOTI1NSwiZGF0YSI6eyJ1c2VyX2lkIjoidXNyLTEzYTNhYzZjLTUyYWQtNDAxYS05ZDcyLWMwZWVmZDY2NWY4OSIsIm5hbWUiOiJKb2hubnkgRGV2SGVhZCIsImVtYWlsIjoiam9obm5kZXZoZWFkQGdtYWlsLmNvbSIsImdpdGh1Yl9pZCI6bnVsbCwiZGF0YSI6Int9IiwidXNlcm5hbWUiOiJKb2hubnlEZXZIZWFkIiwibW9kaWZpZWQiOiIyMDE4LTEwLTE5IDA4OjU0OjE1IiwiY3JlYXRlZCI6IjIwMTgtMTAtMTkgMDg6NTQ6MTUiLCJhdmF0YXJfdXJsIjpudWxsLCJwZXJtaXNzaW9ucyI6W119fQ.573430fd9ffd81e0e77c4571f224a434e1c72b59ecbc9de553e6b965c03eaf90"
}

POST /user/createFromGitHub

Requirements

Header Required: "Origin-Auth: {origin_token}"

Example Request

{
    "code": "0987ygb2n3edieowkms23wqss2",
    "state": "bd7892hdbkn1212asdasd",
    "username": "JohnnyDevHead"
}

Example Response

{
    "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
    "username": "JohnnyDevHead",
    "token": "eyJhbGciOiJTSEEyNTYiLCJ0eXAiOiJKV1QifQ.eyJ0dGwiOjE1NDAwMzkyNTUsInR0ciI6MTU0MDkzOTI1NSwiZGF0YSI6eyJ1c2VyX2lkIjoidXNyLTEzYTNhYzZjLTUyYWQtNDAxYS05ZDcyLWMwZWVmZDY2NWY4OSIsIm5hbWUiOiJKb2hubnkgRGV2SGVhZCIsImVtYWlsIjoiam9obm5kZXZoZWFkQGdtYWlsLmNvbSIsImdpdGh1Yl9pZCI6bnVsbCwiZGF0YSI6Int9IiwidXNlcm5hbWUiOiJKb2hubnlEZXZIZWFkIiwibW9kaWZpZWQiOiIyMDE4LTEwLTE5IDA4OjU0OjE1IiwiY3JlYXRlZCI6IjIwMTgtMTAtMTkgMDg6NTQ6MTUiLCJhdmF0YXJfdXJsIjpudWxsLCJwZXJtaXNzaW9ucyI6W119fQ.573430fd9ffd81e0e77c4571f224a434e1c72b59ecbc9de553e6b965c03eaf90"
}

POST /user/checkUsernameAvailability

Requirements

Header Required: "Origin-Auth: {origin_token}"

Example Request

"coming soon"

Example Response

"coming soon"

POST /user/updatePassword/{user_id}

Requirements

Header Required: "Origin-Auth: {origin_token}"
Header Required: "Authorization: Bearer {access_token}"
User must own the entity being accessed

Example Request

{
    "old_password": "myveryoldpassWord!",
    "new_password": "MyVeryNewPassword33!z00"
}

Example Response

{
    "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
    "username": "JohnnyDevHead",
    "updated_user": {
        "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
        "name": "Johnny DevHead",
        "email": "johnndevhead@gmail.com",
        "github_id": null,
        "data": "{}",
        "username": "JohnnyDevHead",
        "modified": "2018-10-19 08:54:15",
        "created": "2018-10-19 08:54:15",
        "avatar_url": null
    },
    "token": "eyJhbGciOiJTSEEyNTYiLCJ0eXAiOiJKV1QifQ.eyJ0dGwiOjE1NDAwMzkyNTUsInR0ciI6MTU0MDkzOTI1NSwiZGF0YSI6eyJ1c2VyX2lkIjoidXNyLTEzYTNhYzZjLTUyYWQtNDAxYS05ZDcyLWMwZWVmZDY2NWY4OSIsIm5hbWUiOiJKb2hubnkgRGV2SGVhZCIsImVtYWlsIjoiam9obm5kZXZoZWFkQGdtYWlsLmNvbSIsImdpdGh1Yl9pZCI6bnVsbCwiZGF0YSI6Int9IiwidXNlcm5hbWUiOiJKb2hubnlEZXZIZWFkIiwibW9kaWZpZWQiOiIyMDE4LTEwLTE5IDA4OjU0OjE1IiwiY3JlYXRlZCI6IjIwMTgtMTAtMTkgMDg6NTQ6MTUiLCJhdmF0YXJfdXJsIjpudWxsLCJwZXJtaXNzaW9ucyI6W119fQ.573430fd9ffd81e0e77c4571f224a434e1c72b59ecbc9de553e6b965c03eaf90"
}

POST /user/updateGitHub/{user_id}

Requirements

Header Required: "Origin-Auth: {origin_token}"
Header Required: "Authorization: Bearer {access_token}"
User must own the entity being accessed

Example Request

{
    "code": "098ygbn23ebrhduiksmndmc",
    "state": "dihndfjndhjdsms0987"
}

Example Response

{
    "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
    "username": "JohnnyDevHead",
    "updated_user": {
        "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
        "name": "Johnny DevHead",
        "email": "johnndevhead@gmail.com",
        "github_id": null,
        "data": "{}",
        "username": "JohnnyDevHead",
        "modified": "2018-10-19 08:54:15",
        "created": "2018-10-19 08:54:15",
        "avatar_url": null
    },
    "token": "eyJhbGciOiJTSEEyNTYiLCJ0eXAiOiJKV1QifQ.eyJ0dGwiOjE1NDAwMzkyNTUsInR0ciI6MTU0MDkzOTI1NSwiZGF0YSI6eyJ1c2VyX2lkIjoidXNyLTEzYTNhYzZjLTUyYWQtNDAxYS05ZDcyLWMwZWVmZDY2NWY4OSIsIm5hbWUiOiJKb2hubnkgRGV2SGVhZCIsImVtYWlsIjoiam9obm5kZXZoZWFkQGdtYWlsLmNvbSIsImdpdGh1Yl9pZCI6bnVsbCwiZGF0YSI6Int9IiwidXNlcm5hbWUiOiJKb2hubnlEZXZIZWFkIiwibW9kaWZpZWQiOiIyMDE4LTEwLTE5IDA4OjU0OjE1IiwiY3JlYXRlZCI6IjIwMTgtMTAtMTkgMDg6NTQ6MTUiLCJhdmF0YXJfdXJsIjpudWxsLCJwZXJtaXNzaW9ucyI6W119fQ.573430fd9ffd81e0e77c4571f224a434e1c72b59ecbc9de553e6b965c03eaf90"
}

PATCH /user/{user_id}

Requirements

Header Required: "Origin-Auth: {origin_token}"
Header Required: "Authorization: Bearer {access_token}"
User must own the entity being accessed

Example Request

{
    "name": "Johnny DevHead",
    "email": "johnndevhead@gmail.com",
    "username": "JohnnyDevHead"
}

Example Response

{
    "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
    "username": "JohnnyDevHead",
    "updated_user": {
        "user_id": "usr-13a3ac6c-52ad-401a-9d72-c0eefd665f89",
        "name": "Johnny DevHead",
        "email": "johnndevhead@gmail.com",
        "github_id": null,
        "data": "{}",
        "username": "JohnnyDevHead",
        "modified": "2018-10-19 08:54:15",
        "created": "2018-10-19 08:54:15",
        "avatar_url": null
    },
    "token": "eyJhbGciOiJTSEEyNTYiLCJ0eXAiOiJKV1QifQ.eyJ0dGwiOjE1NDAwMzkyNTUsInR0ciI6MTU0MDkzOTI1NSwiZGF0YSI6eyJ1c2VyX2lkIjoidXNyLTEzYTNhYzZjLTUyYWQtNDAxYS05ZDcyLWMwZWVmZDY2NWY4OSIsIm5hbWUiOiJKb2hubnkgRGV2SGVhZCIsImVtYWlsIjoiam9obm5kZXZoZWFkQGdtYWlsLmNvbSIsImdpdGh1Yl9pZCI6bnVsbCwiZGF0YSI6Int9IiwidXNlcm5hbWUiOiJKb2hubnlEZXZIZWFkIiwibW9kaWZpZWQiOiIyMDE4LTEwLTE5IDA4OjU0OjE1IiwiY3JlYXRlZCI6IjIwMTgtMTAtMTkgMDg6NTQ6MTUiLCJhdmF0YXJfdXJsIjpudWxsLCJwZXJtaXNzaW9ucyI6W119fQ.573430fd9ffd81e0e77c4571f224a434e1c72b59ecbc9de553e6b965c03eaf90"
}

POST /user/createStripePaymentMethod/{user_id}

Requirements

Header Required: "Origin-Auth: {origin_token}"
Header Required: "Authorization: Bearer {access_token}"
User must own the entity being accessed

Example Request

"coming soon"

Example Response

"coming soon"

GET /user/paymentMethods/{user_id}

Requirements

Header Required: "Origin-Auth: {origin_token}"
Header Required: "Authorization: Bearer {access_token}"
User must own the entity being accessed

Example Response

"coming soon"

GET /user/pledges/{user_id}

Requirements

Header Required: "Origin-Auth: {origin_token}"
Header Required: "Authorization: Bearer {access_token}"
User must own the entity being accessed

Example Response

"coming soon"

Uh oh!

FilesExpand file tree

ENDPOINTS.MD

Latest commit

History

ENDPOINTS.MD

File metadata and controls

API Endpoints

POST /auth/login

Requirements

Example Request

Example Response

POST /auth/githubLogin

Requirements

Example Request

Example Response

POST /auth/refresh

Requirements

Example Request

Example Response

GET /auth/payload

Requirements

Example Response

GET /comment/{comment_id}

Example Response

GET /comments/{entity_id}

Example Response

GET /comment/replies/{comment_id}

Example Response

GET /comments/{entity_id}/page/{page}

Example Response

GET /comment/replies/{comment_id}/page/{page}

Example Response

POST /comment/reply/{comment_id}

Requirements

Example Request

Example Response

POST /comment/{entity_id}

Requirements

Example Request

Example Response

GET /comments/contextual/{comment_id}

Example Response

POST /entity/getForFeed

Example Request

Example Response

POST /follow/{entity_id}

Requirements

Example Request

Example Response

DELETE /follow/{entity_id}

Requirements

Example Request

Example Response

GET /follows/{user_id}

Example Response

GET /list/topics

Example Response

GET /oauth/github/auth/url/{state}

Requirements

Example Response

GET /organisation/{id}

Requirements

Example Response

POST /pay/pledge/{pledge_id}/stripeToken

Requirements

Example Request

Example Response

POST /pay/pledge/{pledge_id}/paymentMethod

Requirements

Example Request

Example Response

POST /pay/method/stripe/create

Requirements

Example Request

Example Response

GET /pay/stripe/apiKey

Requirements

Example Response

POST /problem/create