diff --git a/docs/usage/configuration.md b/docs/usage/configuration.md index 4b11bd37..8747c438 100644 --- a/docs/usage/configuration.md +++ b/docs/usage/configuration.md @@ -26,8 +26,8 @@ Type notations are formatted like so: Parameter Name | Description --- | --- `configUrl` | `String`. URL to fetch external configuration document from. -`dom_id` |`String`. The id of a dom element inside which SwaggerUi will put the user interface for swagger. -`domNode` | `Element`. The HTML DOM element inside which SwaggerUi will put the user interface for swagger. Overrides `dom_id`. +`dom_id` |`String`, **REQUIRED** if `domNode` is not provided. The id of a dom element inside which SwaggerUi will put the user interface for swagger. +`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.