This repository has been archived by the owner on Nov 3, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 6
/
apidocs.php
182 lines (129 loc) · 4.71 KB
/
apidocs.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
<?php
return [
/*
|--------------------------------------------------------------------------
| API Docs Profiles
|--------------------------------------------------------------------------
|
| Different possible profiles used for documentation generation based on samples.
|
| Each profile is defined with :
|
| - defaultRoutePrefix : Used for routing and added at the end of the computed output base (e.g. public/docs/developer/v1)
| - outputPathBase : Base of the directory where to generate the documentation (e.g. public/docs/developer)
| - actAsUserId : User ID used to fake Api access with generator
| - bindings : Bindings used to generate samples responses in documentation
| - routes : Routes used to generate documentation
|
| @see SamplesSeeder
| @see App\Console\Commands\GenerateApiDocs
|
*/
'profiles' => [
'Developer' => [
'defaultRoutePrefix' => 'v1',
'outputPathBase' => realpath(base_path('public/docs/Developer')),
'actAsUserId' => '41abdec2-1389-11e7-93ae-92361f002671',
'bindings' => [
// Notification filter
'read_status' => 'unread',
// John Smith
'userId' => '605c7610-1389-11e7-93ae-92361f002671',
// End-User,
'userGroupId' => 'End-User',
// en
'i18nLangId' => 'en',
// I18n lang id in query
'i18n_lang_id' => 'fr',
// Search page in query
'page' => 1,
// Search limit in query
'limit' => 5,
],
'routes' => [
'me.index',
'meNotification.index',
'meNotification.updateAllRead',
'meNotification.updateRead',
'meNotification.updateUnread',
'user.index',
'user.show',
'user.store',
'user.update',
'user.destroy',
'userGroup.index',
'userGroup.show',
'userGroupUser.index',
'i18nLang.index',
'i18nLang.show',
'i18nLang.store',
'i18nLang.update',
'i18nLang.destroy',
],
],
'Support' => [
'defaultRoutePrefix' => 'v1',
'outputPathBase' => realpath(base_path('public/docs/Support')),
'actAsUserId' => '41abdec2-1389-11e7-93ae-92361f002671',
'bindings' => [
// Notification filter
'read_status' => 'unread',
// John Smith
'userId' => '605c7610-1389-11e7-93ae-92361f002671',
// End-User,
'userGroupId' => 'End-User',
// en
'i18nLangId' => 'en',
// I18n lang id in query
'i18n_lang_id' => 'fr',
// Search page in query
'page' => 1,
// Limit in query
'limit' => 5,
],
'routes' => [
'me.index',
'meNotification.index',
'meNotification.updateAllRead',
'meNotification.updateRead',
'meNotification.updateUnread',
'user.index',
'user.show',
'user.store',
'user.update',
'user.destroy',
'userGroup.index',
'userGroup.show',
'userGroupUser.index',
'i18nLang.index',
'i18nLang.show',
],
],
'End-User' => [
'defaultRoutePrefix' => 'v1',
'outputPathBase' => realpath(base_path('public/docs/End-User')),
'actAsUserId' => '605c7610-1389-11e7-93ae-92361f002671',
'bindings' => [
// Notification filter
'read_status' => 'unread',
// John Smith
'userId' => '605c7610-1389-11e7-93ae-92361f002671',
// en
'i18nLangId' => 'en',
// I18n lang id in query
'i18n_lang_id' => 'fr',
// Page in query
'page' => 1,
// Limit in query
'limit' => 5,
],
'routes' => [
'me.index',
'meNotification.index',
'meNotification.updateAllRead',
'meNotification.updateRead',
'meNotification.updateUnread',
],
],
],
];