Add filter gateway api doc #1821

kevindiu · 2022-10-26T01:38:52Z

Signed-off-by: kevindiu kevindiujp@gmail.com

Description:

It is the documentation of https://github.com/vdaas/vald/blob/main/apis/proto/v1/vald/filter.proto

Related Issue:

Versions:

Go Version: 1.19.2
Docker Version: 20.10.8
Kubernetes Version: 1.22.0
NGT Version: 1.14.8

Checklist:

I have read the CONTRIBUTING document and completed our CLA agreement.
I have checked open Pull Requests for the similar feature or fixes?

Special notes for your reviewer:

vdaas-ci · 2022-10-26T01:39:03Z

[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

Signed-off-by: kevindiu <kevindiujp@gmail.com>

cloudflare-pages · 2022-10-26T01:39:10Z

Deploying with Cloudflare Pages

Latest commit:	`cf509a2`
Status:	✅ Deploy successful!
Preview URL:	https://a129eebe.vald.pages.dev
Branch Preview URL:	https://documentation-add-filter-api.vald.pages.dev

View logs

github-actions

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

LanguageTool

docs/api/filter-gateway.md|748 col 6| 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/filter-gateway.md|815 col 3| Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: rpc
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC
docs/api/filter-gateway.md|833 col 8| Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: Config
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC
docs/api/filter-gateway.md|837 col 6| 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/api/filter-gateway.md|875 col 6| 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/filter-gateway.md|934 col 3| Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: rpc
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC
docs/api/filter-gateway.md|947 col 8| Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: Config
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC
docs/api/filter-gateway.md|951 col 6| 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/api/filter-gateway.md|989 col 6| 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/filter-gateway.md|1021 col 12| Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: Location
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC
docs/api/filter-gateway.md|1022 col 23| Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: Status
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC
docs/api/filter-gateway.md|1075 col 3| Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: rpc
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC
docs/api/filter-gateway.md|1095 col 6| 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/api/filter-gateway.md|1097 col 8| Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: Config
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC
docs/api/filter-gateway.md|1101 col 6| 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/api/filter-gateway.md|1145 col 6| 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/filter-gateway.md|1212 col 3| Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: rpc
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC
docs/api/filter-gateway.md|1230 col 8| Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: Config
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC
docs/api/filter-gateway.md|1234 col 6| 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/api/filter-gateway.md|1310 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/filter-gateway.md|1328 col 3| Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: rpc
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC
docs/api/filter-gateway.md|1341 col 8| Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: Config
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC
docs/api/filter-gateway.md|1345 col 6| 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/api/filter-gateway.md|1398 col 8| Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: Response
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC
docs/api/filter-gateway.md|1399 col 19| Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: Status
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC
docs/api/filter-gateway.md|1403 col 4| 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/api/filter-gateway.md|1435 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/filter-gateway.md|1447 col 3| Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: rpc
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC
docs/api/filter-gateway.md|1467 col 6| 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/api/filter-gateway.md|1469 col 8| Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: Config
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC
docs/api/filter-gateway.md|1473 col 6| 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/api/filter-gateway.md|1534 col 4| 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/api/filter-gateway.md|1565 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/filter-gateway.md

vankichi · 2022-10-26T02:28:52Z

docs/api/filter-gateway.md

+
+## Overview
+
+Filter Servie is responsible for providing insert, update, upsert and search interface for `Vald Filter Gateway`.


I think it would be better to show more specific about when to use this API

docs/api/filter-gateway.md

vankichi · 2022-10-26T02:31:03Z

docs/api/filter-gateway.md

+```rpc
+  rpc InsertObject(payload.v1.Insert.ObjectRequest)
+      returns (payload.v1.Object.Location) {
+    option (google.api.http) = {
+      post : "/insert/object"
+      body : "*"
+    };
+  }
+  ```


Suggested change

```rpc

rpc InsertObject(payload.v1.Insert.ObjectRequest)

returns (payload.v1.Object.Location) {

option (google.api.http) = {

post : "/insert/object"

body : "*"

};

}

```

```rpc

service Filter {

rpc InsertObject(payload.v1.Insert.ObjectRequest)

returns (payload.v1.Object.Location) {

option (google.api.http) = {

post : "/insert/object"

body : "*"

};

}

Please format as same as other API docs. And, please fix others in this doc.

Signed-off-by: kevindiu <kevindiujp@gmail.com>

github-actions · 2022-10-26T05:32:51Z

docs/api/filter-gateway.md

+
+    | field      | type          | label | required | desc.             |
+    | :--------: | :------------ | :---- | :------: | :---------------- |
+    | id         | string        |       |    \*    | the object ID     |


[LanguageTool] _{reported by reviewdog 🐶}
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

github-actions · 2022-10-26T05:32:51Z

docs/api/filter-gateway.md

+  message Upsert {
+      message ObjectRequest {
+        Object.Blob object = 1;
+        Config config = 2;


[LanguageTool] _{reported by reviewdog 🐶}
Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: Config
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC

github-actions · 2022-10-26T05:32:51Z

docs/api/filter-gateway.md

+        Filter.Target vectorizer = 3;
+      }
+
+      message Config {


[LanguageTool] _{reported by reviewdog 🐶}
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

github-actions · 2022-10-26T05:32:51Z

docs/api/filter-gateway.md

+
+    | field      | type          | label | required | desc.             |
+    | :--------: | :------------ | :---- | :------: | :---------------- |
+    | id         | string        |       |    \*    | the object ID     |


[LanguageTool] _{reported by reviewdog 🐶}
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

github-actions · 2022-10-26T05:32:52Z

docs/api/filter-gateway.md

+  message Upsert {
+      message ObjectRequest {
+        Object.Blob object = 1;
+        Config config = 2;


[LanguageTool] _{reported by reviewdog 🐶}
Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: Config
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC

github-actions · 2022-10-26T05:32:54Z

docs/api/filter-gateway.md

+        repeated ObjectRequest requests = 1; 
+      }
+
+      message ObjectRequest {


[LanguageTool] _{reported by reviewdog 🐶}
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

github-actions · 2022-10-26T05:32:54Z

docs/api/filter-gateway.md

+
+      message ObjectRequest {
+        bytes object = 1;
+        Config config = 2;


[LanguageTool] _{reported by reviewdog 🐶}
Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: Config
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC

github-actions · 2022-10-26T05:32:54Z

docs/api/filter-gateway.md

+        Filter.Target vectorizer = 3;
+      }
+
+      message Config {


[LanguageTool] _{reported by reviewdog 🐶}
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

github-actions · 2022-10-26T05:32:54Z

docs/api/filter-gateway.md

+      repeated Response responses = 1;
+    }
+
+    message Response {


[LanguageTool] _{reported by reviewdog 🐶}
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

github-actions · 2022-10-26T05:32:55Z

docs/api/filter-gateway.md

+
+    |  field   | type   | label | desc.                                                 |
+    | :------: | :----- | :---- | :---------------------------------------------------- |
+    |    id    | string |       | the vector ID                                         |


[LanguageTool] _{reported by reviewdog 🐶}
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

add filter gateway api doc

e74e146

Signed-off-by: kevindiu <kevindiujp@gmail.com>

kevindiu force-pushed the documentation/add-filter-api-doc branch from 4810fbf to e74e146 Compare October 26, 2022 01:39

github-actions bot added size/XXL type/documentation priority/low labels Oct 26, 2022

github-actions bot reviewed Oct 26, 2022

View reviewed changes

kevindiu requested review from vankichi, a team and datelier and removed request for a team October 26, 2022 01:48

vankichi requested changes Oct 26, 2022

View reviewed changes

fix comment

f841e80

Signed-off-by: kevindiu <kevindiujp@gmail.com>

github-actions bot reviewed Oct 26, 2022

View reviewed changes

kevindiu requested a review from vankichi October 26, 2022 05:33

datelier approved these changes Oct 26, 2022

View reviewed changes

vankichi approved these changes Oct 27, 2022

View reviewed changes

Merge branch 'main' into documentation/add-filter-api-doc

cf509a2

kpango merged commit 8a62467 into main Oct 31, 2022

kpango deleted the documentation/add-filter-api-doc branch October 31, 2022 06:20

kpango mentioned this pull request Jan 19, 2023

[minor] Release v1.7.0 #1926

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add filter gateway api doc #1821

Add filter gateway api doc #1821

kevindiu commented Oct 26, 2022

vdaas-ci commented Oct 26, 2022

cloudflare-pages bot commented Oct 26, 2022 •

edited

Loading

github-actions bot left a comment

vankichi Oct 26, 2022

kevindiu Oct 26, 2022

vankichi Oct 26, 2022

kevindiu Oct 26, 2022

github-actions bot Oct 26, 2022

github-actions bot Oct 26, 2022

github-actions bot Oct 26, 2022

github-actions bot Oct 26, 2022

github-actions bot Oct 26, 2022

github-actions bot Oct 26, 2022

github-actions bot Oct 26, 2022

github-actions bot Oct 26, 2022

github-actions bot Oct 26, 2022

github-actions bot Oct 26, 2022


		## Overview

		Filter Servie is responsible for providing insert, update, upsert and search interface for `Vald Filter Gateway`.

Add filter gateway api doc #1821

Add filter gateway api doc #1821

Conversation

kevindiu commented Oct 26, 2022

Description:

Related Issue:

Versions:

Checklist:

Special notes for your reviewer:

vdaas-ci commented Oct 26, 2022

cloudflare-pages bot commented Oct 26, 2022 • edited Loading

Deploying with Cloudflare Pages

github-actions bot left a comment

Choose a reason for hiding this comment

vankichi Oct 26, 2022

Choose a reason for hiding this comment

kevindiu Oct 26, 2022

Choose a reason for hiding this comment

vankichi Oct 26, 2022

Choose a reason for hiding this comment

kevindiu Oct 26, 2022

Choose a reason for hiding this comment

github-actions bot Oct 26, 2022

Choose a reason for hiding this comment

github-actions bot Oct 26, 2022

Choose a reason for hiding this comment

github-actions bot Oct 26, 2022

Choose a reason for hiding this comment

github-actions bot Oct 26, 2022

Choose a reason for hiding this comment

github-actions bot Oct 26, 2022

Choose a reason for hiding this comment

github-actions bot Oct 26, 2022

Choose a reason for hiding this comment

github-actions bot Oct 26, 2022

Choose a reason for hiding this comment

github-actions bot Oct 26, 2022

Choose a reason for hiding this comment

github-actions bot Oct 26, 2022

Choose a reason for hiding this comment

github-actions bot Oct 26, 2022

Choose a reason for hiding this comment

cloudflare-pages bot commented Oct 26, 2022 •

edited

Loading