kyy/swagger-ui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: onComplete config option (#4322)

Browse Source 
* feat: `onComplete` config option

* tests(e2e): add case for onComplete option
This commit is contained in:
kyle
2018-03-16 00:08:39 -07:00
committed by GitHub
parent b0be261ef8
commit 624a81201f
7 changed files with 167 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/usage/configuration.md
View File

@@ -59,6 +59,7 @@ Parameter Name | Description
`operationsSorter` | `Function=(a => a)`. Apply a sort to the operation list of each API. It can be 'alpha' (sort by paths alphanumerically), 'method' (sort by HTTP method) or a function (see Array.prototype.sort() to know how sort function works). Default is the order returned by the server unchanged.
`showExtensions` | `Boolean=false`. Controls the display of vendor extension (`x-`) fields and values for Operations, Parameters, and Schema.
`tagsSorter` | `Function=(a => a)`. Apply a sort to the tag list of each API. It can be 'alpha' (sort by paths alphanumerically) or a function (see [Array.prototype.sort()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) to learn how to write a sort function). Two tag name strings are passed to the sorter for each pass. Default is the order determined by Swagger-UI.
`onComplete` | `Function=NOOP`. Provides a mechanism to be notified when Swagger-UI has finished rendering a newly provided definition.
##### Network