Skip to content

Commit

Permalink
Update documentation with new APIs
Browse files Browse the repository at this point in the history
  • Loading branch information
Nuvindu committed Jun 7, 2024
1 parent b72e78f commit 65e94b5
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 32 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ The Ballerina LDAP module provides the capability to efficiently connect, authen

- **add**: Creates an entry in a directory server.
- **modify**: Updates information of an entry in a directory server.
- **getEntry**: Gets information of an entry in a directory server.
- **delete**: Removes an entry in a directory server.
- **getEntry**: Gets information about an entry in a directory server.
- **delete**: Removes an entry from a directory server.

#### `add` API

Expand Down Expand Up @@ -52,7 +52,7 @@ public function main() returns error? {

#### `getEntry` API

Gets information of an entry
Gets information about an entry in a directory server.

```ballerina
import ballerina/ldap;
Expand All @@ -64,7 +64,7 @@ public function main() returns error? {

#### `delete` API

Removes an entry in a directory server.
Removes an entry from a directory server.

```ballerina
import ballerina/ldap;
Expand Down
28 changes: 14 additions & 14 deletions ballerina/Module.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ The Ballerina LDAP module provides the capability to efficiently connect, authen

- **add**: Creates an entry in a directory server.
- **modify**: Updates information of an entry in a directory server.
- **getEntry**: Gets information of an entry in a directory server.
- **delete**: Removes an entry in a directory server.
- **getEntry**: Gets information about an entry in a directory server.
- **delete**: Removes an entry from a directory server.

#### `add` API

Expand All @@ -20,13 +20,13 @@ import ballerina/ldap;
public function main() returns error? {
anydata user = {
objectClass: ["user", "organizationalPerson", "person", "top"],
sn: "New User",
cn: "New User",
givenName: "New User",
displayName: "New User",
userPrincipalName: "[email protected]",
userAccountControl: "544"
"objectClass": "user",
"sn": "New User",
"cn": "New User",
"givenName": "New User",
"displayName": "New User",
"userPrincipalName": "[email protected]",
"userAccountControl": "544"
};
ldap:LDAPResponse val = check ldapClient->add(userDN, user);
}
Expand All @@ -41,17 +41,17 @@ import ballerina/ldap;
public function main() returns error? {
anydata user = {
sn: "User",
givenName: "Updated User",
displayName: "Updated User"
"sn": "User",
"givenName": "Updated User",
"displayName": "Updated User"
};
_ = check ldapClient->modify(userDN, user);
}
```

#### `getEntry` API

Gets information of an entry
Gets information about an entry in a directory server.

```ballerina
import ballerina/ldap;
Expand All @@ -63,7 +63,7 @@ public function main() returns error? {

#### `delete` API

Removes an entry in a directory server.
Removes an entry from a directory server.

```ballerina
import ballerina/ldap;
Expand Down
28 changes: 14 additions & 14 deletions ballerina/Package.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ The Ballerina LDAP module provides the capability to efficiently connect, authen

- **add**: Creates an entry in a directory server.
- **modify**: Updates information of an entry in a directory server.
- **getEntry**: Gets information of an entry in a directory server.
- **delete**: Removes an entry in a directory server.
- **getEntry**: Gets information about an entry in a directory server.
- **delete**: Removes an entry from a directory server.

#### `add` API

Expand All @@ -20,13 +20,13 @@ import ballerina/ldap;
public function main() returns error? {
anydata user = {
objectClass: ["user", "organizationalPerson", "person", "top"],
sn: "New User",
cn: "New User",
givenName: "New User",
displayName: "New User",
userPrincipalName: "[email protected]",
userAccountControl: "544"
"objectClass": "user",
"sn": "New User",
"cn": "New User",
"givenName": "New User",
"displayName": "New User",
"userPrincipalName": "[email protected]",
"userAccountControl": "544"
};
ldap:LDAPResponse val = check ldapClient->add(userDN, user);
}
Expand All @@ -41,17 +41,17 @@ import ballerina/ldap;
public function main() returns error? {
anydata user = {
sn: "User",
givenName: "Updated User",
displayName: "Updated User"
"sn": "User",
"givenName": "Updated User",
"displayName": "Updated User"
};
_ = check ldapClient->modify(userDN, user);
}
```

#### `getEntry` API

Gets information of an entry
Gets information about an entry in a directory server.

```ballerina
import ballerina/ldap;
Expand All @@ -63,7 +63,7 @@ public function main() returns error? {

#### `delete` API

Removes an entry in a directory server.
Removes an entry from a directory server.

```ballerina
import ballerina/ldap;
Expand Down

0 comments on commit 65e94b5

Please sign in to comment.