Skip to content

Commit 38fa8c8

Browse files
authored
[CUR-1013/CUR-1015/CUR-1016] API Doc updated (ActiveLearningStudio#297)
* issues fixed [CUR-1013,CUR-1015,CUR-1016] related to api doc * added some style for doc page and also update url in index.php for dev server * added style.css minified version for better performance
1 parent ae10dec commit 38fa8c8

File tree

14 files changed

+723
-27362
lines changed

14 files changed

+723
-27362
lines changed

app/Http/Controllers/Api/V1/ActivityController.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ public function index()
6969
}
7070

7171
/**
72-
* Upload thumbnail
72+
* Upload Activity thumbnail
7373
*
7474
* Upload thumbnail image for a activity
7575
*

app/Http/Controllers/Api/V1/Admin/ActivityItemController.php

+3-3
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ public function index(Request $request)
5353
}
5454

5555
/**
56-
* Get Activity Item
56+
* Get Specified Activity Item
5757
*
5858
* Get the specified Activity Item data.
5959
*
@@ -72,7 +72,7 @@ public function show($id)
7272
}
7373

7474
/**
75-
* Create Activity Item
75+
* Create New Activity Item
7676
*
7777
* Creates the new activity item in database.
7878
*
@@ -99,7 +99,7 @@ public function store(StoreActivityItem $request)
9999
}
100100

101101
/**
102-
* Update Activity Item
102+
* Update Specified Activity Item
103103
*
104104
* Updates the activity item in database.
105105
*

app/Http/Controllers/Api/V1/Admin/ActivityTypeController.php

+3-3
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ public function index(Request $request)
5454
}
5555

5656
/**
57-
* Get Activity Type
57+
* Get Specified Activity Type
5858
*
5959
* Get the specified Activity Type data.
6060
*
@@ -73,7 +73,7 @@ public function show($id)
7373
}
7474

7575
/**
76-
* Create Activity Type
76+
* Create New Activity Type
7777
*
7878
* Creates the new activity type in database.
7979
*
@@ -100,7 +100,7 @@ public function store(StoreActivityType $request)
100100
}
101101

102102
/**
103-
* Update Activity Type
103+
* Update Specified Activity Type
104104
*
105105
* Updates the activity type in database.
106106
*

app/Http/Controllers/Api/V1/Admin/UserController.php

+4-4
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ public function __construct(UserRepository $userRepository)
3939
}
4040

4141
/**
42-
* Get All Users
42+
* Get All Users List
4343
*
4444
* Returns the paginated response with pagination links (DataTables are fully supported - All Params).
4545
*
@@ -57,7 +57,7 @@ public function index(Request $request)
5757
}
5858

5959
/**
60-
* Get User
60+
* Get Specified User
6161
*
6262
* Get the specified user data.
6363
*
@@ -103,7 +103,7 @@ public function store(StoreUser $request)
103103
}
104104

105105
/**
106-
* Update User
106+
* Update Specified User
107107
*
108108
* Updates the user data in database.
109109
*
@@ -133,7 +133,7 @@ public function update(UpdateUser $request, $id)
133133
}
134134

135135
/**
136-
* Delete User
136+
* Delete Specified User
137137
*
138138
* Deletes the user record from database.
139139
*

app/Http/Controllers/Api/V1/TeamController.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ public function index()
9494
}
9595

9696
/**
97-
* Invite Team Member on Team Creation
97+
* Invite Team
9898
*
9999
* Invite a team member while creating a team.
100100
*

config/apidoc.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@
244244
* If you want to use this, please be aware of the following rules:
245245
* - the image size must be 230 x 52
246246
*/
247-
'logo' => false,
247+
'logo' => resource_path('views') . '/api/logo.png',
248248

249249
/*
250250
* Name for the group of routes which do not have a @group set.

0 commit comments

Comments
 (0)