Commit Graph

110 Commits

Author SHA1 Message Date
Tim Lai
2373a83fe2 feat: remove node_native option from request snippets plugin (#7181)
* snippet generator support intended for different shell options only
* will not maintain snippet generator for various languages
2021-04-14 10:55:31 -07:00
Mahtis Michel
8405fa0101 feat: request snippets plugin (#6910) 2021-03-10 11:02:34 -08:00
Mahtis Michel
ba74c02951 feat(docs): sample datepicker plugin with json schema components (#6939)
* Document JSON schema components, its mappings and give example how to create a date picker for type: string format: date and format: date-time.
2021-02-16 16:39:26 -08:00
Kyle Hoskins
265bdc07b7 feat: add tryItOutEnabled configuration (#6865)
* feat: add tryItOutEnabled configuration

allow users to set tryItOutEnabled: true to display
the "Try it out" section by default

tryItOutEnabled to take === "true" for the
query string value or === true if someone
implements query string type parsing in the query
2021-01-26 09:00:38 -08:00
Amir Bitaraf Haghighi
a7ba55ad03 feat(docker): add docker support for persist authorization variable (#6832) 2021-01-13 13:23:44 -08:00
Eneko Alonso
5b70866f7c Improve documentation for Standalone plain HTML installation (#6605)
* Plain old HTML instructions

* Add sites for Standalone HTML installation
2020-11-18 19:18:39 -08:00
Shelby Sanders
6a4e52aadb feat: support for showExtensions on Response objects (#6535) 2020-10-21 18:49:39 -07:00
Adam Stachowicz
5fc43faef1 docs: update setting-up.md (#6492)
* Remove `npm install` from steps
2020-10-14 19:51:48 -07:00
Mahtis Michel
deeff4b42c docs(docker): add docker-compose env file configuration example (#6465) 2020-10-07 16:33:55 -07:00
Adam David
cbe99c8c1a feat(curl): configuration setting to pass additional options to curl command for "Try it out" (#6288)
Allows `requestInterceptor` to add options to the curl command.
For example:

```js
requestInterceptor: function (request) {
  if (request.method === 'GET') {
    request.curlOptions = ['-g']
    request.url = request.url
      .replace('%5B', '[')
      .replace('%5D', ']')
      .replace('%2C', ',');
  }
  return request;
}
```
2020-09-22 11:14:51 -07:00
Amir Bitaraf Haghighi
96aecc8860 feat: Preserve authorization on browser refresh and close/reopen (#5939)
* Add default configuration `preserveAuthorization`

* Add localStorage to auth plugin

* Add persistAuthorization unit tests

* Refactor persistAuthorization to use wrapped actions

* Upgrade unit tests to be compatible with jest

* Add persistAuthorization documentation


Co-authored-by: Tim Lai <timothy.lai@gmail.com>
2020-09-11 14:05:37 -07:00
Tim Lai
f79e45be71 chore: update .gitignore with dev-helpers/examples (#6373)
* docs: update setting-up.md with local dev
2020-09-09 17:30:14 -07:00
Tim Lai
1a27c0a8bd feat: migrate unit tests to Jest (#6353)
* config(jest): updated setup
* config(jest): update testMatch to include jsx files
* config(jest): add transformIgnorePatterns
* config(jest): update ignore files that do not work in jest yet
* config: add test:unit-jest to test script

* fix(jest): lint with eslint-plugin-jest

* refactor(jest): move unit test directory
* refactor(mocha): restore mocha tests that fail in jest

* docs(jest): update helpful scripts with test:unit-jest
2020-09-01 10:41:01 -07:00
PoojaChandak
959b48ad3d docs: various minor grammatical changes (#6284)
* Update README.md
* Update setting-up.md
* Update plug-points.md
* Update plugin-api.md
* Update configuration.md
* Update deep-linking.md
* Update installation.md


Co-authored-by: Tim Lai <timothy.lai@gmail.com>
2020-08-24 16:54:48 -07:00
Tim Lai
e1573527de docs(scripts): update building and testing scripts (#6298) 2020-08-13 19:53:16 -07:00
Irena Shaigorodsky
d7d166d0a4 fix: specify charset utf-8 in html script declaration (#6278)
ref: #5311
2020-07-31 16:51:17 -07:00
Helen Kosova
887563ab79 docs: Improve descriptions of syntaxHighlight parameters (#6242) 2020-07-28 16:46:25 -07:00
Tim Lai
a73783b73d feat: syntax highlighting of code section (#6236)
Co-authored-by: AdrieanKhisbe <adriean.khisbe@live.fr>
2020-07-17 15:29:15 -07:00
Tim Lai
b3fc05b3fe fix: prevent CI trigger from docs/samples/webpack-getting-started (#6145)
* README updated
* renamed package.json to _sample_package.json
* removed package-lock.json
2020-06-15 12:54:43 -07:00
Shaun Luttin
75a2b9a5cc Demonstrate a simple Webpack setup (#5185) 2020-06-15 11:20:08 -07:00
Vladimir Gorej
a616cb471d fix(Markdown): render markdown in more secure way
This commit changes markdown sanitization behaviour in following way:

class, style and data-* attributes are removed by default. These attributes
open possible vulnerability vectors to attackers.

The original behavior of sanitizer (before this commit) can be enabled by *useUnsafeMarkdown* configuration option.
Use this configuration option with caution and only in cases when you know
what you're doing.
2020-06-11 21:51:15 +02:00
Wesley Schwengle
117dcc9b16 Disable the validation badge for those who do not want it (#5994)
* disabled on string values: "127.0.0.1", "localhost", "none"
2020-06-10 15:31:35 -07:00
Matthew Morrissette
275c8f2ccf improvement: oauth "scopes" improvements (#6037)
* improvement: oauth "scopes" init parameter

* improvement: add "select all" and "select none" to oauth scopes popup
2020-06-10 11:27:54 -07:00
Tim Lai
ba953aaa91 docs: update plugin api component for failSilently (#5953) 2020-04-12 22:36:11 -04:00
Dina Berry
a2b37ec157 housekeeping: add static distribution file documentation (#5095)
Co-authored-by: kyle shockey <kyle.shockey1@gmail.com>
2020-03-08 21:40:04 -04:00
Tim Lai
67f9f8e1ba docs: update prerequisites for development (#5902) 2020-03-05 14:26:54 -08:00
Roman Soldatow
2dc499cddc housekeeping(docs): https path for unpkg link (#5769)
Co-authored-by: kyle shockey <kyleshockey@gmail.com>
2020-01-04 19:26:21 -05:00
poveilleux
139592e353 feat: add PKCE support for OAuth2 Authorization Code flows (#5361)
* Add PKCE support.

* Fix tests

* Update oauth2.md

* Rename usePkce

* Fix the BrokenComponent error

* Update oauth2.md

* Remove isCode variable. Remove uuid4 dependency.

* Remove utils functions

* Import crypto

* Fix tests

* Fix the tests

* Cleanup

* Fix code_challenge generation

* Move code challenge and verifier to utils for mocks. Update tests.

* Mock the PKCE methods in the utils file properly.

* Add missing expect

* use target-method spies

* Add comments to explain test values.

* Get rid of jsrsasign.
2019-10-07 17:24:43 -07:00
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