@@ -175,11 +175,13 @@ <h2> Attributes</h2>
175
175
< th style ="text-align:left "> Description </ th >
176
176
< th class ="default-col "> Default</ th >
177
177
</ tr >
178
+
178
179
< tr >
179
180
< td class ="mono-bold "> spec-url </ td >
180
181
< td class ="gray "> url of the OpenAPI spec to view </ td >
181
182
< td > (empty)</ td >
182
183
</ tr >
184
+
183
185
< tr >
184
186
< td class ="mono-bold "> server</ td >
185
187
< td class ="gray ">
@@ -190,26 +192,30 @@ <h2> Attributes</h2>
190
192
</ td >
191
193
< td > (empty)</ td >
192
194
</ tr >
195
+
193
196
< tr >
194
- < td class ="mono-bold "> show-authentication</ td >
195
- < td class ="gray ">
196
- Authentication feature, allows the user to select one of the authentication mechanism thats available in the spec.
197
- It can be http-basic, http-bearer or api-key.
198
- If you dont want your users to go through the authentication process, instead want them to use a pre-generated api-key
199
- then you may hide authentication section by setting this attribute to false
200
- and provide the api-key details using various api-key-???? attributes.</ td >
201
- < td > true</ td >
202
- </ tr >
197
+ < td class ="mono-bold "> allow-authentication</ td >
198
+ < td class ="gray ">
199
+ Authentication feature, allows the user to select one of the authentication mechanism thats available in the spec.
200
+ It can be http-basic, http-bearer or api-key.
201
+ If you dont want your users to go through the authentication process, instead want them to use a pre-generated api-key
202
+ then you may hide authentication section by setting this attribute to false
203
+ and provide the api-key details using various api-key-???? attributes.</ td >
204
+ < td > true</ td >
205
+ </ tr >
206
+
203
207
< tr >
204
208
< td class ="mono-bold "> api-key-name</ td >
205
209
< td class ="gray "> Name of the API key that will be send while trying out the APIs</ td >
206
210
< td > (empty)</ td >
207
211
</ tr >
212
+
208
213
< tr >
209
214
< td class ="mono-bold "> api-key-value</ td >
210
215
< td class ="gray "> Value of the API key that will be send while trying out the APIs</ td >
211
216
< td > Authorization</ td >
212
217
</ tr >
218
+
213
219
< tr >
214
220
< td class ="mono-bold "> api-key-location</ td >
215
221
< td class ="gray ">
@@ -218,14 +224,41 @@ <h2> Attributes</h2>
218
224
</ td >
219
225
< td > header</ td >
220
226
</ tr >
227
+
221
228
< tr >
222
- < td class ="mono-bold "> show-try</ td >
229
+ < td class ="mono-bold "> allow-spec-url-load</ td >
230
+ < td class ="gray ">
231
+ If set to 'false', user will not be able to load any spec url from the UI.
232
+ </ td >
233
+ < td > true</ td >
234
+ </ tr >
235
+
236
+ < tr >
237
+ < td class ="mono-bold "> allow-spec-file-load</ td >
238
+ < td class ="gray ">
239
+ If set to 'false', user will not be able to load any spec file from the local drive.
240
+ This attribute is applicable only when the device width is more than 768px, else this feature is not available
241
+ </ td >
242
+ < td > true</ td >
243
+ </ tr >
244
+
245
+ < tr >
246
+ < td class ="mono-bold "> allow-search</ td >
247
+ < td class ="gray ">
248
+ If set to 'false', user will not be able to search APIs.
249
+ </ td >
250
+ < td > true</ td >
251
+ </ tr >
252
+
253
+ < tr >
254
+ < td class ="mono-bold "> allow-try</ td >
223
255
< td class ="gray ">
224
256
'TRY' feature allows you to make REST calls to the API server.
225
257
To disable this feature set it to false
226
258
</ td >
227
259
< td > true</ td >
228
260
</ tr >
261
+
229
262
< tr >
230
263
< td class ="mono-bold "> show-info</ td >
231
264
< td class ="gray ">
@@ -236,52 +269,60 @@ <h2> Attributes</h2>
236
269
</ td >
237
270
< td > true</ td >
238
271
</ tr >
272
+
239
273
< tr >
240
274
< td class ="mono-bold "> show-header </ td >
241
275
< td class ="gray "> show/hide the header.< br />
242
276
If you dont want your user to open any other api spec, other than the current one, then set this attribute to false</ td >
243
277
< td > true</ td >
244
278
</ tr >
279
+
245
280
< tr >
246
281
< td class ="mono-bold "> heading-text </ td >
247
282
< td class ="gray "> Heading Text on top-left corner </ td >
248
283
< td > (empty)</ td >
249
284
</ tr >
285
+
250
286
< tr >
251
287
< td class ="mono-bold "> header-color </ td >
252
288
< td class ="gray "> Hex color code for the header's background</ td >
253
289
< td > #444444</ td >
254
290
</ tr >
291
+
255
292
< tr >
256
293
< td class ="mono-bold "> primary-color</ td >
257
294
< td class ="gray "> Hex color code on various controls such as buttons, tabs </ td >
258
295
< td > #FF791A</ td >
259
296
</ tr >
297
+
260
298
< tr >
261
299
< td class ="mono-bold "> regular-font </ td >
262
300
< td class ="gray "> Font Name(s) to be used for regular text </ td >
263
301
< td > rapidoc, Helvetica, Arial</ td >
264
302
</ tr >
303
+
265
304
< tr >
266
305
< td class ="mono-bold "> mono-font </ td >
267
306
< td class ="gray "> Font Name(s) to be used for monospaced text </ td >
268
307
< td > Monaco, 'Andale Mono', 'Roboto Mono'</ td >
269
308
</ tr >
309
+
270
310
< tr >
271
311
< td class ="mono-bold "> theme </ td >
272
312
< td class ="gray "> light, dark </ td >
273
313
< td > light</ td >
274
314
</ tr >
315
+
275
316
< tr >
276
317
< td class ="mono-bold "> layout </ td >
277
318
< td class ="gray "> layout helps in placement of your request/response sections. The allowed values are 'row' or 'column'.
278
319
In column layout, request & response sections are placed one below the other,
279
320
In row layout request & response sections are placed side by side.
280
321
This attribute is applicable only when the device width is more than 768px.
281
-
282
322
</ td >
283
323
< td > row</ td >
284
324
</ tr >
325
+
285
326
</ table >
286
327
</ div >
287
328
0 commit comments