[feat/cli] commented config #633
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
thibaultcha
added
pr/ready (but hold merge)
thibaultcha
force-pushed
the
feat/commented-config
branch
2 times, most recently
from
4ce01f7 to
303e235
Compare
All options are now commented, and commented out, as the default value now applies from the config_loader. The unit test against the config file iw now obsolete.
DAO properties are no nested in `properties` property anymore.
thibaultcha
added
pr/ready (but hold merge)
thibaultcha
added a commit
that referenced
this pull request
Oct 16, 2015
[feat/cli] commented config
|
@Mashape/kong |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reopening of #596.
This finally approaches parts of #92 (now #629): Configuration documentation, validation and proper defaults.
Commented config file
The configuration file is now fully commented out (preview). Each property is commented and can be uncommented and changed if the user does not want the default to apply. The configuration file is now closer to unix-like configuration files. Reviews of the comments (both content and layout) are much appreciated.
Enforced rules and defaults
Secondly, the configuration defaults and rules are now stored in a
config_defaults.luafile, and Kong will stop the execution of a comment is the file contains invalid properties (wrong type, incorrect value, etc...)This is what it looks like if a string is given in place of a port number for
admin_api_port:Again, reviews of both rules and defaults are much appreciated.