Skip to content

docs: improve description #198

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
samolusey wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: improve description #198

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions src/public/public.controller.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,12 @@ export class PublicController {
},
})
@HttpCode(HttpStatus.OK)
/*
* Retrieves public information about the application including app name, version, and available features.
* @returns {Promise<Object>} Returns an object containing a success message and application data
* including appName, version, description, and list of features.
* @throws {UnauthorizedException} If the user is not authenticated or lacks admin role.
*/
getPublicInfo() {
return {
message: 'This is public information - no authentication required',
Expand All @@ -58,6 +64,12 @@ export class PublicController {

@Get('courses')
@HttpCode(HttpStatus.OK)
/*
* Retrieves a list of publicly available courses from the platform.
* @returns {Promise<Object>} Returns an object containing a success message and an array of courses,
* each with id, title, description, category, and publication status.
* @throws {UnauthorizedException} If the user is not authenticated or lacks admin role.
*/
getPublicCourses() {
return {
message: 'Public course catalog - no authentication required',
Expand All @@ -84,6 +96,12 @@ export class PublicController {

@Get('categories')
@HttpCode(HttpStatus.OK)
/*
* Retrieves a list of all available course categories with their styling information.
* @returns {Promise<Object>} Returns an object containing a success message and an array of categories,
* each with id, name, and associated color code.
* @throws {UnauthorizedException} If the user is not authenticated or lacks admin role.
*/
getPublicCategories() {
return {
message: 'Public course categories - no authentication required',
Expand Down