From d3bfd25229dc3eadaaf900c13a287951deb5f39a Mon Sep 17 00:00:00 2001 From: Brett Randall Date: Mon, 7 May 2018 15:04:04 +1000 Subject: [PATCH 1/2] 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. --- docs/usage/configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/usage/configuration.md b/docs/usage/configuration.md index 98515fe95bf..f765cc74eaf 100644 --- a/docs/usage/configuration.md +++ b/docs/usage/configuration.md @@ -30,7 +30,7 @@ Parameter Name | Description `domNode` | `Element`, **REQUIRED** if `dom_id` is not provided. The HTML DOM element inside which SwaggerUi will put the user interface for swagger. Overrides `dom_id`. `spec` | `Object={}`. A JS 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. `url` | `String`. The url pointing to API definition (normally `swagger.json` or `swagger.yaml`). Will be ignored if `urls` or `spec` is used. -`urls` | `String`. 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. Names and URLs must be unique among all items in this array, since they're used as identifiers. +`urls` | `String`. An array of API definition objects (`[{url: "", name: ""},{url: "", name: ""}]`) used by Topbar plugin. When used and Topbar plugin is enabled, the `url` parameter will not be parsed. Names and URLs must be unique among all items in this array, since they're used as identifiers. `urls.primaryName` | `String`. When using `urls`, you can use this subparameter. If the value matches the name of a spec provided in `urls`, that spec will be displayed when Swagger-UI loads, instead of defaulting to the first spec in `urls`. ##### Plugin system From 57788649007439954509b02c3fc6753eb94b81ab Mon Sep 17 00:00:00 2001 From: kyle Date: Mon, 7 May 2018 21:34:56 -0700 Subject: [PATCH 2/2] urls is an array, not a string --- docs/usage/configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/usage/configuration.md b/docs/usage/configuration.md index f765cc74eaf..8361a90a9a8 100644 --- a/docs/usage/configuration.md +++ b/docs/usage/configuration.md @@ -30,7 +30,7 @@ Parameter Name | Description `domNode` | `Element`, **REQUIRED** if `dom_id` is not provided. The HTML DOM element inside which SwaggerUi will put the user interface for swagger. Overrides `dom_id`. `spec` | `Object={}`. A JS 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. `url` | `String`. The url pointing to API definition (normally `swagger.json` or `swagger.yaml`). Will be ignored if `urls` or `spec` is used. -`urls` | `String`. An array of API definition objects (`[{url: "", name: ""},{url: "", name: ""}]`) used by Topbar plugin. When used and Topbar plugin is enabled, the `url` parameter will not be parsed. Names and URLs must be unique among all items in this array, since they're used as identifiers. +`urls` | `Array`. An array of API definition objects (`[{url: "", name: ""},{url: "", name: ""}]`) used by Topbar plugin. When used and Topbar plugin is enabled, the `url` parameter will not be parsed. Names and URLs must be unique among all items in this array, since they're used as identifiers. `urls.primaryName` | `String`. When using `urls`, you can use this subparameter. If the value matches the name of a spec provided in `urls`, that spec will be displayed when Swagger-UI loads, instead of defaulting to the first spec in `urls`. ##### Plugin system