исправление документации

README.md

@@ -1,7 +1,14 @@
 # cgpcli
 
+[![Go Reference](https://pkg.go.dev/badge/git.vsu.ru/ai/cgpcli.svg)](https://pkg.go.dev/git.vsu.ru/ai/cgpcli)
+[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](LICENSE.md)
+
 `cgpcli` is a Go client library for the **CommuniGate Pro** CLI. It provides a reliable bridge between CGP's unique syntax and native Go types with a focus on efficiency and correct type mapping.
 
+## Documentation
+
+Full API documentation and usage examples are available at [pkg.go.dev](https://pkg.go.dev/git.vsu.ru/ai/cgpcli).
+
 ## Installation
 
 ```bash

build

@@ -40,12 +40,12 @@ elif [ "$1" == "sandbox-test-one" ]; then
 
     echo ""
     echo "--- Running tests on sandbox ---"
-    ssh "${REMOTE_HOST}" "cd ${REMOTE_PATH} && ./build test-once $2"
+    ssh "${REMOTE_HOST}" "cd ${REMOTE_PATH} && ./build test-one $2"
 
 elif [ "$1" == "test" ]; then
     . .env
     go test -v
-elif [ "$1" == "test-once" ]; then
+elif [ "$1" == "test-one" ]; then
     . .env
     go test -v -run $2
 elif [ "$1" == "bench" ]; then

cmd/test_account/main.go

@@ -20,7 +20,7 @@ func main() {
 
 	if mode == "ro" {
 		suffix = "_RO"
-		defaultAccount = "testadmin@vsu.ru" // или любой другой боевой
+		defaultAccount = "testadmin@domain.name"
 		fmt.Println(">>> MODE: READ-ONLY (PRODUCTION) <<<")
 	} else {
 		fmt.Println(">>> MODE: LOCAL TEST <<<")

cmd/test_alert/main.go

@@ -36,8 +36,6 @@ func main() {
 
 	// 2. Читаем алерты
 	fmt.Println("\n--- GETSERVERALERTS (Checking types) ---")
-	// Пока используем GetServerAlerts, который возвращает map[string]any (или уже map[string]string?)
-	// Чтобы увидеть "сырые" типы от парсера, проверим через Any.
 	res, err := cli.Query("GETSERVERALERTS")
 	if err != nil {
 		log.Fatalf("Get error: %v", err)

cmd/test_dir/main.go

@@ -32,7 +32,6 @@ func main() {
 	}
 
 	fmt.Println("\n--- Directory Integration ---")
-	// Настройки интеграции (LDAP, Active Directory и т.д.)
 	integration, err := cli.Query("GETDIRECTORYINTEGRATION")
 	if err != nil {
 		fmt.Printf("GetIntegration error: %v\n", err)

cmd/test_list/main.go

@@ -28,7 +28,6 @@ func main() {
 	fmt.Println("--- Testing LISTDOMAINOBJECTS with Enum Flags ---")
 
 	// 3. Вызов функции с использованием битовой маски
-	// Например: запрашиваем Аккаунты и Форвардеры, игнорируя Алиасы
 	mask := cgpcli.TypeAccount | cgpcli.TypeForwarder | cgpcli.TypeAlias
 
 	res, err := cli.ListDomainObjects("test.domain.name", 100, "", mask, "")
@@ -36,14 +35,13 @@ func main() {
 		log.Fatalf("ListDomainObjects error: %v", err)
 	}
 
-	// 4. Красивый вывод через нашу утилиту
+	// 4. Красивый вывод
 	fmt.Println("\nStructure via PrettyPrint:")
 	cgpcli.PrettyPrint(res)
 
 	// 5. Демонстрация работы с типизированными данными
 	fmt.Printf("\n--- Summary (Total: %d, Cookie: '%s') ---\n", res.Total, res.Cookie)
 
-	// Сортируем ключи для красивого вывода в консоль
 	keys := make([]string, 0, len(res.Objects))
 	for k := range res.Objects {
 		keys = append(keys, k)
@@ -53,7 +51,6 @@ func main() {
 	for _, name := range keys {
 		obj := res.Objects[name]
 
-		// Благодаря Enum мы можем делать чистые проверки
 		typeLabel := obj.Type.String()
 
 		if len(obj.Targets) > 0 {

cmd/test_listallstats/main.go

@@ -10,7 +10,6 @@ import (
 )
 
 func main() {
-	// Используем переменные окружения из ваших тестов
 	cgpuser := os.Getenv("CGPUSER")
 	cgppass := os.Getenv("CGPPASS")
 
@@ -18,7 +17,6 @@ func main() {
 		log.Fatal("Error: please set CGPUSER and CGPPASS environment variables")
 	}
 
-	// Используем ваш конструктор New (APOP, без TLS для теста на 127.0.0.1)
 	cli, err := cgpcli.New("127.0.0.1", cgpuser, cgppass, cgpcli.APOP, false)
 	if err != nil {
 		log.Fatalf("Failed to connect: %v", err)
@@ -28,13 +26,11 @@ func main() {
 	fmt.Println("Connected to 127.0.0.1. Enumerating OIDs...")
 	fmt.Println(strings.Repeat("-", 40))
 
-	// Запрашиваем список
 	stats, err := cli.ListAllStats()
 	if err != nil {
 		log.Fatalf("Error during enumeration: %v", err)
 	}
 
-	// Выводим с порядковыми номерами
 	for i, name := range stats {
 		fmt.Printf("%04d | %s\n", i+1, name)
 	}

cmd/test_utf8/main.go

@@ -18,7 +18,6 @@ func main() {
 	}
 
 	// 2. Инициализация клиента
-	// Используем ваш конструктор New
 	cli, err := cgpcli.New("127.0.0.1", cgpuser, cgppass, cgpcli.APOP, false)
 	if err != nil {
 		log.Fatalf("Failed to connect: %v", err)
@@ -31,7 +30,6 @@ func main() {
 	fmt.Printf("Updating RealName for %s to: %s\n", targetAccount, russianName)
 
 	// 1. Устанавливаем русское имя
-	// UpdateAccountSettings отправляет данные через Marshal
 	err = cli.UpdateAccountSettings(targetAccount, map[string]any{
 		"RealName": russianName,
 	})

domains.go

@@ -66,25 +66,20 @@ func (cli *Cli) CreateAccountStorage(domain, storage string) error {
 // DeleteDirectoryRecords deletes Domain object records from the Directory.
 //
 // Parameters:
-//   - domain: the Domain name. If empty, applies to the authenticated user Domain.
+//   - domain: an optional Domain name. If empty, applies to the authenticated user Domain.
 //
 // This method executes the DELETEDIRECTORYRECORDS CLI command.
 //
 // Returns:
 //   - error: an error if the command fails.
 func (cli *Cli) DeleteDirectoryRecords(domain string) error {
-	const cmd = "DELETEDIRECTORYRECORDS"
-	if domain != "" {
-		return cli.QueryNV(cmd, domain)
-	} else {
-		return cli.QueryNV(cmd)
-	}
+	return cli.QueryNV("DELETEDIRECTORYRECORDS", Atom(domain))
 }
 
 // GetAccountDefaultPrefs retrieves the Default Account Preferences for the specified Domain.
 //
 // Parameters:
-//   - domain: the Domain name. If empty, applies to the administrator Domain.
+//   - domain: an optional Domain name. If empty, applies to the administrator Domain.
 //
 // This method executes the GETACCOUNTDEFAULTPREFS CLI command.
 //
@@ -98,7 +93,7 @@ func (cli *Cli) GetAccountDefaultPrefs(domain string) (map[string]any, error) {
 // GetAccountDefaults retrieves the default Account settings for the specified Domain.
 //
 // Parameters:
-//   - domain: the Domain name. If empty, applies to the administrator Domain.
+//   - domain: an optional Domain name. If empty, applies to the administrator Domain.
 //
 // This method executes the GETACCOUNTDEFAULTS CLI command.
 //
@@ -143,7 +138,7 @@ func (cli *Cli) GetDomainAliases(domain string) ([]string, error) {
 // GetDomainEffectiveSettings retrieves both explicitly set and default Domain settings.
 //
 // Parameters:
-//   - domain: the name of an existing Domain. If empty, uses the current context.
+//   - domain: an optional name of an existing Domain. If empty, uses the current context.
 //
 // This method executes the GETDOMAINEFFECTIVESETTINGS CLI command.
 //
@@ -188,7 +183,7 @@ func (cli *Cli) GetDomainMailRules(domain string) ([]MailRule, error) {
 // GetDomainSettings retrieves explicitly set (non-default) Domain settings.
 //
 // Parameters:
-//   - domain: the name of an existing Domain. If empty, uses the current context.
+//   - domain: an optional name of an existing Domain. If empty, uses the current context.
 //
 // This method executes the GETDOMAINSETTINGS CLI command.
 //
@@ -219,7 +214,7 @@ func (cli *Cli) GetDomainSignalRules(domain string) ([]SignalRule, error) {
 // InsertDirectoryRecords inserts records for Domain objects into the Directory.
 //
 // Parameters:
-//   - domain: the Domain name. If empty, applies to the authenticated user Domain.
+//   - domain: an optional Domain name. If empty, applies to the authenticated user Domain.
 //
 // This method executes the INSERTDIRECTORYRECORDS CLI command.
 //
@@ -561,7 +556,7 @@ func (cli *Cli) SuspendDomain(domain string) error {
 // UpdateAccountDefaultPrefs modifies the Domain Default Account Preferences.
 //
 // Parameters:
-//   - domain: the Domain name. If empty, applies to the authenticated user Domain.
+//   - domain: an optional Domain name. If empty, applies to the authenticated user Domain.
 //   - settings: a dictionary used to modify the Domain Default Account Preferences.
 //
 // This method executes the UPDATEACCOUNTDEFAULTPREFS CLI command.
@@ -578,7 +573,7 @@ func (cli *Cli) UpdateAccountDefaultPrefs(domain string, settings map[string]any
 // UpdateAccountDefaults modifies the Default Account settings for the specified Domain.
 //
 // Parameters:
-//   - domain: the Domain name. If empty, applies to the administrator Domain.
+//   - domain: an optional Domain name. If empty, applies to the administrator Domain.
 //   - settings: a dictionary used to modify the Domain Default Account settings.
 //
 // This method executes the UPDATEACCOUNTDEFAULTS CLI command.
@@ -595,7 +590,7 @@ func (cli *Cli) UpdateAccountDefaults(domain string, settings map[string]any) er
 // UpdateAccountTemplate modifies the Account Template settings for the Domain.
 //
 // Parameters:
-//   - domain: the Domain name. If empty, applies to the administrator Domain.
+//   - domain: an optional Domain name. If empty, applies to the administrator Domain.
 //   - settings: a dictionary used to modify the Domain Account Template.
 //
 // This method executes the UPDATEACCOUNTTEMPLATE CLI command.
@@ -612,7 +607,7 @@ func (cli *Cli) UpdateAccountTemplate(domain string, settings map[string]any) er
 // UpdateDomainSettings updates specific Domain settings without modifying others.
 //
 // Parameters:
-//   - domain: the name of an existing Domain. If empty, uses the current context.
+//   - domain: an optional name of an existing Domain. If empty, uses the current context.
 //   - settings: a dictionary containing the settings to update.
 //
 // This method executes the UPDATEDOMAINSETTINGS CLI command.

domains_test.go

@@ -129,6 +129,12 @@ func TestDomainAdministration(t *testing.T) {
 		if err := cli.DeleteDirectoryRecords(targetDomain); err != nil {
 			t.Errorf("DeleteDirectoryRecords failed: %v", err)
 		}
+		if err := cli.InsertDirectoryRecords(""); err != nil {
+			t.Errorf("InsertDirectoryRecords failed: %v", err)
+		}
+		if err := cli.DeleteDirectoryRecords(""); err != nil {
+			t.Errorf("DeleteDirectoryRecords failed: %v", err)
+		}
 	})
 
 	// 7. Состояние домена