Commit Graph

132 Commits

Author SHA1 Message Date
kyle
8cabcffddf housekeeping: document Docker OAUTH2_REDIRECT_URL option (#5641) 2019-10-02 20:23:05 -07:00
Fergus McDowall
81cc06f4f8 housekeeping: change git clone URL (#5612)
When `git clone` -ing from github, `https` URLs are (as far as I know) functionally equivalent yet less error prone.
2019-09-26 19:47:29 -07:00
kyle
94c86d3d50 improvement: online.swagger.io -> validator.swagger.io (#5599) 2019-09-09 21:33:23 -07:00
Helen Kosova
43db164a91 docs: clarify that preauthorizeApiKey works for OAS3 Bearer auth too (via #5566) 2019-08-26 16:09:05 -07:00
Ryan Stephen
1b0efbeb16 Grammar syntax correction (#5512)
Tense correction and clarity on line 44.
2019-08-06 16:50:45 -06:00
Helen Kosova
8822a7229a Change Swagger-UI -> Swagger UI in docs (#5479)
* Change Swagger-UI -> Swagger UI in docs

* Changed back to SwaggerUI in places that refer to JS construct
2019-07-19 09:22:45 -06:00
kyle
be5e057bfa housekeeping: npm audit resolutions (via #5457)
* add `security-audit` script

* npm audit fix

* remove nyc

* nightwatch@1

this breaks the test suite, but it appears to have already regressed. leaving it for another day, TODO: open a backlog ticket

* add `security-audit` script

* disable mocha exclusivity

* update package-lock.json

* cypress@3.4.0

* `npm audit fix`

* @release-it/conventional-changelog@1.1.0

* release-it@12
2019-07-18 22:02:24 -05:00
Segev Finer
be72c292ca feature: add withCredentials configuration key (via #5149)
* Add the withCredentials configuration key

It enables passing credentials in CORS requests. e.g. Cookies and
Authorization headers.

* Improve withCredentials documentation

* Add unit tests for the withCredentials config

* Update configuration.md

* Update configuration.md

* only set `withCredentials` Fetch flag if the config value is truthy

there are some workarounds in the wild today that involve setting `withCredentials` on `system.fn.fetch` directly. 

this approach avoids mangling those existing workarounds!

* add more test cases

* Update configs-wrap-actions.js

* Update index.js
2019-03-20 12:36:08 -07:00
Drew Freyling
48e4fb937d housekeeping: losslessly crush PNG images with pingo (via #5158) 2019-02-06 22:11:04 -06:00
Ullrich Schäfer
615f0bf724 housekeeping(docs): typo in oauth2.md (via #5124)
no PR too small!
2019-01-15 18:14:20 -06:00
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
peng weikang
0eb591b78a Fix improper markdown (#4645)
escape `|`
2018-06-14 17:00:40 -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
Helder Sepulveda
d3c9ceceef Change the 5# to 4# (#4447)
The 5# do not show well on the wiki but 4# do and they were not used
2018-04-18 16:29:53 -07:00
Chris Ormerod
2bf2167a18 docs: fix typo (#4431)
Operations is lowercase, without this fix the example doesn't work as a Copy/Paste
2018-04-12 16:53:10 -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
kyle
83232dc2d8 v3.12.0 (#4282)
* Use `parameterWithMeta` to get parameter data in <ParameterRow>

* Prefer specPath when fetching resolved subtrees in OperationContainer

* Add test for OAS3 callback rendering

* Remove debugger statement

* Pass base resolution URL directly to Swagger-Client subtree resolver

* Remove accidental comment

* Migrate additional options

* Don't default to empty Map when getting subtree

* fix(validateParam): check for ImList type before using count method

* Use `replaceState` to update `urls.primaryName`

This gives us the stateful URL we want, without:
(a) refreshing the page on update
(b) creating a long, useless history for the user
(c) implying that browser history is two-way bound
    to Swagger-UI (it isn't, we don't have a router)

* Add `fn.opsFilter` docs and internal API versioning note

* restrict `x-example` functionality to Swagger 2.0

* polish Authorize + Close buttons

* add tachyons; use it for padding the new Reset button

* v3.12.0

* rebuild dist
2018-03-02 21:13:00 -08:00
Swaroop Hegde
ba59db2449 Fix Summary links 2018-02-13 18:08:11 +05:30
Scott O'Hara
f589cb99af feature: supportedSubmitMethods config parameter (#4186) 2018-02-09 19:39:43 -08:00
kyle
7fd229fe72 improve(docs): use computed key to demonstrate statePlugin namespacing (#4193) 2018-02-05 15:22:12 -08:00
Rafael Lüder
6110a7da12 fix(docs): typos! (#4148) 2018-01-24 16:44:46 -08:00
Mike Fidel
3f647875fd bug(docs) correct typo in installation.md (#4144) 2018-01-23 16:26:36 -08:00
Can Taşdemir
c28213d457 fix(docs): correct plugin api typo (#4138) 2018-01-19 10:53:06 -06: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
8f3535b5ff Merge branch 'master' into zopflipng 2018-01-03 18:55:00 -06:00
Kyle Shockey
56caeec8c8 Add documentation for rootInjects interface 2017-12-28 16:44:20 -06:00
Kyle Shockey
9d48c4751a Refactor afterLoad interface to expose raw plugin context 2017-12-28 16:26:18 -06:00
Kyle Shockey
022b660b8c Merge branch 'master' into support/editor-validation-refactor 2017-12-19 23:29:59 -06:00
Ville Skyttä
8c4b511227 Run *.png through zopflipng -m 2017-12-16 22:42:14 +02:00
kyle
15dbc20efd Merge branch 'master' into master 2017-12-15 18:22:07 -08:00
Kyle Shockey
c1ae4c133d Add afterLoad plugin interface 2017-12-14 21:01:37 -08:00
kyle
9147d2eac2 Merge branch 'master' into ft/docs 2017-12-12 15:49:23 -08:00
kyle
a9ee23413d Merge branch 'master' into ft/docs 2017-12-12 14:34:27 -08:00
kyle
9a7ef85aa4 Clarify wrapComponent interface in Plugin API docs 2017-12-12 14:33:41 -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
c23b884d9a Add script documentation to development docs 2017-12-05 20:33:28 -08:00