Ability to include an external file as overview section. #62
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
|
In addition, I've forked dingo/api repo and added artisan command support for adding an overview section. If required can create a pull request for this too. |
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.
Adds functionality to include a file (in API blueprint format) to be displayed at the top of the generated blueprint, under the title.
Additionally, the following changes can be made to the dingo/api Docs artisan command to allow cli generation that includes the overview, e.g.
php artisan api:docs --output-file blueprint.apib --overview-file=docs/overview.apibThese changes are reflected here:
Docs.php.txt
This is just one possible solution for #59 (Probably the most simplistic work around).