diff --git a/docs/index.html b/docs/index.html index b77cb7d..e32c2a6 100644 --- a/docs/index.html +++ b/docs/index.html @@ -12,351 +12,343 @@ margin: 0; } - -

KWoC Backend (2.0.0)

Download OpenAPI specification:Download

KWoC Backend API written in go

-

Checks the health status of the server and database.

The HealthCheck endpoint examines the operational status of the server and the associated database.

-

Responses

ping

Ping responds with "pong" and returns the latency

-

Responses

OAuth Authentication

Authenticates a user throught Github OAuth.

-
Request Body schema: application/json

Fields required for authentication.

-
code
string

Code generated by Github OAuth

-
type
string

mentor or student

-

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "email": "string",
  • "is_new_user": true,
  • "jwt": "string",
  • "name": "string",
  • "type": "string",
  • "username": "string"
}

Submit blog link

submit a blog link for a student + " fill="currentColor">

KWoC Backend (2.0.0)

Download OpenAPI specification:Download

KWoC Backend API written in go

+

Checks the health status of the server and database.

The HealthCheck endpoint examines the operational status of the server and the associated database.

+

Responses

ping

Ping responds with "pong" and returns the latency

+

Responses

OAuth Authentication

Authenticates a user throught Github OAuth.

+
Request Body schema: application/json
required

Fields required for authentication.

+
code
string

Code generated by Github OAuth

+
type
string

mentor or student

+

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "email": "string",
  • "is_new_user": true,
  • "jwt": "string",
  • "name": "string",
  • "type": "string",
  • "username": "string"
}

Submit blog link

submit a blog link for a student requires login

-
Authorizations:
JWT
Request Body schema: application/json

Fields required for student bloglink

-
blog_link
string
username
string

Responses

Request samples

Content type
application/json
{
  • "blog_link": "string",
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Fetches the student dashboard

Fetches the required details for the student dashboard

-
Authorizations:
JWT

Responses

Response samples

Content type
application/json
{
  • "college": "string",
  • "commit_count": 0,
  • "languages_used": [
    ],
  • "lines_added": 0,
  • "lines_removed": 0,
  • "name": "string",
  • "passed_end_evals": true,
  • "passed_mid_evals": true,
  • "projects_worked": [
    ],
  • "pull_count": 0,
  • "username": "string"
}

Register a student

Register a new student with the provided details.

-
Authorizations:
JWT
Request Body schema: application/json

Fields required for student registeration

-
college
string
email
string
name
string
username
string

Responses

Request samples

Content type
application/json
{
  • "college": "string",
  • "email": "string",
  • "name": "string",
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}
+
Authorizations:
JWT
Request Body schema: application/json
required

Fields required for student bloglink

+
blog_link
string
username
string

Responses

Request samples

Content type
application/json
{
  • "blog_link": "string",
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Fetches the student dashboard

Fetches the required details for the student dashboard

+
Authorizations:
JWT

Responses

Response samples

Content type
application/json
{
  • "college": "string",
  • "commit_count": 0,
  • "languages_used": [
    ],
  • "lines_added": 0,
  • "lines_removed": 0,
  • "name": "string",
  • "passed_end_evals": true,
  • "passed_mid_evals": true,
  • "projects_worked": [
    ],
  • "pull_count": 0,
  • "username": "string"
}

Register a student

Register a new student with the provided details.

+
Authorizations:
JWT
Request Body schema: application/json
required

Fields required for student registeration

+
college
string
email
string
name
string
username
string

Responses

Request samples

Content type
application/json
{
  • "college": "string",
  • "email": "string",
  • "name": "string",
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}