Skip to content
This repository was archived by the owner on Sep 14, 2022. It is now read-only.

Commit 9ba5a26

Browse files
author
Kevin Lam
committed
fixed small typo
1 parent 93c3dcd commit 9ba5a26

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/configuration.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
** NOTE: The following applies to swagger-node apps replying on swagger-node-runner 0.5.x and better. (ie. Any app using swagger-connect 0.1.0, swagger-express-wm 0.1.0, swagger-hapi 0.1.0, swagger-restify 0.1.0, or swagger-sails 0.1.0 - or higher versions of the same.) **
44

5-
Swagger-Node application configuration is driven by the file `default.yaml` (by default) in the application's config directory. Configuration is driven by the [config](https://github.com/lorenwest/node-config/wiki/Configuration-Files) module, so reference its documentation to understand how you may set up configuration per environment and perform configuration overrides. By default, the configuration file looks something like this:
5+
Swagger-Node application configuration is driven by the file `default.yaml` (by default) in the application's config directory. Configuration is driven by the [config](https://github.com/lorenwest/node-config/wiki/Configuration-Files) module, so reference its documentation to understand how you may set up configuration per environment and perform configuration overrides. By default, the configuration file looks something like this:
66

77
```yaml
88
# swagger configuration file
@@ -63,7 +63,7 @@ If no pipe is explicitly declared for a path or operation, this pipe will be pla
6363

6464
### swaggerControllerPipe
6565

66-
This names the standard pipe that plays for the swagger-node controllers (declared in the swagger.yaml with the
66+
This names the standard pipe that plays for the swagger-node controllers (declared in the swagger.yaml with the
6767
extension `x-swagger-router-controller`). We'll look at how that's defined in a second.
6868

6969
### bagpipes
@@ -80,15 +80,15 @@ This configures the swagger validator (currently swagger-tools). You can turn re
8080

8181
#### swagger_controllers
8282

83-
Because this is specified as your controller pipe (in the `swaggerControllerPipe` setting above), this pipe plays for all paths and operations where you'veare specified a controller extension (`x-swagger-router-controller`).
83+
Because this is specified as your controller pipe (in the `swaggerControllerPipe` setting above), this pipe plays for all paths and operations where you've specified a controller extension (`x-swagger-router-controller`).
8484

8585
The default pipe is as follows:
8686

8787
1. set an error handler that converts all errors to JSON
8888
2. run the [cors](https://www.npmjs.com/package/cors) module
8989
3. execute swagger security (currently swagger-tools)
9090
4. run swagger validator (currently swagger-tools)
91-
5. add a few commonly used Express functions (if not already present) to request (path, query, get) and response (json,
91+
5. add a few commonly used Express functions (if not already present) to request (path, query, get) and response (json,
9292
get, set, status).
9393
6. run the router (currently swagger-tools)
9494

0 commit comments

Comments
 (0)