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.

Sign up for GitHub

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

Update gRPC status code for API docs #1943

Merged
merged 1 commit into from
Feb 8, 2023
Merged

Update gRPC status code for API docs #1943

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
130 changes: 76 additions & 54 deletions docs/api/filter-gateway.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,12 +120,14 @@ service Filter {

### Status Code

| code | desc. |
| :--: | :--------------- |
| 0 | OK |
| 3 | INVALID_ARGUMENT |
| 6 | ALREADY_EXISTS |
| 13 | INTERNAL |
| code | desc. |
| :--: | :---------------- |
| 0 | OK |
| 1 | CANCELLED |
| 3 | INVALID_ARGUMENT |
| 4 | DEADLINE_EXCEEDED |
| 6 | ALREADY_EXISTS |
| 13 | INTERNAL |

## StreamInsert RPC

Expand Down Expand Up @@ -262,12 +264,14 @@ service Filter {

### Status Code

| code | desc. |
| :--: | :--------------- |
| 0 | OK |
| 3 | INVALID_ARGUMENT |
| 6 | ALREADY_EXISTS |
| 13 | INTERNAL |
| code | desc. |
| :--: | :---------------- |
| 0 | OK |
| 1 | CANCELLED |
| 3 | INVALID_ARGUMENT |
| 4 | DEADLINE_EXCEEDED |
| 6 | ALREADY_EXISTS |
| 13 | INTERNAL |

## MultiInsert RPC

Expand Down Expand Up @@ -401,12 +405,14 @@ service Filter {

### Status Code

| code | desc. |
| :--: | :--------------- |
| 0 | OK |
| 3 | INVALID_ARGUMENT |
| 6 | ALREADY_EXISTS |
| 13 | INTERNAL |
| code | desc. |
| :--: | :---------------- |
| 0 | OK |
| 1 | CANCELLED |
| 3 | INVALID_ARGUMENT |
| 4 | DEADLINE_EXCEEDED |
| 6 | ALREADY_EXISTS |
| 13 | INTERNAL |

## Update RPC

Expand Down Expand Up @@ -522,12 +528,14 @@ service Filter {

### Status Code

| code | desc. |
| :--: | :--------------- |
| 0 | OK |
| 3 | INVALID_ARGUMENT |
| 6 | ALREADY_EXISTS |
| 13 | INTERNAL |
| code | desc. |
| :--: | :---------------- |
| 0 | OK |
| 1 | CANCELLED |
| 3 | INVALID_ARGUMENT |
| 4 | DEADLINE_EXCEEDED |
| 6 | ALREADY_EXISTS |
| 13 | INTERNAL |

## Stream Update RPC

Expand Down Expand Up @@ -663,12 +671,14 @@ service Filter {

### Status Code

| code | desc. |
| :--: | :--------------- |
| 0 | OK |
| 3 | INVALID_ARGUMENT |
| 6 | ALREADY_EXISTS |
| 13 | INTERNAL |
| code | desc. |
| :--: | :---------------- |
| 0 | OK |
| 1 | CANCELLED |
| 3 | INVALID_ARGUMENT |
| 4 | DEADLINE_EXCEEDED |
| 6 | ALREADY_EXISTS |
| 13 | INTERNAL |

## MultiUpdate RPC

Expand Down Expand Up @@ -807,12 +817,14 @@ service Filter {

### Status Code

| code | desc. |
| :--: | :--------------- |
| 0 | OK |
| 3 | INVALID_ARGUMENT |
| 6 | ALREADY_EXISTS |
| 13 | INTERNAL |
| code | desc. |
| :--: | :---------------- |
| 0 | OK |
| 1 | CANCELLED |
| 3 | INVALID_ARGUMENT |
| 4 | DEADLINE_EXCEEDED |
| 6 | ALREADY_EXISTS |
| 13 | INTERNAL |

## Upsert RPC

Expand Down Expand Up @@ -928,12 +940,14 @@ service Filter {

### Status Code

| code | desc. |
| :--: | :--------------- |
| 0 | OK |
| 3 | INVALID_ARGUMENT |
| 6 | ALREADY_EXISTS |
| 13 | INTERNAL |
| code | desc. |
| :--: | :---------------- |
| 0 | OK |
| 1 | CANCELLED |
| 3 | INVALID_ARGUMENT |
| 4 | DEADLINE_EXCEEDED |
| 6 | ALREADY_EXISTS |
| 13 | INTERNAL |

## StreamUpsert RPC

Expand Down Expand Up @@ -1066,12 +1080,14 @@ service Filter {

### Status Code

| code | desc. |
| :--: | :--------------- |
| 0 | OK |
| 3 | INVALID_ARGUMENT |
| 6 | ALREADY_EXISTS |
| 13 | INTERNAL |
| code | desc. |
| :--: | :---------------- |
| 0 | OK |
| 1 | CANCELLED |
| 3 | INVALID_ARGUMENT |
| 4 | DEADLINE_EXCEEDED |
| 6 | ALREADY_EXISTS |
| 13 | INTERNAL |

## MultiUpsert RPC

Expand Down Expand Up @@ -1210,12 +1226,14 @@ service Filter {

### Status Code

| code | desc. |
| :--: | :--------------- |
| 0 | OK |
| 3 | INVALID_ARGUMENT |
| 6 | ALREADY_EXISTS |
| 13 | INTERNAL |
| code | desc. |
| :--: | :---------------- |
| 0 | OK |
| 1 | CANCELLED |
| 3 | INVALID_ARGUMENT |
| 4 | DEADLINE_EXCEEDED |
| 6 | ALREADY_EXISTS |
| 13 | INTERNAL |

## Search RPC

Expand Down Expand Up @@ -1329,9 +1347,11 @@ service Filter {
| code | desc. |
| :--: | :---------------- |
| 0 | OK |
| 1 | CANCELLED |
| 3 | INVALID_ARGUMENT |
| 4 | DEADLINE_EXCEEDED |
| 5 | NOT_FOUND |
| 13 | INTERNAL |

## StreamSearch RPC

Expand Down Expand Up @@ -1588,6 +1608,8 @@ service Filter {
| code | desc. |
| :--: | :---------------- |
| 0 | OK |
| 1 | CANCELLED |
| 3 | INVALID_ARGUMENT |
| 4 | DEADLINE_EXCEEDED |
| 5 | NOT_FOUND |
| 13 | INTERNAL |
42 changes: 24 additions & 18 deletions docs/api/insert.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,12 +90,14 @@ Inset RPC is the method to add a new single vector.

### Status Code

| code | desc. |
| :--: | :--------------- |
| 0 | OK |
| 3 | INVALID_ARGUMENT |
| 6 | ALREADY_EXISTS |
| 13 | INTERNAL |
| code | desc. |
| :--: | :---------------- |
| 0 | OK |
| 1 | CANCELLED |
| 3 | INVALID_ARGUMENT |
| 4 | DEADLINE_EXCEEDED |
| 6 | ALREADY_EXISTS |
| 13 | INTERNAL |

## StreamInsert RPC

Expand Down Expand Up @@ -197,12 +199,14 @@ It's the recommended method to insert a large number of vectors.

### Status Code

| code | desc. |
| :--: | :--------------- |
| 0 | OK |
| 3 | INVALID_ARGUMENT |
| 6 | ALREADY_EXISTS |
| 13 | INTERNAL |
| code | desc. |
| :--: | :---------------- |
| 0 | OK |
| 1 | CANCELLED |
| 3 | INVALID_ARGUMENT |
| 4 | DEADLINE_EXCEEDED |
| 6 | ALREADY_EXISTS |
| 13 | INTERNAL |

## MultiInsert RPC

Expand Down Expand Up @@ -301,9 +305,11 @@ Please be careful that the size of the request exceeds the limit.

### Status Code

| code | desc. |
| :--: | :--------------- |
| 0 | OK |
| 3 | INVALID_ARGUMENT |
| 6 | ALREADY_EXISTS |
| 13 | INTERNAL |
| code | desc. |
| :--: | :---------------- |
| 0 | OK |
| 1 | CANCELLED |
| 3 | INVALID_ARGUMENT |
| 4 | DEADLINE_EXCEEDED |
| 6 | ALREADY_EXISTS |
| 13 | INTERNAL |
29 changes: 17 additions & 12 deletions docs/api/object.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ Exists RPC is the method to check the a vector exists in the `vald-agent`.
| code | desc. |
| :--: | :---------------- |
| 0 | OK |
| 1 | CANCELLED |
| 3 | INVALID_ARGUMENT |
| 4 | DEADLINE_EXCEEDED |
| 5 | NOT_FOUND |
Expand Down Expand Up @@ -122,12 +123,14 @@ GetObject RPC is the method to get the metadata of a vector inserted into the `v

### Status Code

| code | desc. |
| :--: | :--------------- |
| 0 | OK |
| 3 | INVALID_ARGUMENT |
| 5 | NOT_FOUND |
| 13 | INTERNAL |
| code | desc. |
| :--: | :---------------- |
| 0 | OK |
| 1 | CANCELLED |
| 3 | INVALID_ARGUMENT |
| 4 | DEADLINE_EXCEEDED |
| 5 | NOT_FOUND |
| 13 | INTERNAL |

## StreamGetObject RPC

Expand Down Expand Up @@ -198,9 +201,11 @@ Each Upsert request and response are independent.

### Status Code

| code | desc. |
| :--: | :--------------- |
| 0 | OK |
| 3 | INVALID_ARGUMENT |
| 5 | NOT_FOUND |
| 13 | INTERNAL |
| code | desc. |
| :--: | :---------------- |
| 0 | OK |
| 1 | CANCELLED |
| 3 | INVALID_ARGUMENT |
| 4 | DEADLINE_EXCEEDED |
| 5 | NOT_FOUND |
| 13 | INTERNAL |
3 changes: 3 additions & 0 deletions docs/api/remove.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ Remove RPC is the method to remove a single vector.
| code | desc. |
| :--: | :---------------- |
| 0 | OK |
| 1 | CANCELLED |
| 3 | INVALID_ARGUMENT |
| 4 | DEADLINE_EXCEEDED |
| 5 | NOT_FOUND |
Expand Down Expand Up @@ -197,6 +198,7 @@ It's the recommended method to remove a large number of vectors.
| code | desc. |
| :--: | :---------------- |
| 0 | OK |
| 1 | CANCELLED |
| 3 | INVALID_ARGUMENT |
| 4 | DEADLINE_EXCEEDED |
| 5 | NOT_FOUND |
Expand Down Expand Up @@ -300,6 +302,7 @@ Please be careful that the size of the request exceeds the limit.
| code | desc. |
| :--: | :---------------- |
| 0 | OK |
| 1 | CANCELLED |
| 3 | INVALID_ARGUMENT |
| 4 | DEADLINE_EXCEEDED |
| 5 | NOT_FOUND |
Expand Down
Loading