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

Improved documentation formatting for Configuration page #532

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+1 −1
Open

Improved documentation formatting for Configuration page #532

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Configuration

** 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-mw 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.) **
**N.B. The following applies to `swagger-node` apps relying on [`swagger-node-runner`](theganyo/swagger-node-runner) 0.5.x and better. (I.e. Any app using [`swagger-connect`](apigee-127/swagger-connect) 0.1.0+, [`swagger-express-mw`](apigee-127/swagger-express) 0.1.0+, [`swagger-hapi`](https://github.com/apigee-127/swagger-hapi) 0.1.0+, [`swagger-restify`](yourdelivery/swagger-restify) 0.1.0+, or [`swagger-sails`](apigee-127/swagger-sails) 0.1.0+)**

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:

Expand Down