Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
Signed-off-by: AnthonyTsu1984 <115786031+AnthonyTsu1984@users.noreply.github.com>
  • Loading branch information
AnthonyTsu1984 committed Sep 10, 2024
1 parent 070bb74 commit ceb9712
Show file tree
Hide file tree
Showing 51 changed files with 2,921 additions and 275 deletions.
2 changes: 1 addition & 1 deletion API_Reference/milvus-restful/v2.4.x/v2/Alias (v2)/Alter.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,6 @@ The properties in the returned response are listed in the following table.

| Property | Description |
|----------|---------------------------------------------------------------------------------------------------------------------------------------------|
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`200`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`0`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `message` | __string__<br/>Indicates the possible reason for the reported error. |
| `data` | __object__<br/> |
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,6 @@ The properties in the returned response are listed in the following table.

| Property | Description |
|----------|---------------------------------------------------------------------------------------------------------------------------------------------|
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`200`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`0`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `message` | __string__<br/>Indicates the possible reason for the reported error. |
| `data` | __object__<br/> |
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ The properties in the returned response are listed in the following table.

| Property | Description |
|----------|---------------------------------------------------------------------------------------------------------------------------------------------|
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`200`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`0`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `message` | __string__<br/>Indicates the possible reason for the reported error. |
| `data` | __object__<br/> |
| `data.dbName` | __string__<br/>The name of the database to which the collection belongs. |
Expand Down
2 changes: 1 addition & 1 deletion API_Reference/milvus-restful/v2.4.x/v2/Alias (v2)/Drop.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,6 @@ The properties in the returned response are listed in the following table.

| Property | Description |
|----------|---------------------------------------------------------------------------------------------------------------------------------------------|
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`200`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`0`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `message` | __string__<br/>Indicates the possible reason for the reported error. |
| `data` | __object__<br/> |
2 changes: 1 addition & 1 deletion API_Reference/milvus-restful/v2.4.x/v2/Alias (v2)/List.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ The properties in the returned response are listed in the following table.

| Property | Description |
|----------|---------------------------------------------------------------------------------------------------------------------------------------------|
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`200`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`0`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `message` | __string__<br/>Indicates the possible reason for the reported error. |
| `data` | __array__<br/> |
| `data[]` | __string__<br/>A list of item objects. |
Original file line number Diff line number Diff line change
Expand Up @@ -294,6 +294,6 @@ The properties in the returned response are listed in the following table.

| Property | Description |
|----------|---------------------------------------------------------------------------------------------------------------------------------------------|
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`200`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`0`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `message` | __string__<br/>Indicates the possible reason for the reported error. |
| `data` | __object__<br/> |
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ The properties in the returned response are listed in the following table.

| Property | Description |
|----------|---------------------------------------------------------------------------------------------------------------------------------------------|
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`200`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`0`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `message` | __string__<br/>Indicates the possible reason for the reported error. |
| `data` | __object__<br/> |
| `data[].aliases` | __array__<br/>A list aliases assigned to the collection. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,6 @@ The properties in the returned response are listed in the following table.

| Property | Description |
|----------|---------------------------------------------------------------------------------------------------------------------------------------------|
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`200`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`0`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `message` | __string__<br/>Indicates the possible reason for the reported error. |
| `data` | __object__<br/> |
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ The properties in the returned response are listed in the following table.

| Property | Description |
|----------|---------------------------------------------------------------------------------------------------------------------------------------------|
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`200`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`0`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `message` | __string__<br/>Indicates the possible reason for the reported error. |
| `data` | __object__<br/> |
| `data.loadState` | __string__<br/>An object that indicates the load status of the specified collection. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ The properties in the returned response are listed in the following table.

| Property | Description |
|----------|---------------------------------------------------------------------------------------------------------------------------------------------|
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`200`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`0`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `message` | __string__<br/>Indicates the possible reason for the reported error. |
| `data` | __object__<br/> |
| `data.rowCount` | __integer__<br/>The number of entities. |
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ The properties in the returned response are listed in the following table.

| Property | Description |
|----------|---------------------------------------------------------------------------------------------------------------------------------------------|
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`200`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`0`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `message` | __string__<br/>Indicates the possible reason for the reported error. |
| `data` | __object__<br/> |
| `data.has` | __boolean__<br/>A boolean value indicates whether the specified partition exists. |
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ The properties in the returned response are listed in the following table.

| Property | Description |
|----------|---------------------------------------------------------------------------------------------------------------------------------------------|
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`200`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`0`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `message` | __string__<br/>Indicates the possible reason for the reported error. |
| `data` | __array__<br/>A list of collection names. |
| `data[]` | __string__<br/>A collection name. |
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,6 @@ The properties in the returned response are listed in the following table.

| Property | Description |
|----------|---------------------------------------------------------------------------------------------------------------------------------------------|
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`200`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`0`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `message` | __string__<br/>Indicates the possible reason for the reported error. |
| `data` | __object__<br/> |
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,6 @@ The properties in the returned response are listed in the following table.

| Property | Description |
|----------|---------------------------------------------------------------------------------------------------------------------------------------------|
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`200`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`0`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `message` | __string__<br/>Indicates the possible reason for the reported error. |

Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,6 @@ The properties in the returned response are listed in the following table.

| Property | Description |
|----------|---------------------------------------------------------------------------------------------------------------------------------------------|
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`200`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`0`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `message` | __string__<br/>Indicates the possible reason for the reported error. |
| `data` | __object__<br/> |
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ The properties in the returned response are listed in the following table.

| Property | Description |
|----------|---------------------------------------------------------------------------------------------------------------------------------------------|
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`200`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`0`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `message` | __string__<br/>Indicates the possible reason for the reported error. |
| `data` | __array__<br/> |
| `data[]` | __object__<br/> |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ The properties in the returned response are listed in the following table.

| Property | Description |
|----------|---------------------------------------------------------------------------------------------------------------------------------------------|
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`200`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`0`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `message` | __string__<br/>Indicates the possible reason for the reported error. |
| `data` | __object__<br/> |
| `data.collectionName` | __string__<br/>The name of the target collection of this bulk-import job. |
Expand Down
2 changes: 1 addition & 1 deletion API_Reference/milvus-restful/v2.4.x/v2/Import (v2)/List.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ The properties in the returned response are listed in the following table.

| Property | Description |
|----------|---------------------------------------------------------------------------------------------------------------------------------------------|
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`200`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`0`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `message` | __string__<br/>Indicates the possible reason for the reported error. |
| `data` | __object__<br/> |
| `data[].records` | __array__<br/>A list of import jobs. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,6 @@ The properties in the returned response are listed in the following table.

| Property | Description |
|----------|---------------------------------------------------------------------------------------------------------------------------------------------|
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`200`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`0`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `message` | __string__<br/>Indicates the possible reason for the reported error. |
| `data` | __object__<br/> |
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ The properties in the returned response are listed in the following table.

| Property | Description |
|----------|---------------------------------------------------------------------------------------------------------------------------------------------|
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`200`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`0`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `message` | __string__<br/>Indicates the possible reason for the reported error. |
| `data` | __array__<br/> |
| `data[]` | __object__<br/> |
Expand Down
2 changes: 1 addition & 1 deletion API_Reference/milvus-restful/v2.4.x/v2/Index (v2)/Drop.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,6 @@ The properties in the returned response are listed in the following table.

| Property | Description |
|----------|---------------------------------------------------------------------------------------------------------------------------------------------|
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`200`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`0`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `message` | __string__<br/>Indicates the possible reason for the reported error. |
| `data` | __object__<br/> |
2 changes: 1 addition & 1 deletion API_Reference/milvus-restful/v2.4.x/v2/Index (v2)/List.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ The properties in the returned response are listed in the following table.

| Property | Description |
|----------|---------------------------------------------------------------------------------------------------------------------------------------------|
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`200`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`0`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `message` | __string__<br/>Indicates the possible reason for the reported error. |
| `data` | __array__<br/>A list of index names. |
| `data[]` | __string__<br/>A index name. |
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,6 @@ The properties in the returned response are listed in the following table.

| Property | Description |
|----------|---------------------------------------------------------------------------------------------------------------------------------------------|
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`200`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `code` | __integer__<br/>Indicates whether the request succeeds.<br/><ul><li>`0`: The request succeeds.</li><li>Others: Some error occurs.</li></ul> |
| `message` | __string__<br/>Indicates the possible reason for the reported error. |
| `data` | __object__<br/> |
Loading

0 comments on commit ceb9712

Please sign in to comment.