Fix API blueprint documentation #373
Merged
Conversation
This file contains hidden or 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
- Headers and Body sections were indented with 8 spaces instead of 12 (https://github.com/apiaryio/api-blueprint/blob/format-1A/API%20Blueprint%20Specification.md#ActionResponseSection) - The API name was not present (https://github.com/apiaryio/api-blueprint/blob/format-1A/API%20Blueprint%20Specification.md#42-api-name--overview-section)
- Path segments extensions were not following the RFC 6570
- Switch from path segment expansion to simple string expansion because the former is not supported by Apiary
This let spec successfully passed.
- Remove Content-Type header from the Header sections
joel
changed the title
|
Thanks! |
jandudulski
pushed a commit
to jandudulski/rspec_api_documentation
that referenced
this pull request
May 9, 2018
Fix API blueprint documentation
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 API Blueprint generated is wrong and don't work on https://app.apiary.io this PR aim to fix that.
This is the minimum changes to make https://app.apiary.io happy.
This PR is based on the work of
Fabien Chaynes @FabienChaynes FinalCAD#1 and Steven Vandevelde @icidasset FinalCAD#2
They did more, but I think it should be part of another PR.
Please consider those changes.
Thanks