From 416d41402fd55a2c02b793abd6748336fd15973a Mon Sep 17 00:00:00 2001 From: Jesse Mandel Date: Thu, 22 Jun 2017 14:33:20 -0700 Subject: [PATCH] Update README.md Added message about `urls` and `spec` taking precedence over `url` --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f0f23029..8c4322fc 100644 --- a/README.md +++ b/README.md @@ -128,7 +128,7 @@ If you'd like to use the bundle files via npm, check out the [`swagger-ui-dist` Parameter Name | Description --- | --- -url | The url pointing to API definition (normally `swagger.json` or `swagger.yaml`). +url | The url pointing to API definition (normally `swagger.json` or `swagger.yaml`). Will be ignored if `urls` or `spec` is used. urls | An array of API definition objects (`{url: "", name: ""}`) used by Topbar plugin. When used and Topbar plugin is enabled, the `url` parameter will not be parsed. spec | A JSON object describing the OpenAPI Specification. When used, the `url` parameter will not be parsed. This is useful for testing manually-generated specifications without hosting them. validatorUrl | By default, Swagger-UI attempts to validate specs against swagger.io's online validator. You can use this parameter to set a different validator URL, for example for locally deployed validators ([Validator Badge](https://github.com/swagger-api/validator-badge)). Setting it to `null` will disable validation.