Swashbuckle.AspNetCore.SwaggerUI.xml 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Swashbuckle.AspNetCore.SwaggerUI</name>
  5. </assembly>
  6. <members>
  7. <member name="M:Microsoft.AspNetCore.Builder.SwaggerUIBuilderExtensions.UseSwaggerUI(Microsoft.AspNetCore.Builder.IApplicationBuilder,Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions)">
  8. <summary>
  9. Register the SwaggerUI middleware with provided options
  10. </summary>
  11. </member>
  12. <member name="M:Microsoft.AspNetCore.Builder.SwaggerUIBuilderExtensions.UseSwaggerUI(Microsoft.AspNetCore.Builder.IApplicationBuilder,System.Action{Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions})">
  13. <summary>
  14. Register the SwaggerUI middleware with optional setup action for DI-injected options
  15. </summary>
  16. </member>
  17. <member name="M:Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.InjectStylesheet(Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions,System.String,System.String)">
  18. <summary>
  19. Injects additional CSS stylesheets into the index.html page
  20. </summary>
  21. <param name="options"></param>
  22. <param name="path">A path to the stylesheet - i.e. the link "href" attribute</param>
  23. <param name="media">The target media - i.e. the link "media" attribute</param>
  24. </member>
  25. <member name="M:Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.InjectJavascript(Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions,System.String,System.String)">
  26. <summary>
  27. Injects additional Javascript files into the index.html page
  28. </summary>
  29. <param name="options"></param>
  30. <param name="path">A path to the javascript - i.e. the script "src" attribute</param>
  31. <param name="type">The script type - i.e. the script "type" attribute</param>
  32. </member>
  33. <member name="M:Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.SwaggerEndpoint(Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions,System.String,System.String)">
  34. <summary>
  35. Adds Swagger JSON endpoints. Can be fully-qualified or relative to the UI page
  36. </summary>
  37. <param name="options"></param>
  38. <param name="url">Can be fully qualified or relative to the current host</param>
  39. <param name="name">The description that appears in the document selector drop-down</param>
  40. </member>
  41. <member name="M:Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.EnableDeepLinking(Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions)">
  42. <summary>
  43. Enables deep linking for tags and operations
  44. </summary>
  45. <param name="options"></param>
  46. </member>
  47. <member name="M:Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.EnablePersistAuthorization(Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions)">
  48. <summary>
  49. Enables persist authorization data
  50. </summary>
  51. <param name="options"></param>
  52. </member>
  53. <member name="M:Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.DisplayOperationId(Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions)">
  54. <summary>
  55. Controls the display of operationId in operations list
  56. </summary>
  57. <param name="options"></param>
  58. </member>
  59. <member name="M:Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.DefaultModelsExpandDepth(Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions,System.Int32)">
  60. <summary>
  61. The default expansion depth for models (set to -1 completely hide the models)
  62. </summary>
  63. <param name="options"></param>
  64. <param name="depth"></param>
  65. </member>
  66. <member name="M:Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.DefaultModelExpandDepth(Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions,System.Int32)">
  67. <summary>
  68. The default expansion depth for the model on the model-example section
  69. </summary>
  70. <param name="options"></param>
  71. <param name="depth"></param>
  72. </member>
  73. <member name="M:Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.DefaultModelRendering(Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions,Swashbuckle.AspNetCore.SwaggerUI.ModelRendering)">
  74. <summary>
  75. Controls how the model is shown when the API is first rendered.
  76. (The user can always switch the rendering for a given model by clicking the 'Model' and 'Example Value' links.)
  77. </summary>
  78. <param name="options"></param>
  79. <param name="modelRendering"></param>
  80. </member>
  81. <member name="M:Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.DisplayRequestDuration(Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions)">
  82. <summary>
  83. Controls the display of the request duration (in milliseconds) for Try-It-Out requests
  84. </summary>
  85. <param name="options"></param>
  86. </member>
  87. <member name="M:Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.DocExpansion(Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions,Swashbuckle.AspNetCore.SwaggerUI.DocExpansion)">
  88. <summary>
  89. Controls the default expansion setting for the operations and tags.
  90. It can be 'List' (expands only the tags), 'Full' (expands the tags and operations) or 'None' (expands nothing)
  91. </summary>
  92. <param name="options"></param>
  93. <param name="docExpansion"></param>
  94. </member>
  95. <member name="M:Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.EnableFilter(Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions,System.String)">
  96. <summary>
  97. Enables filtering. The top bar will show an edit box that you can use to filter the tagged operations that are shown.
  98. If an expression is provided it will be used and applied initially.
  99. Filtering is case sensitive matching the filter expression anywhere inside the tag
  100. </summary>
  101. <param name="options"></param>
  102. <param name="expression"></param>
  103. </member>
  104. <member name="M:Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.EnableTryItOutByDefault(Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions)">
  105. <summary>
  106. Enables the "Try it out" section by default.
  107. </summary>
  108. <param name="options"></param>
  109. </member>
  110. <member name="M:Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.MaxDisplayedTags(Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions,System.Int32)">
  111. <summary>
  112. Limits the number of tagged operations displayed to at most this many. The default is to show all operations
  113. </summary>
  114. <param name="options"></param>
  115. <param name="count"></param>
  116. </member>
  117. <member name="M:Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.ShowExtensions(Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions)">
  118. <summary>
  119. Controls the display of vendor extension (x-) fields and values for Operations, Parameters, and Schema
  120. </summary>
  121. <param name="options"></param>
  122. </member>
  123. <member name="M:Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.ShowCommonExtensions(Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions)">
  124. <summary>
  125. Controls the display of extensions (pattern, maxLength, minLength, maximum, minimum) fields and values for Parameters
  126. </summary>
  127. <param name="options"></param>
  128. </member>
  129. <member name="M:Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.SupportedSubmitMethods(Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions,Swashbuckle.AspNetCore.SwaggerUI.SubmitMethod[])">
  130. <summary>
  131. List of HTTP methods that have the Try it out feature enabled. An empty array disables Try it out for all operations.
  132. This does not filter the operations from the display
  133. </summary>
  134. <param name="options"></param>
  135. <param name="submitMethods"></param>
  136. </member>
  137. <member name="M:Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.OAuth2RedirectUrl(Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions,System.String)">
  138. <summary>
  139. OAuth redirect URL
  140. </summary>
  141. <param name="options"></param>
  142. <param name="url"></param>
  143. </member>
  144. <member name="M:Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.EnableValidator(Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions,System.String)">
  145. <summary>
  146. You can use this parameter to enable the swagger-ui's built-in validator (badge) functionality
  147. Setting it to null will disable validation
  148. </summary>
  149. <param name="options"></param>
  150. <param name="url"></param>
  151. </member>
  152. <member name="M:Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.OAuthClientId(Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions,System.String)">
  153. <summary>
  154. Default clientId
  155. </summary>
  156. <param name="options"></param>
  157. <param name="value"></param>
  158. </member>
  159. <member name="M:Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.OAuthUsername(Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions,System.String)">
  160. <summary>
  161. Default userName
  162. </summary>
  163. <param name="options"></param>
  164. <param name="value"></param>
  165. </member>
  166. <member name="M:Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.OAuthClientSecret(Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions,System.String)">
  167. <summary>
  168. Default clientSecret
  169. </summary>
  170. <param name="options"></param>
  171. <param name="value"></param>
  172. <remarks>Setting this exposes the client secrets in inline javascript in the swagger-ui generated html.</remarks>
  173. </member>
  174. <member name="M:Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.OAuthRealm(Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions,System.String)">
  175. <summary>
  176. realm query parameter (for oauth1) added to authorizationUrl and tokenUrl
  177. </summary>
  178. <param name="options"></param>
  179. <param name="value"></param>
  180. </member>
  181. <member name="M:Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.OAuthAppName(Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions,System.String)">
  182. <summary>
  183. Application name, displayed in authorization popup
  184. </summary>
  185. <param name="options"></param>
  186. <param name="value"></param>
  187. </member>
  188. <member name="M:Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.OAuthScopeSeparator(Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions,System.String)">
  189. <summary>
  190. Scope separator for passing scopes, encoded before calling, default value is a space (encoded value %20)
  191. </summary>
  192. <param name="options"></param>
  193. <param name="value"></param>
  194. </member>
  195. <member name="M:Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.OAuthScopes(Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions,System.String[])">
  196. <summary>
  197. String array of initially selected oauth scopes, default is empty array
  198. </summary>
  199. </member>
  200. <member name="M:Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.OAuthAdditionalQueryStringParams(Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions,System.Collections.Generic.Dictionary{System.String,System.String})">
  201. <summary>
  202. Additional query parameters added to authorizationUrl and tokenUrl
  203. </summary>
  204. <param name="options"></param>
  205. <param name="value"></param>
  206. </member>
  207. <member name="M:Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.OAuthUseBasicAuthenticationWithAccessCodeGrant(Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions)">
  208. <summary>
  209. Only activated for the accessCode flow. During the authorization_code request to the tokenUrl,
  210. pass the Client Password using the HTTP Basic Authentication scheme (Authorization header with
  211. Basic base64encoded[client_id:client_secret]). The default is false
  212. </summary>
  213. <param name="options"></param>
  214. </member>
  215. <member name="M:Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.OAuthUsePkce(Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions)">
  216. <summary>
  217. Only applies to authorizatonCode flows. Proof Key for Code Exchange brings enhanced security for OAuth public clients.
  218. The default is false
  219. </summary>
  220. <param name="options"></param>
  221. </member>
  222. <member name="M:Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.UseRequestInterceptor(Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions,System.String)">
  223. <summary>
  224. Function to intercept remote definition, "Try it out", and OAuth 2.0 requests.
  225. </summary>
  226. <param name="options"></param>
  227. <param name="value">MUST be a valid Javascript function: (request: SwaggerRequest) => SwaggerRequest</param>
  228. </member>
  229. <member name="M:Microsoft.AspNetCore.Builder.SwaggerUIOptionsExtensions.UseResponseInterceptor(Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions,System.String)">
  230. <summary>
  231. Function to intercept remote definition, "Try it out", and OAuth 2.0 responses.
  232. </summary>
  233. <param name="options"></param>
  234. <param name="value">MUST be a valid Javascript function: (response: SwaggerResponse ) => SwaggerResponse </param>
  235. </member>
  236. <member name="P:Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions.RoutePrefix">
  237. <summary>
  238. Gets or sets a route prefix for accessing the swagger-ui
  239. </summary>
  240. </member>
  241. <member name="P:Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions.IndexStream">
  242. <summary>
  243. Gets or sets a Stream function for retrieving the swagger-ui page
  244. </summary>
  245. </member>
  246. <member name="P:Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions.DocumentTitle">
  247. <summary>
  248. Gets or sets a title for the swagger-ui page
  249. </summary>
  250. </member>
  251. <member name="P:Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions.HeadContent">
  252. <summary>
  253. Gets or sets additional content to place in the head of the swagger-ui page
  254. </summary>
  255. </member>
  256. <member name="P:Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions.ConfigObject">
  257. <summary>
  258. Gets the JavaScript config object, represented as JSON, that will be passed to the SwaggerUI
  259. </summary>
  260. </member>
  261. <member name="P:Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions.OAuthConfigObject">
  262. <summary>
  263. Gets the JavaScript config object, represented as JSON, that will be passed to the initOAuth method
  264. </summary>
  265. </member>
  266. <member name="P:Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions.Interceptors">
  267. <summary>
  268. Gets the interceptor functions that define client-side request/response interceptors
  269. </summary>
  270. </member>
  271. <member name="P:Swashbuckle.AspNetCore.SwaggerUI.ConfigObject.Urls">
  272. <summary>
  273. One or more Swagger JSON endpoints (url and name) to power the UI
  274. </summary>
  275. </member>
  276. <member name="P:Swashbuckle.AspNetCore.SwaggerUI.ConfigObject.DeepLinking">
  277. <summary>
  278. If set to true, enables deep linking for tags and operations
  279. </summary>
  280. </member>
  281. <member name="P:Swashbuckle.AspNetCore.SwaggerUI.ConfigObject.PersistAuthorization">
  282. <summary>
  283. If set to true, it persists authorization data and it would not be lost on browser close/refresh
  284. </summary>
  285. </member>
  286. <member name="P:Swashbuckle.AspNetCore.SwaggerUI.ConfigObject.DisplayOperationId">
  287. <summary>
  288. Controls the display of operationId in operations list
  289. </summary>
  290. </member>
  291. <member name="P:Swashbuckle.AspNetCore.SwaggerUI.ConfigObject.DefaultModelsExpandDepth">
  292. <summary>
  293. The default expansion depth for models (set to -1 completely hide the models)
  294. </summary>
  295. </member>
  296. <member name="P:Swashbuckle.AspNetCore.SwaggerUI.ConfigObject.DefaultModelExpandDepth">
  297. <summary>
  298. The default expansion depth for the model on the model-example section
  299. </summary>
  300. </member>
  301. <member name="P:Swashbuckle.AspNetCore.SwaggerUI.ConfigObject.DefaultModelRendering">
  302. <summary>
  303. Controls how the model is shown when the API is first rendered.
  304. (The user can always switch the rendering for a given model by clicking the 'Model' and 'Example Value' links)
  305. </summary>
  306. </member>
  307. <member name="P:Swashbuckle.AspNetCore.SwaggerUI.ConfigObject.DisplayRequestDuration">
  308. <summary>
  309. Controls the display of the request duration (in milliseconds) for Try-It-Out requests
  310. </summary>
  311. </member>
  312. <member name="P:Swashbuckle.AspNetCore.SwaggerUI.ConfigObject.DocExpansion">
  313. <summary>
  314. Controls the default expansion setting for the operations and tags.
  315. It can be 'list' (expands only the tags), 'full' (expands the tags and operations) or 'none' (expands nothing)
  316. </summary>
  317. </member>
  318. <member name="P:Swashbuckle.AspNetCore.SwaggerUI.ConfigObject.Filter">
  319. <summary>
  320. If set, enables filtering. The top bar will show an edit box that you can use to filter the tagged operations
  321. that are shown. Can be an empty string or specific value, in which case filtering will be enabled using that
  322. value as the filter expression. Filtering is case sensitive matching the filter expression anywhere inside the tag
  323. </summary>
  324. </member>
  325. <member name="P:Swashbuckle.AspNetCore.SwaggerUI.ConfigObject.MaxDisplayedTags">
  326. <summary>
  327. If set, limits the number of tagged operations displayed to at most this many. The default is to show all operations
  328. </summary>
  329. </member>
  330. <member name="P:Swashbuckle.AspNetCore.SwaggerUI.ConfigObject.ShowExtensions">
  331. <summary>
  332. Controls the display of vendor extension (x-) fields and values for Operations, Parameters, and Schema
  333. </summary>
  334. </member>
  335. <member name="P:Swashbuckle.AspNetCore.SwaggerUI.ConfigObject.ShowCommonExtensions">
  336. <summary>
  337. Controls the display of extensions (pattern, maxLength, minLength, maximum, minimum) fields and values for Parameters
  338. </summary>
  339. </member>
  340. <member name="P:Swashbuckle.AspNetCore.SwaggerUI.ConfigObject.OAuth2RedirectUrl">
  341. <summary>
  342. OAuth redirect URL
  343. </summary>
  344. </member>
  345. <member name="P:Swashbuckle.AspNetCore.SwaggerUI.ConfigObject.SupportedSubmitMethods">
  346. <summary>
  347. List of HTTP methods that have the Try it out feature enabled.
  348. An empty array disables Try it out for all operations. This does not filter the operations from the display
  349. </summary>
  350. </member>
  351. <member name="P:Swashbuckle.AspNetCore.SwaggerUI.ConfigObject.TryItOutEnabled">
  352. <summary>
  353. Controls whether the "Try it out" section should be enabled by default.
  354. </summary>
  355. </member>
  356. <member name="P:Swashbuckle.AspNetCore.SwaggerUI.ConfigObject.ValidatorUrl">
  357. <summary>
  358. By default, Swagger-UI attempts to validate specs against swagger.io's online validator.
  359. You can use this parameter to set a different validator URL, for example for locally deployed validators (Validator Badge).
  360. Setting it to null will disable validation
  361. </summary>
  362. </member>
  363. <member name="P:Swashbuckle.AspNetCore.SwaggerUI.OAuthConfigObject.Username">
  364. <summary>
  365. Default username for OAuth2 password flow.
  366. </summary>
  367. </member>
  368. <member name="P:Swashbuckle.AspNetCore.SwaggerUI.OAuthConfigObject.ClientId">
  369. <summary>
  370. Default clientId
  371. </summary>
  372. </member>
  373. <member name="P:Swashbuckle.AspNetCore.SwaggerUI.OAuthConfigObject.ClientSecret">
  374. <summary>
  375. Default clientSecret
  376. </summary>
  377. <remarks>Setting this exposes the client secrets in inline javascript in the swagger-ui generated html.</remarks>
  378. </member>
  379. <member name="P:Swashbuckle.AspNetCore.SwaggerUI.OAuthConfigObject.Realm">
  380. <summary>
  381. Realm query parameter (for oauth1) added to authorizationUrl and tokenUrl
  382. </summary>
  383. </member>
  384. <member name="P:Swashbuckle.AspNetCore.SwaggerUI.OAuthConfigObject.AppName">
  385. <summary>
  386. Application name, displayed in authorization popup
  387. </summary>
  388. </member>
  389. <member name="P:Swashbuckle.AspNetCore.SwaggerUI.OAuthConfigObject.ScopeSeparator">
  390. <summary>
  391. Scope separator for passing scopes, encoded before calling, default value is a space (encoded value %20)
  392. </summary>
  393. </member>
  394. <member name="P:Swashbuckle.AspNetCore.SwaggerUI.OAuthConfigObject.Scopes">
  395. <summary>
  396. String array of initially selected oauth scopes, default is empty array
  397. </summary>
  398. </member>
  399. <member name="P:Swashbuckle.AspNetCore.SwaggerUI.OAuthConfigObject.AdditionalQueryStringParams">
  400. <summary>
  401. Additional query parameters added to authorizationUrl and tokenUrl
  402. </summary>
  403. </member>
  404. <member name="P:Swashbuckle.AspNetCore.SwaggerUI.OAuthConfigObject.UseBasicAuthenticationWithAccessCodeGrant">
  405. <summary>
  406. Only activated for the accessCode flow. During the authorization_code request to the tokenUrl,
  407. pass the Client Password using the HTTP Basic Authentication scheme
  408. (Authorization header with Basic base64encode(client_id + client_secret))
  409. </summary>
  410. </member>
  411. <member name="P:Swashbuckle.AspNetCore.SwaggerUI.OAuthConfigObject.UsePkceWithAuthorizationCodeGrant">
  412. <summary>
  413. Only applies to authorizatonCode flows. Proof Key for Code Exchange brings enhanced security for OAuth public clients.
  414. The default is false
  415. </summary>
  416. </member>
  417. <member name="P:Swashbuckle.AspNetCore.SwaggerUI.InterceptorFunctions.RequestInterceptorFunction">
  418. <summary>
  419. MUST be a valid Javascript function.
  420. Function to intercept remote definition, "Try it out", and OAuth 2.0 requests.
  421. Accepts one argument requestInterceptor(request) and must return the modified request, or a Promise that resolves to the modified request.
  422. Ex: "function (req) { req.headers['MyCustomHeader'] = 'CustomValue'; return req; }"
  423. </summary>
  424. </member>
  425. <member name="P:Swashbuckle.AspNetCore.SwaggerUI.InterceptorFunctions.ResponseInterceptorFunction">
  426. <summary>
  427. MUST be a valid Javascript function.
  428. Function to intercept remote definition, "Try it out", and OAuth 2.0 responses.
  429. Accepts one argument responseInterceptor(response) and must return the modified response, or a Promise that resolves to the modified response.
  430. Ex: "function (res) { console.log(res); return res; }"
  431. </summary>
  432. </member>
  433. </members>
  434. </doc>