Merge pull request #971 from milvus-io/udpate-ref

update docs

Author: AnthonyTsu1984

API_Reference/milvus-sdk-java/v2.5.x/Authentication/createRole.md

@@ -0,0 +1,55 @@
+# createRole()
+
+This operation creates a custom role.
+
+```java
+public void createRole(CreateRoleReq request)
+```
+
+## Request Syntax
+
+```java
+createRole(CreateRoleReq.builder()
+    .roleName(String roleName)
+    .build()
+)
+```
+
+**BUILDER METHODS:**
+
+- `roleName(String roleName)`
+
+    The name of the role to create.
+
+**RETURNS:**
+
+*void*
+
+**EXCEPTIONS:**
+
+- **MilvusClientExceptions**
+
+    This exception will be raised when any error occurs during this operation.
+
+## Example
+
+```java
+import io.milvus.v2.client.ConnectConfig
+import io.milvus.v2.client.MilvusClientV2
+import io.milvus.v2.service.rbac.request.CreateRoleReq
+
+// 1. Set up a client
+ConnectConfig connectConfig = ConnectConfig.builder()
+        .uri("http://localhost:19530")
+        .token("root:Milvus")
+        .build();
+        
+MilvusClientV2 client = new MilvusClientV2(connectConfig);
+
+// 2. Create a role
+CreateRoleReq createRoleReq = CreateRoleReq.builder()
+        .roleName("read_only")
+        .build();
+        
+client.createRole(createRoleReq);
+```

API_Reference/milvus-sdk-java/v2.5.x/Authentication/createUser.md

@@ -0,0 +1,62 @@
+# createUser()
+
+This operation creates a user.
+
+```java
+public void createUser(CreateUserReq request)
+```
+
+## Request Syntax
+
+```java
+createUser(CreateUserReq.builder()
+    .userName(String userName)
+    .password(String password)
+    .build()
+)
+```
+
+**BUILDER METHODS:**
+
+- `userName(String roleName)`
+
+    The name of the user to create.
+
+- `password(String password)`
+
+    The password of the user to create.
+
+**RETURNS:**
+
+*void*
+
+**EXCEPTIONS:**
+
+- **MilvusClientExceptions**
+
+    This exception will be raised when any error occurs during this operation.
+
+## Example
+
+```java
+import io.milvus.v2.client.ConnectConfig
+import io.milvus.v2.client.MilvusClientV2
+import io.milvus.v2.service.rbac.request.CreateUserReq
+
+// 1. Set up a client
+ConnectConfig connectConfig = ConnectConfig.builder()
+        .uri("http://localhost:19530")
+        .token("root:Milvus")
+        .build();
+        
+MilvusClientV2 client = new MilvusClientV2(connectConfig);
+
+// 2. Create a user
+CreateUserReq createUserReq = CreateUserReq.builder()
+        .userName("test")
+        .password("Zilliz@2023")
+        .build();
+        
+client.createUser(createUserReq);
+```
+

API_Reference/milvus-sdk-java/v2.5.x/Authentication/describeRole.md

@@ -0,0 +1,75 @@
+# describeRole()
+
+This operation describes a specific role.
+
+```java
+public DescribeRoleResp describeRole(DescribeRoleReq request)
+```
+
+## Request Syntax
+
+```java
+describeRole(DescribeRoleReq.builder()
+    .roleName(String roleName)
+    .build()
+)
+```
+
+**BUILDER METHODS:**
+
+- `roleName(String roleName)`
+
+    The name of the role to describe.
+
+**RETURN Type:**
+
+*DescribeRoleResp.GrantInfo*
+
+**RETURNS:**
+
+A **DescribeRoleResp.GrantInfo** object representing the permissions assigned to the role.
+
+**PARAMETERS:**
+
+- **objectType** (*String*):
+The type of the object being granted a privilege.
+
+- **privilege** (*String*):
+The specific privilege granted to the object.
+
+- **objectName** (*String*):
+The name of the object to which the privilege is granted.
+
+- **dbName** (*String*):
+The name of the database associated with the granted privilege.
+
+- **grantor** (*String*):
+The name of the entity (user or role) that granted the privilege.
+
+**EXCEPTIONS:**
+
+- **MilvusClientExceptions**
+
+    This exception will be raised when any error occurs during this operation.
+
+## Example
+
+```java
+import io.milvus.v2.client.ConnectConfig
+import io.milvus.v2.client.MilvusClientV2
+import io.milvus.v2.service.rbac.request.DescribeUserReq
+
+// 1. Set up a client
+ConnectConfig connectConfig = ConnectConfig.builder()
+        .uri("http://localhost:19530")
+        .token("root:Milvus")
+        .build();
+        
+MilvusClientV2 client = new MilvusClientV2(connectConfig);
+
+// 2. Describe a role
+DescribeRoleReq describeRoleReq = DescribeRoleReq.builder()
+        .roleName("test")
+        .build();
+client.describeRole(describeRoleReq);
+```

API_Reference/milvus-sdk-java/v2.5.x/Authentication/describeUser.md

@@ -0,0 +1,52 @@
+# describeUser()
+
+This operation describes a specific user.
+
+```java
+public DescribeUserResp describeUser(DescribeUserReq request)
+```
+
+## Request Syntax
+
+```java
+describeUser(DescribeUserReq.builder()
+    .userName(String userName)
+    .build()
+)
+```
+
+**BUILDER METHODS:**
+
+- `userName(String userName)`
+
+    The name of the user to describe.
+
+**RETURN TYPE:**
+
+*DescribeUserResp*
+
+**RETURNS:**
+
+A **DescribeUserResp** object containing the details of the user.
+
+**PARAMETERS:**
+
+- **roles** (*List\<String\>*) -
+
+    A list of role names associated with the user.
+
+**EXCEPTIONS:**
+
+- **MilvusClientExceptions**
+
+    This exception will be raised when any error occurs during this operation.
+
+## Example
+
+```java
+DescribeUserReq describeUserReq = DescribeUserReq.builder()
+        .userName("test")
+        .build();
+DescribeUserResp describeUserResp = client.describeUser(describeUserReq);
+```
+

API_Reference/milvus-sdk-java/v2.5.x/Authentication/dropRole.md

@@ -0,0 +1,41 @@
+# dropRole()
+
+This operation drops a custom role.
+
+```java
+public void dropRole(DropRoleReq request)
+```
+
+## Request Syntax
+
+```java
+dropRole(DropRoleReq.builder()
+    .roleName(String roleName)
+    .build()
+)
+```
+
+**BUILDER METHODS:**
+
+- `roleName(String roleName)`
+
+    The name of the role to drop.
+
+**RETURNS:**
+
+*void*
+
+**EXCEPTIONS:**
+
+- **MilvusClientExceptions**
+
+    This exception will be raised when any error occurs during this operation.
+
+## Example
+
+```java
+DropRoleReq dropRoleReq = DropRoleReq.builder()
+        .roleName("test")
+        .build();
+client.dropRole(dropRoleReq);
+```

API_Reference/milvus-sdk-java/v2.5.x/Authentication/dropUser.md

@@ -0,0 +1,41 @@
+# dropUser()
+
+This operation drops a user.
+
+```java
+public void dropUser(DropUserReq request)
+```
+
+## Request Syntax
+
+```java
+dropUser(DropUserReq.builder()
+    .userName(String userName)
+    .build()
+)
+```
+
+**BUILDER METHODS:**
+
+- `userName(String userName)`
+
+    The name of the user to drop.
+
+**RETURNS:**
+
+*void*
+
+**EXCEPTIONS:**
+
+- **MilvusClientExceptions**
+
+    This exception will be raised when any error occurs during this operation.
+
+## Example
+
+```java
+DropUserReq dropUserReq = DropUserReq.builder()
+        .userName("test")
+        .build();
+client.dropUser(dropUserReq);
+```