This repository has been archived by the owner on Dec 20, 2021. It is now read-only.
doc: add clarity to spec definition in README #21
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
README.md
Outdated
| > Note: Currently, the order of API definitions matters. See this as an example : | ||
| > ```raml | ||
| > /item/{itemId} | ||
| > /item/archive |
There was a problem hiding this comment.
I would add a working example, specify that this is a best practice and warn about the side effect if not applied.
There was a problem hiding this comment.
Thanks, I've rephrased it to emphasis good practice.
MeroveeCharrue
force-pushed
the
apispec-description-order
branch
from
0d3abca
to
83490c8
Compare
|
@yannickroger good for you too? |
|
@RETFU 👍 |
yannickroger
approved these changes
Apr 19, 2019
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 note in the doc to prevent potential known issues when declaring endpoints to match routes.