Add api metadata yaml support for auto documentation tools #8
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
added 2 commits
February 17, 2014 11:05
… be read by auto documentation fields.
| @@ -73,6 +73,16 @@ This is required to have maven build a "fat," executable jar file. | |||
|
|
|||
| # dropwizard-spring sample service configuration | |||
|
|
|||
| # High level information that describes the application. This can be pulled into auto documentation tools like Swagger. | |||
| apiMetadata: | |||
| rootServerName: www.someshop.zzz | |||
There was a problem hiding this comment.
Please use standard www.example.com
|
example.com fixes, otherwise LGTM |
|
Agreed. LGTM aside from the notes from @bflad |
|
Agree, updating to example.com |
added 2 commits
February 17, 2014 13:21
…s optional (i.e. doesn't break backwards compatibility)
pabrahamsson
added a commit
that referenced
this pull request
Feb 20, 2014
…or_auto_documentation_tools Add api metadata yaml support for auto documentation tools
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.
The added YAML fields are optional and can be used to help document the Dropwizard Spring application.