Apply review suggestions for LDAP BBEs

ballerina-platform · Aug 21, 2024 · 70cac9c · 70cac9c
1 parent 7375592
commit 70cac9c
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 19 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
@@ -3,12 +3,12 @@ import ballerina/ldap;
 
 public function main() returns error? {
     // 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:Client ldapClient = check new (
+        hostName = "localhost",
+        port = 389,
+        domainName = "cn=admin,dc=example,dc=com",
+        password = "adminpassword"
+    );
 
     // Creates an `ldap:Entry` record for the new entry.
     ldap:Entry addEntry = {

diff --git a/examples/ldap-add-remove-entry/ldap_add_remove_entry.md b/examples/ldap-add-remove-entry/ldap_add_remove_entry.md
@@ -9,14 +9,14 @@ The `delete` operation removes an entry from a directory server. It requires a `
 ::: code ldap_add_remove_entry.bal :::
 
 ## Prerequisites
-
-- Make sure to keep an LDAP server up and running while running the example.
+- Ensure that an LDAP server is up and running locally on port 389 while running the example.
 
 - Run the example by executing the command below.
 
 ::: out ldap_add_remove_entry.server.out :::
 
 ## Related links
-
-- [`ldap:Client` - API documentation](https://lib.ballerina.io/ballerina/ldap/latest#Client)
+- [`ldap:Client` `add` operation - API documentation](https://central.ballerina.io/ballerina/ldap/latest#Client-add)
+- [`ldap:Client` `delete` operation - API documentation](https://central.ballerina.io/ballerina/ldap/latest#Client-delete)
 - [`ldap` module - API documentation](https://lib.ballerina.io/ballerina/ldap/latest/)
+- [`ldap:Client` - Specification](/spec/ldap/#2-ldap-client)
diff --git a/examples/ldap-search-entry/ldap_search_entry.bal b/examples/ldap-search-entry/ldap_search_entry.bal
@@ -2,13 +2,13 @@ import ballerina/io;
 import ballerina/ldap;
 
 public function main() returns error? {
-    // Initializes a new LDAP client.
-    ldap:Client ldapClient = check new ({
-        hostName: "localhost",
-        port: 389,
-        domainName: "cn=admin,dc=example,dc=com",
-        password: "adminpassword"
-    });
+    // 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"
+    );
 
     // Searches for an entry in the directory server.
     ldap:SearchResult searchResult = check ldapClient->search(

diff --git a/examples/ldap-search-entry/ldap_search_entry.md b/examples/ldap-search-entry/ldap_search_entry.md
@@ -13,12 +13,13 @@ When a directory server processes a valid search request, it finds entries withi
 ::: code ldap_search_entry.bal :::
 
 ## Prerequisites
-- Make sure to keep an LDAP server up and running while running the example.
+- Ensure that an LDAP server is up and running locally on port 389 while running the example.
 
 - Run the example by executing the command below.
 
 ::: out ldap_search_entry.server.out :::
 
 ## Related links
-- [`ldap:Client` - API documentation](https://lib.ballerina.io/ballerina/ldap/latest#Client)
+- [`ldap:Client` `search` operation - API documentation](https://central.ballerina.io/ballerina/ldap/latest#Client-search)
 - [`ldap` module - API documentation](https://lib.ballerina.io/ballerina/ldap/latest/)
+- [`ldap:Client` - Specification](/spec/ldap/#2-ldap-client)