Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: clean up WIP sections for sequence page #2994

Merged
merged 1 commit into from Jun 1, 2019

Conversation

Projects
None yet
5 participants
@b-admike
Copy link
Member

commented May 29, 2019

Fixes #2100

Checklist

馃憠 Read and sign the CLA (Contributor License Agreement) 馃憟

  • npm test passes on your machine
  • New tests added or existing tests modified to cover all changes
  • Code conforms with the style guide
  • API Documentation in code was updated
  • Documentation in /docs/site was updated
  • Affected artifact templates in packages/cli were updated
  • Affected example projects in examples/* were updated

馃憠 Check out how to submit a PR 馃憟

@b-admike b-admike force-pushed the docs/sequence-cleanup branch 2 times, most recently from 369b9e2 to 3c5628f May 31, 2019

@b-admike b-admike marked this pull request as ready for review May 31, 2019

@b-admike b-admike requested a review from raymondfeng as a code owner May 31, 2019


- Try and use existing actions
- Implement your own version of built in actions
- Publish reusable actions to npm

This comment has been minimized.

Copy link
@b-admike

b-admike May 31, 2019

Author Member

see #3021 for Publish reusable actions to npm section.

@b-admike b-admike changed the title docs: add query string section for sequences docs: clean up WIP sections for sequence page May 31, 2019

@nabdelgadir
Copy link
Contributor

left a comment

LGTM 馃憤

Nitpick: can you un-indent the code blocks? (feel free to ignore)

Show resolved Hide resolved docs/site/Sequence.md Outdated

@b-admike b-admike force-pushed the docs/sequence-cleanup branch 3 times, most recently from 58eabcd to e954ef0 May 31, 2019

@b-admike b-admike force-pushed the docs/sequence-cleanup branch 2 times, most recently from 141c450 to 1d1ad0d May 31, 2019

@b-admike b-admike self-assigned this Jun 1, 2019

@jannyHou
Copy link
Contributor

left a comment

@b-admike A few nitpicks otherwise LGTM :shipit: Good content!

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

This comment has been minimized.

Copy link
@jannyHou

jannyHou Jun 1, 2019

Contributor

typo? I think you mean @param.query.string =p

This comment has been minimized.

Copy link
@b-admike

b-admike Jun 1, 2019

Author Member

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

This comment has been minimized.

Copy link
@jannyHou

jannyHou Jun 1, 2019

Contributor

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.

This comment has been minimized.

Copy link
@b-admike

b-admike Jun 1, 2019

Author Member

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 b-admike force-pushed the docs/sequence-cleanup branch from 1d1ad0d to 634291b Jun 1, 2019

docs: clean up WIP sections for sequence page
Co-authored-by: Miroslav Bajto拧 <mbajtoss@gmail.com>

@b-admike b-admike force-pushed the docs/sequence-cleanup branch from 634291b to 2c63955 Jun 1, 2019

@b-admike b-admike merged commit 1f5f1e2 into master Jun 1, 2019

3 checks passed

clahub All contributors have signed the Contributor License Agreement.
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@delete-merged-branch delete-merged-branch bot deleted the docs/sequence-cleanup branch Jun 1, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can鈥檛 perform that action at this time.