kyy/swagger-ui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: various minor grammatical changes (#6284)

Browse Source 
* 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>
This commit is contained in:
PoojaChandak
2020-08-25 05:24:48 +05:30
committed by GitHub
parent 580e906450
commit 959b48ad3d
6 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/usage/deep-linking.md
View File

@@ -9,7 +9,7 @@ Swagger UI allows you to deeply link into tags and operations within a spec. Whe
When you expand a tag or operation, Swagger UI will automatically update its URL fragment with a deep link to the item.
Conversely, when you collapse a tag or operation, Swagger UI will clear the URL fragment.
You can also right-click a tag name or operation path in order to copy a link to that tag or operation.
You can also right-click a tag name or operation path to copy a link to that tag or operation.
#### Fragment format
@@ -19,7 +19,7 @@ The fragment is formatted in one of two ways:
- `#/{tagName}/{operationId}`, to trigger the focus of a specific operation within a tag
`operationId` is the explicit operationId provided in the spec, if one exists.
Otherwise, Swagger UI generates an implicit operationId by combining the operation's path and method, and escaping non-alphanumeric characters.
Otherwise, Swagger UI generates an implicit operationId by combining the operation's path and method, while escaping non-alphanumeric characters.
## FAQ

4
docs/usage/installation.md
View File

@@ -10,7 +10,7 @@ We publish two modules to npm: **`swagger-ui`** and **`swagger-ui-dist`**.
```javascript
import SwaggerUI from 'swagger-ui'
// or use require, if you prefer
// or use require if you prefer
const SwaggerUI = require('swagger-ui')
SwaggerUI({
@@ -25,7 +25,7 @@ In contrast, **`swagger-ui-dist`** is meant for server-side projects that need a
_Note: we suggest using `swagger-ui` when your tooling makes it possible, as `swagger-ui-dist`
will result in more code going across the wire._
The module's contents mirrors the `dist` folder you see in the Git repository. The most useful file is `swagger-ui-bundle.js`, which is a build of Swagger UI that includes all the code it needs to run in one file. The folder also has an `index.html` asset, to make it easy to serve Swagger UI like so:
The module's contents mirror the `dist` folder you see in the Git repository. The most useful file is `swagger-ui-bundle.js`, which is a build of Swagger UI that includes all the code it needs to run in one file. The folder also has an `index.html` asset, to make it easy to serve Swagger UI like so:
```javascript
const express = require('express')