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 api status code description #1679

Merged
merged 14 commits into from
Jun 6, 2022

Conversation

vankichi
Copy link
Contributor

@vankichi vankichi commented May 25, 2022

Signed-off-by: vankichi [email protected]

Description:

I have created the gRPC status code overview document for the Vald cluster.
If there are more status codes that we are possible to get, let me know.

Related Issue:

How Has This Been Tested?:

Environment:

  • Go Version: 1.18.2
  • Docker Version: 20.10.8
  • Kubernetes Version: 1.22.0
  • NGT Version: 1.14.5

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.

@vdaas-ci
Copy link
Collaborator

[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 master
  • 🔚 2️⃣ 🔚 /label actions/e2e-deploy - run E2E deploy & integration test

docs/api/object.md Show resolved Hide resolved
docs/api/object.md Show resolved Hide resolved
docs/api/object.md Show resolved Hide resolved
docs/api/object.md Show resolved Hide resolved
docs/api/object.md Show resolved Hide resolved
docs/api/object.md Show resolved Hide resolved
docs/api/status.md Outdated Show resolved Hide resolved
docs/api/status.md Outdated Show resolved Hide resolved
docs/api/status.md Outdated Show resolved Hide resolved
docs/api/status.md Outdated Show resolved Hide resolved
@vankichi vankichi force-pushed the documentation/docs/add-api-status-code branch from 8cb56c9 to 7a706ba Compare May 26, 2022 08:49
@github-actions github-actions bot added size/XXL and removed size/L labels May 26, 2022
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/api/search.md|698 col 77| This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Its
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING
docs/api/search.md|743 col 9| 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/api/search.md|786 col 8| 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/api/search.md|831 col 9| 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/api/search.md|874 col 77| This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Its
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING
docs/api/search.md|933 col 9| 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/api/search.md|976 col 8| 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/api/search.md|1035 col 9| 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/api/search.md|1091 col 77| This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Its
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING
docs/api/search.md|1146 col 9| 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/api/search.md|1203 col 8| 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/api/search.md|1258 col 9| 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/api/update.md|66 col 8| 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/api/update.md|67 col 77| This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Its
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING
docs/api/update.md|152 col 8| 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/api/update.md|153 col 77| This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Its
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING
docs/api/update.md|188 col 59| In standard English, the word ‘exists’ is a verb. Please verify that the determiner ‘the’ is correct, or that a noun is not missing between ‘the’ and ‘exists’. (A_INFINITIVE[3])
URL: https://languagetool.org/insights/post/verbs-as-nouns/
Rule: https://community.languagetool.org/rule/show/A_INFINITIVE?lang=en-US&subId=3
Category: GRAMMAR
docs/api/update.md|271 col 8| 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/api/update.md|272 col 77| This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Its
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING
docs/api/upsert.md|70 col 8| 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/api/upsert.md|71 col 77| This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Its
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING
docs/api/upsert.md|155 col 8| 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/api/upsert.md|156 col 77| This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Its
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING
docs/api/upsert.md|273 col 8| 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/api/upsert.md|274 col 77| This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Its
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING

docs/api/insert.md Show resolved Hide resolved
docs/api/insert.md Show resolved Hide resolved
docs/api/insert.md Show resolved Hide resolved
docs/api/insert.md Show resolved Hide resolved
docs/api/insert.md Show resolved Hide resolved
docs/api/search.md Show resolved Hide resolved
docs/api/search.md Show resolved Hide resolved
docs/api/search.md Show resolved Hide resolved
docs/api/search.md Show resolved Hide resolved
docs/api/search.md Show resolved Hide resolved
@vankichi vankichi force-pushed the documentation/docs/add-api-status-code branch 3 times, most recently from 85d552d to b2c4e90 Compare May 26, 2022 08:51
docs/api/search.md Show resolved Hide resolved
docs/api/search.md Show resolved Hide resolved
docs/api/search.md Show resolved Hide resolved
docs/api/search.md Show resolved Hide resolved
docs/api/search.md Show resolved Hide resolved
docs/api/upsert.md Show resolved Hide resolved
docs/api/upsert.md Show resolved Hide resolved
docs/api/upsert.md Show resolved Hide resolved
docs/api/upsert.md Show resolved Hide resolved
docs/api/upsert.md Show resolved Hide resolved
@vankichi vankichi force-pushed the documentation/docs/add-api-status-code branch from b2c4e90 to e4c813d Compare May 26, 2022 08:55
Signed-off-by: vankichi <[email protected]>
docs/api/status.md Outdated Show resolved Hide resolved
docs/api/status.md Outdated Show resolved Hide resolved
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@vankichi vankichi marked this pull request as ready for review May 27, 2022 02:30
@vankichi vankichi changed the title [WIP] add api status code description add api status code description May 27, 2022
kmrmt
kmrmt previously approved these changes May 27, 2022
kevindiu
kevindiu previously approved these changes May 30, 2022
vankichi and others added 2 commits June 2, 2022 15:38
docs/api/status.md Show resolved Hide resolved
docs/api/status.md Outdated Show resolved Hide resolved
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
kpango
kpango previously approved these changes Jun 6, 2022
Copy link
Collaborator

@kpango kpango left a comment

Choose a reason for hiding this comment

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

LGTM

docs/api/status.md Outdated Show resolved Hide resolved
docs/api/status.md Outdated Show resolved Hide resolved
@vankichi vankichi requested a review from kevindiu June 6, 2022 02:41
@vankichi vankichi merged commit 7203cd3 into master Jun 6, 2022
@vankichi vankichi deleted the documentation/docs/add-api-status-code branch June 6, 2022 05:51
@hlts2 hlts2 mentioned this pull request Jun 8, 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.

7 participants