docs: clean up WIP sections for sequence page #2994
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
bajtos
reviewed
May 30, 2019
b-admike
force-pushed
the
docs/sequence-cleanup
branch
2 times, most recently
from
369b9e2 to
3c5628f
Compare
b-admike
commented
May 31, 2019
|
|
||
| - Try and use existing actions | ||
| - Implement your own version of built in actions | ||
| - Publish reusable actions to npm |
There was a problem hiding this comment.
see #3021 for Publish reusable actions to npm section.
b-admike
changed the title
nabdelgadir
approved these changes
May 31, 2019
b-admike
force-pushed
the
docs/sequence-cleanup
branch
3 times, most recently
from
58eabcd to
e954ef0
Compare
raymondfeng
approved these changes
May 31, 2019
b-admike
force-pushed
the
docs/sequence-cleanup
branch
2 times, most recently
from
141c450 to
1d1ad0d
Compare
jannyHou
reviewed
Jun 1, 2019
Good content!
docs/site/Sequence.md
Outdated
| argument is typically decorated by @param(). We've made multiple shortcuts | ||
| available to the `@param()` decorator in the form of | ||
| `@param.<http_source>.<OAI_primitive_type>`. Using this notation, query string | ||
| parameters can be described as `@param.query.<OAI_primitive_type>`. Here is an |
There was a problem hiding this comment.
typo? I think you mean @param.query.string =p
There was a problem hiding this comment.
Good catch :-). Fixed!
|
|
||
| You can also specify a parameter which is an object value encoded as a JSON | ||
| string or in multiple nested keys. For a JSON string, a sample value would be | ||
| `location={"lang": 23.414, "lat": -98.1515}`. For the same `location` object, it |
There was a problem hiding this comment.
A question: is it meant to be the string value get from the HTTP client?
If we are showing an example value from in the API explorer input field, probably wrap key&value with double quotes.
There was a problem hiding this comment.
Actually I took this straight from API explorer and I think they're not wrapped because we define lat/long as number values.
b-admike
force-pushed
the
docs/sequence-cleanup
branch
from
1d1ad0d to
634291b
Compare
Co-authored-by: Miroslav Bajtoš <[email protected]>
b-admike
force-pushed
the
docs/sequence-cleanup
branch
from
634291b to
2c63955
Compare
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.
Fixes #2100
Checklist
👉 Read and sign the CLA (Contributor License Agreement) 👈
npm testpasses on your machinepackages/cliwere updatedexamples/*were updated👉 Check out how to submit a PR 👈