Commit Graph

43 Commits

Author SHA1 Message Date
kyle
b714810bfe housekeeping: indicate index.html usage of deepLinking flag (via #5118) 2019-01-10 16:52:47 -06:00
kyle
5052f37909 housekeeping: fix typo in configuration anchor name (via #5109) 2019-01-05 00:57:54 -06:00
Max Lyashuk
354c30c659 docs(installation): fix link to configuration.md (via #5009) 2018-11-12 15:32:24 +01:00
kyle
c6eb8edb5f feature: Docker OAuth block support (via #4987)
* add `onFound` callback to schemas
* add warning to method docs (for #4957)
* implement Docker OAuth2 init block support
* update docs
* add OAUTH_SCOPE_SEPARATOR
* drop OAuth env from Dockerfile and run script
* don't indent the first oauth block line
* drop unused `dedent` import
* touch up warning message
* add more test cases
* return an empty block if no OAuth content is generated
* fix broken doc line
2018-11-01 18:52:13 -04:00
kyle
31a8b13777 feature: full-spectrum runtime Docker configuration (via #4965)
* reorganize docker things

* Configurator WIP

* implement Docker runtime config generator

* add tests

* update documentation

* fix Markdown tables

* Move Docker section

* add note to README

* move up `nodejs` install for more aggressive caching

* drop exclusive test

* fix missing `DISPLAY_OPERATION_ID`
2018-11-01 14:53:29 -04:00
Ron
59a6a9b20f Added anchors to configuration parameters (#4711)
This allows referencing a configuration parameter directly when responding to tickets or from within the documentation.
2018-07-11 13:04:56 -05:00
Ron
98d6128375 Doc updates 2018-06-16 14:08:42 -06:00
kyle
bf77474a11 use HTTPS for Petstore by default (#4652) 2018-06-15 14:36:15 -07:00
Brett Randall
073b1df730 Updated 'urls' (An array of API definition objects) description. (#4525)
* Updated 'urls' (An array of API definition objects) description.

Updated 'urls' (An array of API definition objects) description to show an actual object array containing two (2) urls, clarifying this configuration-option.

* urls is an array, not a string
2018-05-07 21:56:08 -07:00
Helder Sepulveda
cbff0251ae feat: option to show common query parameters (#4245)
* extend getExtensions

Add optional param to getExtensions that can retrieve more stuff

* Add getCommonExtensions

* Trim trailing spaces

* Remove unused parameter

* Move the format inline with the param type

* correction to UnitTest
2018-04-26 21:18:45 -07:00
kyle
911a140e38 docs: add async interceptor documentation (#4418)
* docs: add async interceptor documentation

* Update configuration.md
2018-04-06 15:19:44 -07:00
kyle
b8cf080e6c docs: fix broken method table (#4340) 2018-03-16 22:34:54 -07:00
kyle
245428e7cd feat: preauthorization (#4339)
* feat: swagger 2.0 preauthorization methods
* tests: add cases for oas3 preauthorization
* docs: add new preauth docs; touch up existing auth docs
* tests: add `rootInject` tests
* docs: remove unfinished sentence
2018-03-16 22:25:04 -07:00
kyle
624a81201f feat: onComplete config option (#4322)
* feat: `onComplete` config option

* tests(e2e): add case for onComplete option
2018-03-16 00:08:39 -07:00
Scott O'Hara
f589cb99af feature: supportedSubmitMethods config parameter (#4186) 2018-02-09 19:39:43 -08:00
Mike Fidel
3f647875fd bug(docs) correct typo in installation.md (#4144) 2018-01-23 16:26:36 -08:00
Alexandre Barbier
31ccaf3ea3 Fix example 2018-01-15 12:07:29 +01:00
diegospd
024b7db81e fix(docs): correct tranditional typo (#4104) 2018-01-12 16:39:13 -06:00
kyle
15dbc20efd Merge branch 'master' into master 2017-12-15 18:22:07 -08:00
HelderSepu
28c706c70a Add defaultModelsExpandDepth
This change separates:
the Model (the one on the model-example section)
from
the Models (the ones at the bottom)
2017-12-08 21:12:41 -05:00
Martin Nowak
08b8f9c35a fix example integration 2017-12-08 13:22:25 +01:00
Abner Chen
112bca9065 fix link 2017-12-08 00:00:04 +08:00
Kyle Shockey
c68d1589ff Prepare revised documentation for merge 2017-12-05 18:46:10 -08:00
Kyle Shockey
55622b6105 Add required parameters 2017-12-05 15:24:19 -08:00
Kyle Shockey
1b926d834f Sort parameters alphabetically 2017-12-05 15:22:37 -08:00
Kyle Shockey
8a8ddd7c51 Touch up configuration docs 2017-12-05 15:17:01 -08:00
Kyle Shockey
ba605eb2ed Fix filter markdown 2017-12-05 15:14:49 -08:00
Kyle Shockey
07dac1b582 Add parameter type information 2017-12-05 15:13:19 -08:00
Kyle Shockey
2eba306698 Add plugin system documentation 2017-12-05 14:49:08 -08:00
Kyle Shockey
b7f4b23025 Segment configuration document 2017-12-05 14:44:37 -08:00
Kyle Shockey
d3e8875de0 Touch up swagger-ui-dist section 2017-12-04 23:01:22 -08:00
Kyle Shockey
675b3ff2f7 SwaggerUIBundle -> SwaggerUI 2017-12-04 23:00:26 -08:00
Kyle Shockey
84f4ec805e Reshuffle more documentation locations 2017-12-04 22:58:58 -08:00
Kyle Shockey
c6bc13c3f5 Add note about swagger-ui-dist 2017-12-04 21:46:47 -08:00
Kyle Shockey
b19af62e20 Move Docker section out of README, into installation.md 2017-12-04 21:40:10 -08:00
Kyle Shockey
930659d1d7 Fix some formatting issues in new documentation 2017-12-04 21:38:37 -08:00
Kyle Shockey
f546c0b342 Move OAuth2 docs 2017-12-04 21:25:48 -08:00
Kyle Shockey
4bf3b209be Move CORS documentation 2017-12-04 21:24:14 -08:00
Kyle Shockey
0fe17539e1 Add limitations.md 2017-12-04 20:58:53 -08:00
Kyle Shockey
9400c91820 Merge branch 'master' of github.com:swagger-api/swagger-ui into ft/docs 2017-12-04 20:38:09 -08:00
Kyle Shockey
0011b2a7e2 Development docs! 2017-10-06 17:13:30 -07:00
Kyle Shockey
24463652a5 Tremendous, beautiful plugin docs 2017-10-04 20:52:28 -07:00
Kyle Shockey
f6206d35fd Docs WIP 2017-10-04 18:39:13 -07:00