Documentation obromios #387
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
added 5 commits
July 30, 2018 14:30
The gemfile had gem 'raddocs', :github => "smartlogic/raddocs" which loads over http not https so is insecure.
At present, only option is :open_api, but this does not produce output that is easily readable by user. When the problem with the :json option is fixed see issue zipmark#382 I suggest that :json option is added as well, users can see output using raddocs.
This has been altered to take out any open_api code. Given there is only one example spec in the README document, my view is that it should not be specifically open_api, but just use the most general options. I have bumped the level of this section up by two levels, as it no longer fits under the open_api section of the format section. I have also taken out or re-factored instances of <response>, given I could not understand what the code did in this instance. I note that the example code in the repository is open_api, so there is already an example of open_api code.
to indicated that it uses the :open_api format
oestrich
reviewed
Jul 31, 2018
README.md
Outdated
| @@ -307,21 +320,18 @@ paths: | |||
| hide: true | |||
| ``` | |||
|
|
|||
| #### Example of spec file | |||
| ## Example of acceptance spec file | |||
There was a problem hiding this comment.
This line is specifically an example for the openapi stuff - so I'd leave it as is and then make a more generic section.
added 2 commits
July 31, 2018 14:27
Put back open_api example spec in same place but labelled it clearly as being open_api specific. Moved generic example of spec up in document.
|
Thanks! |
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.
This is a pull request that tries to resolve some of the documentation issues raised issue #386. The git log explains the changes.