Github Copilot Extension (0.0.1)

Download OpenAPI specification:Download

powered by Flasgger

Auth

Login route

Handles login with email or provider.

query Parameters

provider required	string Enum: "email" "github" Provider for authentication
next	string Next URL after successful login

Request Body schema: application/json

email required	string
password required	string

Responses

Request samples

Payload

Content type

application/json

{"email": "jaime@example.com",
"password": "password123"
}

Login route

Handles login with email or provider.

query Parameters

provider required	string Enum: "email" "github" Provider for authentication
next	string Next URL after successful login

Request Body schema: application/json

email required	string
password required	string

Responses

Request samples

Payload

Content type

application/json

{"email": "jaime@example.com",
"password": "password123"
}

Sign out route

Handles sign out of a user.

Request Body schema: application/json

user_id

required

string

Responses

Request samples

Payload

Content type

application/json

{"user_id": "12345"
}

Create a new user

Registers a new user with first name, last name, email, and password.

Request Body schema: application/json

email required	string
first_name required	string
last_name required	string
password required	string

Responses

Request samples

Payload

Content type

application/json

{"email": "jaime@example.com",
"first_name": "Jaime",
"last_name": "Nguyen",
"password": "password123"
}

Logging

Retrieve all logs in the database See Swagger docs for more information.

Fetches all logged events from the database.

Responses

Logs the event to the database. See Swagger docs for more information.

Logs the event to the database.

Request Body schema: application/json

event required	string
metadata required	object

Responses

Request samples

Payload

Content type

application/json

{"event": "User logged in",
"metadata": {"time_lapse": 1708,
"userID": 12345
}
}

Log a suggestion

Logs a suggestion to the database.

Request Body schema: application/json

hasBug required	boolean
model required	string
prompt required	string
suggestionText required	string
userSectionid	string

Responses

Request samples

Payload

Content type

application/json

{"hasBug": false,
"model": "gpt-3",
"prompt": "function add(a, b)",
"suggestionText": "{\n    return a + b;\n}",
"userSectionid": "12345"
}

Get all logs for a specific user See Swagger docs for more information.

Fetches all logged events associated with a specific user ID.

path Parameters

user_id

required

string

Example: 12345

The ID of the user whose logs are being retrieved.

Responses

Suggestions

Get all models available from a vendor

Lists all models available from the selected vendor

query Parameters

vendor

required

string

Example: vendor=openai

Responses

Response samples

200

Content type

application/json

{"models": ["string"
]
}

Generate a suggestion based on the provided prompt. See Swagger docs for more information.

Sends a prompt to the locally running Ollama model with an optional model name and correctness flag, returning the generated suggestion.

Request Body schema: application/json

model	string The AI model to use for generating the suggestion.
parameters	object A flag indicating whether the suggestion should be correct.
prompt required	string
vendor	string

Responses

Request samples

Payload

Content type

application/json

{"model": "codellama:7b",
"parameters": {"top_k": 0.2
},
"prompt": "def add(a, b):",
"vendor": "ollama"
}

Response samples

200
400
500

Content type

application/json

{"suggestions": ["return a + b"
]
}

Get a suggestion by ID

Retrieves a specific suggestion using its unique identifier.

path Parameters

suggestion_id

required

string

Example: abc123

Responses

Users

Get all users

Retrieves all users in the system.

Responses

TODO Get a specific user by ID

Retrieves user details based on the provided user ID.

path Parameters

user_id

required

string

Example: 123

Responses

TODO Get lock status of a specific user by ID

Retrieves lock status of a user based on the provided user ID.

path Parameters

user_id

required

string

Example: 123

Responses

Get classes for a specific user

Retrieves all classes associated with the given user ID.

path Parameters

user_id

required

string

Example: 123