Update description in LDAP BBEs

ballerina-platform · Aug 13, 2024 · 3a43320 · 3a43320
1 parent d3abec7
commit 3a43320
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 12 deletions.
diff --git a/examples/ldap-add-remove-entry/ldap_add_remove_entry.bal b/examples/ldap-add-remove-entry/ldap_add_remove_entry.bal
@@ -1,16 +1,18 @@
-import ballerina/ldap;
 import ballerina/io;
+import ballerina/ldap;
 
 public function main() returns error? {
- ldap:Client ldap = check new({
+ // Initializes a new LDAP client with credentials.
+ ldap:Client ldapClient = check new ({
  hostName: "localhost",
  port: 389,
  domainName: "cn=admin,dc=example,dc=com",
  password: "adminpassword"
  });
 
- ldap:LdapResponse addResponse = check ldap->add(
- "cn=user,dc=example,dc=com", 
+ // Adds an entry to the directory server.
+ ldap:LdapResponse addResponse = check ldapClient->add(
+ "cn=user,dc=example,dc=com",
  {
  "objectClass": ["top", "person"],
  "sn": "user",
@@ -19,6 +21,7 @@ public function main() returns error? {
  );
  io:println("Add Response: ", addResponse.resultCode);
 
- ldap:LdapResponse deleteResponse = check ldap->delete("cn=user,dc=example,dc=com");
+ // Deletes an entry from the directory server.
+ ldap:LdapResponse deleteResponse = check ldapClient->delete("cn=user,dc=example,dc=com");
  io:println("Delete Response: ", deleteResponse.resultCode);
 }
diff --git a/examples/ldap-add-remove-entry/ldap_add_remove_entry.md b/examples/ldap-add-remove-entry/ldap_add_remove_entry.md
@@ -1,4 +1,4 @@
-# LDAP Client - Add/Remove entries
+# LDAP client - Add/Remove entries
 
 The `ldap:Client` connects to a directory server and performs various operations on directories. Currently, it supports the generic LDAP operations; `add`, `modify`, `modifyDN`, `compare`, `search`, `searchWithType`, `delete`, and `close`.
 

diff --git a/examples/ldap-search-entry copy/ldap_search_entry.bal b/examples/ldap-search-entry copy/ldap_search_entry.bal
@@ -1,19 +1,20 @@
-import ballerina/ldap;
 import ballerina/io;
+import ballerina/ldap;
 
 public function main() returns error? {
- ldap:Client ldap = check new({
+ // Initialized a new LDAP client.
+ ldap:Client ldapClient = check new ({
  hostName: "localhost",
  port: 389,
  domainName: "cn=admin,dc=example,dc=com",
  password: "adminpassword"
  });
 
- ldap:SearchResult searchResult = check ldap->search(
- "cn=user,dc=example,dc=com", 
+ // Searches for an entry in the directory server.
+ ldap:SearchResult searchResult = check ldapClient->search(
+ "cn=user,dc=example,dc=com",
  "(sn=user)",
  ldap:SUB
  );
-
  io:println("Search Response: ", searchResult.resultCode);
 }
diff --git a/examples/ldap-search-entry copy/ldap_search_entry.md b/examples/ldap-search-entry copy/ldap_search_entry.md
@@ -1,4 +1,4 @@
-# LDAP Client - Seacrh for an entry
+# LDAP client - Seacrh for an entry
 
 The `ldap:Client` connects to a directory server and performs various operations on directories. Currently, it supports the main LDAP operations; `add`, `modify`, `modifyDN`, `compare`, `search`, `searchWithType`, `delete`, and `close`.