String, in which case filtering will be enabled using that string as Can be Boolean to enable or disable, or a Top bar will show an edit box that you can use to filter the tagged (expands only the tags), 'full' (expands the tags and operations) orīoolean=false OR String. Controls the defaultĮxpansion setting for the operations and tags. Controls the display of the requestĭuration (in milliseconds) for "Try it out" requests. The rendering for a given model by clicking the 'Model' and 'Exampleīoolean=false. The default expansion depth for the model on The default expansion depth for models (set legacy (default) : last plugin takes precedence over the others - chain : chain wrapComponents when targeting the same core component, allowing multiple plugins to wrap the same componentĭeep linking for tags and operations. Control behavior of plugins when targeting the same component with wrapComponent. Usually, you'll want to include ApisPreset if you use this option. An array of presets to use in Swagger UI.
An array of plugin functions to use in Swagger UI.Īrray=. A Javascript object to configure plugin integration and behaviors (see below).Īrray=. The name of a component available via the plugin system to use as the top-level layout for Swagger UI. Read more about the plugin system in the Customization documentation. Enables overriding configuration parameters via URL search params. 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.īoolean=false. When using urls, you can use this subparameter. Names and URLs must be unique among all items in this array, since they're used as identifiers. When used and Topbar plugin is enabled, the url parameter will not be parsed. configuration object passed as an argument to Swagger UI ( SwaggerUI(]) used by Topbar plugin.The swagger-config.yaml in the project root directory, if it exists, is baked into the application.I want to add Markdown to either of the two places in the Model section.Swagger UI accepts configuration parameters in four locations. The schema object documentation says that I should be able to use Markdown in the place marked as (4) above but doesn't say anything about place (5). Here is a minimal dummy example of the problem: swagger: '2.0'ĭescription: (1) This is the API description containing some *rich* **text**ĭescription: (2) This is the path description also containing some *rich* **text**ĭescription: (3) This is a response description also containing some *rich* **text**ĭescription: (4) This is a model description where *rich* **text** does not workĭescription: (5) This is a field description where *rich* **text** does not work The documentation says that GFM syntax can be used in description fields but this is not working in all places. I am trying to add extra information to model items in Swagger.
0 kommentar(er)
