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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Client API Config document #1783

Merged
merged 9 commits into from
Sep 26, 2022
Merged

Conversation

vankichi
Copy link
Contributor

@vankichi vankichi commented Sep 5, 2022

Description:

I have created the document about client API configuration.

  • Insert / Update / Upsert / Search / Remove

And, remove docs/user-guides/search-config.

Related Issue:

How Has This Been Tested?:

Environment:

  • Go Version: 1.18.3
  • Docker Version: 20.10.8
  • Kubernetes Version: 1.22.0
  • NGT Version: 1.14.7

Types of changes:

  • Bug fix [type/bug]
  • New feature [type/feature]
  • Add tests [type/test]
  • Security related changes [type/security]
  • Add documents [type/documentation]
  • Refactoring [type/refactoring]
  • Update dependencies [type/dependency]
  • Update benchmarks and performances [type/bench]
  • Update CI [type/ci]

Changes to Core Features:

  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your core changes, as applicable?
  • Have you successfully ran tests with your changes locally?

Checklist:

  • I have read the CONTRIBUTING document.
  • I have checked open Pull Requests for the similar feature or fixes?
  • I have added tests and benchmarks to cover my changes.
  • I have ensured all new and existing tests passed.
  • I have commented my code, particularly in hard-to-understand areas
  • I have updated the documentation accordingly.

Signed-off-by: vankichi <kyukawa315@gmail.com>
Signed-off-by: vankichi <kyukawa315@gmail.com>
Signed-off-by: vankichi <kyukawa315@gmail.com>
@vdaas-ci
Copy link
Collaborator

vdaas-ci commented Sep 5, 2022

[CHATOPS:HELP] ChatOps commands.

  • 🙆‍♀️ /approve - approve
  • 💌 /changelog - replace the PR body by changelog details
  • 🍱 /format - format codes and add licenses
  • /gen-test - generate test codes
  • 🏷️ /label - add labels
  • /rebase - rebase main
  • 🔚 2️⃣ 🔚 /label actions/e2e-deploy - run E2E deploy & integration test

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

LanguageTool

docs/user-guides/client-api-config.md|264 col 2| This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Int64
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING
docs/user-guides/client-api-config.md|281 col 1| This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Func
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING
docs/user-guides/client-api-config.md|291 col 14| Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: client
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC
docs/user-guides/client-api-config.md|298 col 14| Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: vector
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC
docs/user-guides/client-api-config.md|320 col 12| Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1 Category: PUNCTUATION [docs/user-guides/client-api-config.md|336 col 3|](http://github.com/vdaas/vald/blob/05131d4e29da1ce70b22e12a7320dccfd9779e77/docs/user-guides/client-api-config.md#L336) It seems you either mean “if it”, “it” or there is a comma missing: “it, it”. (IT_IT[2]) Suggestions: `If it`, `It`, `It, it` Rule: https://community.languagetool.org/rule/show/IT_IT?lang=en-US&subId=2 Category: GRAMMAR [docs/user-guides/client-api-config.md|338 col 3|](http://github.com/vdaas/vald/blob/05131d4e29da1ce70b22e12a7320dccfd9779e77/docs/user-guides/client-api-config.md#L338) Consider using “all above” or “all of the above”. (ALL_MOST_SOME_OF_NOUN[1]) Suggestions: `all above`, `all of the above` URL: http://www.myhappyenglish.com/free-english-lesson/2013/05/22/english-grammar-lesson-all-some-most-vs-all-of-some-of-most-of/ Rule: https://community.languagetool.org/rule/show/ALL_MOST_SOME_OF_NOUN?lang=en-US&subId=1 Category: GRAMMAR [docs/user-guides/client-api-config.md|348 col 28|](http://github.com/vdaas/vald/blob/05131d4e29da1ce70b22e12a7320dccfd9779e77/docs/user-guides/client-api-config.md#L348) This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Suggestions: `Message` Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US Category: CASING [docs/user-guides/client-api-config.md|352 col 2|](http://github.com/vdaas/vald/blob/05131d4e29da1ce70b22e12a7320dccfd9779e77/docs/user-guides/client-api-config.md#L352) This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Suggestions: `Message` Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US Category: CASING [docs/user-guides/client-api-config.md|354 col 4|](http://github.com/vdaas/vald/blob/05131d4e29da1ce70b22e12a7320dccfd9779e77/docs/user-guides/client-api-config.md#L354) This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Suggestions: `String` Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US Category: CASING [docs/user-guides/client-api-config.md|356 col 4|](http://github.com/vdaas/vald/blob/05131d4e29da1ce70b22e12a7320dccfd9779e77/docs/user-guides/client-api-config.md#L356) This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Suggestions: `Uint32` Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US Category: CASING [docs/user-guides/client-api-config.md|360 col 2|](http://github.com/vdaas/vald/blob/05131d4e29da1ce70b22e12a7320dccfd9779e77/docs/user-guides/client-api-config.md#L360) This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Suggestions: `Message` Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US Category: CASING [docs/user-guides/client-api-config.md|362 col 4|](http://github.com/vdaas/vald/blob/05131d4e29da1ce70b22e12a7320dccfd9779e77/docs/user-guides/client-api-config.md#L362) This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Suggestions: `Repeated` Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US Category: CASING [docs/user-guides/client-api-config.md|386 col 93|](http://github.com/vdaas/vald/blob/05131d4e29da1ce70b22e12a7320dccfd9779e77/docs/user-guides/client-api-config.md#L386) This abbreviation for “identification” is spelled all-uppercase. (ID_CASING[2]) Suggestions: `ID` Rule: https://community.languagetool.org/rule/show/ID_CASING?lang=en-US&subId=2 Category: CASING [docs/user-guides/client-api-config.md|387 col 9|](http://github.com/vdaas/vald/blob/05131d4e29da1ce70b22e12a7320dccfd9779e77/docs/user-guides/client-api-config.md#L387) This abbreviation for “identification” is spelled all-uppercase. (ID_CASING[2]) Suggestions: `ID` Rule: https://community.languagetool.org/rule/show/ID_CASING?lang=en-US&subId=2 Category: CASING [docs/user-guides/client-api-config.md|397 col 74|](http://github.com/vdaas/vald/blob/05131d4e29da1ce70b22e12a7320dccfd9779e77/docs/user-guides/client-api-config.md#L397) This abbreviation for “identification” is spelled all-uppercase. (ID_CASING[2]) Suggestions: `ID` Rule: https://community.languagetool.org/rule/show/ID_CASING?lang=en-US&subId=2 Category: CASING [docs/user-guides/client-api-config.md|398 col 9|](http://github.com/vdaas/vald/blob/05131d4e29da1ce70b22e12a7320dccfd9779e77/docs/user-guides/client-api-config.md#L398) This abbreviation for “identification” is spelled all-uppercase. (ID_CASING[2]) Suggestions: `ID` Rule: https://community.languagetool.org/rule/show/ID_CASING?lang=en-US&subId=2 Category: CASING [docs/user-guides/client-api-config.md|410 col 35|](http://github.com/vdaas/vald/blob/05131d4e29da1ce70b22e12a7320dccfd9779e77/docs/user-guides/client-api-config.md#L410) This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Suggestions: `Message` Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US Category: CASING [docs/user-guides/client-api-config.md|413 col 2|](http://github.com/vdaas/vald/blob/05131d4e29da1ce70b22e12a7320dccfd9779e77/docs/user-guides/client-api-config.md#L413) This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Suggestions: `String` Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US Category: CASING [docs/user-guides/client-api-config.md|415 col 2|](http://github.com/vdaas/vald/blob/05131d4e29da1ce70b22e12a7320dccfd9779e77/docs/user-guides/client-api-config.md#L415) This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Suggestions: `Uint32` Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US Category: CASING [docs/user-guides/client-api-config.md|417 col 2|](http://github.com/vdaas/vald/blob/05131d4e29da1ce70b22e12a7320dccfd9779e77/docs/user-guides/client-api-config.md#L417) This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Suggestions: `Float` Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US Category: CASING [docs/user-guides/client-api-config.md|419 col 2|](http://github.com/vdaas/vald/blob/05131d4e29da1ce70b22e12a7320dccfd9779e77/docs/user-guides/client-api-config.md#L419) This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Suggestions: `Float` Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US Category: CASING [docs/user-guides/client-api-config.md|421 col 2|](http://github.com/vdaas/vald/blob/05131d4e29da1ce70b22e12a7320dccfd9779e77/docs/user-guides/client-api-config.md#L421) This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Suggestions: `Int64` Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US Category: CASING [docs/user-guides/client-api-config.md|427 col 2|](http://github.com/vdaas/vald/blob/05131d4e29da1ce70b22e12a7320dccfd9779e77/docs/user-guides/client-api-config.md#L427) This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Suggestions: `Uint32` Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US Category: CASING [docs/user-guides/client-api-config.md|444 col 1|](http://github.com/vdaas/vald/blob/05131d4e29da1ce70b22e12a7320dccfd9779e77/docs/user-guides/client-api-config.md#L444) This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Suggestions: `Func` Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US Category: CASING [docs/user-guides/client-api-config.md|454 col 14|](http://github.com/vdaas/vald/blob/05131d4e29da1ce70b22e12a7320dccfd9779e77/docs/user-guides/client-api-config.md#L454) Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE) Suggestions: `client` Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US Category: MISC [docs/user-guides/client-api-config.md|459 col 11|](http://github.com/vdaas/vald/blob/05131d4e29da1ce70b22e12a7320dccfd9779e77/docs/user-guides/client-api-config.md#L459) Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE) Suggestions: `vector` Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US Category: MISC [docs/user-guides/client-api-config.md|467 col 9|](http://github.com/vdaas/vald/blob/05131d4e29da1ce70b22e12a7320dccfd9779e77/docs/user-guides/client-api-config.md#L467) After ‘It’, use the third-person verb form “prevents”. (IT_VBZ[1]) Suggestions: `prevents` Rule: https://community.languagetool.org/rule/show/IT_VBZ?lang=en-US&subId=1 Category: GRAMMAR [docs/user-guides/client-api-config.md|494 col 1|](http://github.com/vdaas/vald/blob/05131d4e29da1ce70b22e12a7320dccfd9779e77/docs/user-guides/client-api-config.md#L494) This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Suggestions: `If` Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US Category: CASING [docs/user-guides/client-api-config.md|497 col 5|](http://github.com/vdaas/vald/blob/05131d4e29da1ce70b22e12a7320dccfd9779e77/docs/user-guides/client-api-config.md#L497) Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1]) Suggestions:
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION
docs/user-guides/client-api-config.md|506 col 31| This abbreviation for “identification” is spelled all-uppercase. (ID_CASING[2])
Suggestions: ID
Rule: https://community.languagetool.org/rule/show/ID_CASING?lang=en-US&subId=2
Category: CASING
docs/user-guides/client-api-config.md|544 col 28| This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Message
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING
docs/user-guides/client-api-config.md|548 col 2| This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Message
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING
docs/user-guides/client-api-config.md|550 col 4| This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: String
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING
docs/user-guides/client-api-config.md|552 col 4| This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Uint32
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING
docs/user-guides/client-api-config.md|556 col 2| This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Message
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING
docs/user-guides/client-api-config.md|558 col 4| This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Repeated
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING
docs/user-guides/client-api-config.md|569 col 28| This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Message
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING
docs/user-guides/client-api-config.md|573 col 2| This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Message
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING
docs/user-guides/client-api-config.md|575 col 4| This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: String
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING
docs/user-guides/client-api-config.md|577 col 4| This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Uint32
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING
docs/user-guides/client-api-config.md|581 col 2| This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Message
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING
docs/user-guides/client-api-config.md|583 col 4| This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Repeated
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING
docs/user-guides/client-api-config.md|604 col 35| This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Message
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING
docs/user-guides/client-api-config.md|607 col 2| This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Bool
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING
docs/user-guides/client-api-config.md|609 col 2| This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Int64
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING
docs/user-guides/client-api-config.md|626 col 1| This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Func
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING
docs/user-guides/client-api-config.md|636 col 14| Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: client
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC
docs/user-guides/client-api-config.md|655 col 12| Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION
docs/user-guides/client-api-config.md|671 col 3| Consider using “all above” or “all of the above”. (ALL_MOST_SOME_OF_NOUN[1])
Suggestions: all above, `all of the above`
URL: http://www.myhappyenglish.com/free-english-lesson/2013/05/22/english-grammar-lesson-all-some-most-vs-all-of-some-of-most-of/
Rule: https://community.languagetool.org/rule/show/ALL_MOST_SOME_OF_NOUN?lang=en-US&subId=1
Category: GRAMMAR

docs/user-guides/client-api-config.md Outdated Show resolved Hide resolved
docs/user-guides/client-api-config.md Show resolved Hide resolved
docs/user-guides/client-api-config.md Show resolved Hide resolved
docs/user-guides/client-api-config.md Show resolved Hide resolved
docs/user-guides/client-api-config.md Outdated Show resolved Hide resolved
docs/user-guides/client-api-config.md Show resolved Hide resolved
docs/user-guides/client-api-config.md Show resolved Hide resolved
docs/user-guides/client-api-config.md Show resolved Hide resolved
docs/user-guides/client-api-config.md Outdated Show resolved Hide resolved
docs/user-guides/client-api-config.md Show resolved Hide resolved
@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Sep 5, 2022

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 535e4da
Status: ✅  Deploy successful!
Preview URL: https://7ed1746d.vald.pages.dev
Branch Preview URL: https://documentation-docs-api-confi.vald.pages.dev

View logs

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

LanguageTool

docs/user-guides/client-api-config.md|459 col 11| Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: vector
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC
docs/user-guides/client-api-config.md|494 col 1| This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: If
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING
docs/user-guides/client-api-config.md|497 col 5| Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1 Category: PUNCTUATION [docs/user-guides/client-api-config.md|506 col 31|](http://github.com/vdaas/vald/blob/70250390605cf02259d0a06f85ff30b9ce48fa72/docs/user-guides/client-api-config.md#L506) This abbreviation for “identification” is spelled all-uppercase. (ID_CASING[2]) Suggestions: `ID` Rule: https://community.languagetool.org/rule/show/ID_CASING?lang=en-US&subId=2 Category: CASING [docs/user-guides/client-api-config.md|544 col 28|](http://github.com/vdaas/vald/blob/70250390605cf02259d0a06f85ff30b9ce48fa72/docs/user-guides/client-api-config.md#L544) This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Suggestions: `Message` Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US Category: CASING [docs/user-guides/client-api-config.md|548 col 2|](http://github.com/vdaas/vald/blob/70250390605cf02259d0a06f85ff30b9ce48fa72/docs/user-guides/client-api-config.md#L548) This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Suggestions: `Message` Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US Category: CASING [docs/user-guides/client-api-config.md|550 col 4|](http://github.com/vdaas/vald/blob/70250390605cf02259d0a06f85ff30b9ce48fa72/docs/user-guides/client-api-config.md#L550) This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Suggestions: `String` Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US Category: CASING [docs/user-guides/client-api-config.md|552 col 4|](http://github.com/vdaas/vald/blob/70250390605cf02259d0a06f85ff30b9ce48fa72/docs/user-guides/client-api-config.md#L552) This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Suggestions: `Uint32` Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US Category: CASING [docs/user-guides/client-api-config.md|556 col 2|](http://github.com/vdaas/vald/blob/70250390605cf02259d0a06f85ff30b9ce48fa72/docs/user-guides/client-api-config.md#L556) This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Suggestions: `Message` Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US Category: CASING [docs/user-guides/client-api-config.md|558 col 4|](http://github.com/vdaas/vald/blob/70250390605cf02259d0a06f85ff30b9ce48fa72/docs/user-guides/client-api-config.md#L558) This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Suggestions: `Repeated` Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US Category: CASING [docs/user-guides/client-api-config.md|569 col 28|](http://github.com/vdaas/vald/blob/70250390605cf02259d0a06f85ff30b9ce48fa72/docs/user-guides/client-api-config.md#L569) This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Suggestions: `Message` Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US Category: CASING [docs/user-guides/client-api-config.md|573 col 2|](http://github.com/vdaas/vald/blob/70250390605cf02259d0a06f85ff30b9ce48fa72/docs/user-guides/client-api-config.md#L573) This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Suggestions: `Message` Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US Category: CASING [docs/user-guides/client-api-config.md|575 col 4|](http://github.com/vdaas/vald/blob/70250390605cf02259d0a06f85ff30b9ce48fa72/docs/user-guides/client-api-config.md#L575) This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Suggestions: `String` Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US Category: CASING [docs/user-guides/client-api-config.md|577 col 4|](http://github.com/vdaas/vald/blob/70250390605cf02259d0a06f85ff30b9ce48fa72/docs/user-guides/client-api-config.md#L577) This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Suggestions: `Uint32` Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US Category: CASING [docs/user-guides/client-api-config.md|581 col 2|](http://github.com/vdaas/vald/blob/70250390605cf02259d0a06f85ff30b9ce48fa72/docs/user-guides/client-api-config.md#L581) This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Suggestions: `Message` Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US Category: CASING [docs/user-guides/client-api-config.md|583 col 4|](http://github.com/vdaas/vald/blob/70250390605cf02259d0a06f85ff30b9ce48fa72/docs/user-guides/client-api-config.md#L583) This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Suggestions: `Repeated` Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US Category: CASING [docs/user-guides/client-api-config.md|604 col 35|](http://github.com/vdaas/vald/blob/70250390605cf02259d0a06f85ff30b9ce48fa72/docs/user-guides/client-api-config.md#L604) This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Suggestions: `Message` Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US Category: CASING [docs/user-guides/client-api-config.md|606 col 11|](http://github.com/vdaas/vald/blob/70250390605cf02259d0a06f85ff30b9ce48fa72/docs/user-guides/client-api-config.md#L606) Consider shortening this phrase to just “whether”. It is correct though if you mean ‘regardless of whether’. (WHETHER[7]) Suggestions: `whether` URL: https://languagetool.org/insights/post/whether-vs-if/#when-to-use-%E2%80%9Cwhether%E2%80%9D Rule: https://community.languagetool.org/rule/show/WHETHER?lang=en-US&subId=7 Category: REDUNDANCY [docs/user-guides/client-api-config.md|607 col 2|](http://github.com/vdaas/vald/blob/70250390605cf02259d0a06f85ff30b9ce48fa72/docs/user-guides/client-api-config.md#L607) This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Suggestions: `Bool` Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US Category: CASING [docs/user-guides/client-api-config.md|609 col 2|](http://github.com/vdaas/vald/blob/70250390605cf02259d0a06f85ff30b9ce48fa72/docs/user-guides/client-api-config.md#L609) This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Suggestions: `Int64` Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US Category: CASING [docs/user-guides/client-api-config.md|626 col 1|](http://github.com/vdaas/vald/blob/70250390605cf02259d0a06f85ff30b9ce48fa72/docs/user-guides/client-api-config.md#L626) This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Suggestions: `Func` Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US Category: CASING [docs/user-guides/client-api-config.md|636 col 14|](http://github.com/vdaas/vald/blob/70250390605cf02259d0a06f85ff30b9ce48fa72/docs/user-guides/client-api-config.md#L636) Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE) Suggestions: `client` Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US Category: MISC [docs/user-guides/client-api-config.md|655 col 12|](http://github.com/vdaas/vald/blob/70250390605cf02259d0a06f85ff30b9ce48fa72/docs/user-guides/client-api-config.md#L655) Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1]) Suggestions:
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION

docs/user-guides/client-api-config.md Show resolved Hide resolved
docs/user-guides/client-api-config.md Show resolved Hide resolved
docs/user-guides/client-api-config.md Show resolved Hide resolved
docs/user-guides/client-api-config.md Show resolved Hide resolved
docs/user-guides/client-api-config.md Show resolved Hide resolved
docs/user-guides/client-api-config.md Show resolved Hide resolved
docs/user-guides/client-api-config.md Show resolved Hide resolved
docs/user-guides/client-api-config.md Show resolved Hide resolved
docs/user-guides/client-api-config.md Show resolved Hide resolved
docs/user-guides/client-api-config.md Outdated Show resolved Hide resolved
@vankichi vankichi force-pushed the documentation/docs/api-configs branch from 7025039 to cc05f61 Compare September 5, 2022 08:00
docs/user-guides/client-api-config.md Show resolved Hide resolved
docs/user-guides/client-api-config.md Show resolved Hide resolved
docs/user-guides/client-api-config.md Show resolved Hide resolved
docs/user-guides/client-api-config.md Outdated Show resolved Hide resolved
docs/user-guides/client-api-config.md Show resolved Hide resolved
docs/user-guides/client-api-config.md Show resolved Hide resolved
docs/user-guides/client-api-config.md Show resolved Hide resolved
docs/user-guides/client-api-config.md Show resolved Hide resolved
docs/user-guides/client-api-config.md Outdated Show resolved Hide resolved
docs/user-guides/client-api-config.md Show resolved Hide resolved
Signed-off-by: vankichi <kyukawa315@gmail.com>
@vankichi vankichi force-pushed the documentation/docs/api-configs branch from cc05f61 to 89814d6 Compare September 5, 2022 08:04
docs/user-guides/client-api-config.md Show resolved Hide resolved
docs/user-guides/client-api-config.md Show resolved Hide resolved
docs/user-guides/client-api-config.md Show resolved Hide resolved
docs/user-guides/client-api-config.md Show resolved Hide resolved
docs/user-guides/client-api-config.md Show resolved Hide resolved
@vankichi vankichi requested review from kevindiu, a team and hlts2 and removed request for a team September 5, 2022 09:08
@vankichi vankichi marked this pull request as ready for review September 5, 2022 09:08
@vankichi vankichi changed the title [WIP] Add Client API Config document Add Client API Config document Sep 5, 2022
docs/user-guides/client-api-config.md Outdated Show resolved Hide resolved
docs/user-guides/client-api-config.md Outdated Show resolved Hide resolved
docs/user-guides/client-api-config.md Outdated Show resolved Hide resolved
docs/user-guides/client-api-config.md Outdated Show resolved Hide resolved
docs/user-guides/client-api-config.md Outdated Show resolved Hide resolved
docs/user-guides/client-api-config.md Outdated Show resolved Hide resolved
docs/user-guides/client-api-config.md Outdated Show resolved Hide resolved
docs/user-guides/client-api-config.md Outdated Show resolved Hide resolved
docs/user-guides/client-api-config.md Outdated Show resolved Hide resolved
docs/user-guides/client-api-config.md Outdated Show resolved Hide resolved
Co-authored-by: Kevin Diu <kevindiujp@gmail.com>
Copy link
Contributor

@kevindiu kevindiu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Collaborator

@hlts2 hlts2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@vankichi vankichi requested a review from kpango September 12, 2022 02:28
@vankichi vankichi merged commit 98568ac into main Sep 26, 2022
@vankichi vankichi deleted the documentation/docs/api-configs branch September 26, 2022 06:29
@kevindiu kevindiu mentioned this pull request Oct 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants