Skip to content

Commit 8ad54ba

Browse files
committed
docs(opensearchapi): point the sub-client table at the authoritative catalog
The README's Sub-Clients table and the package doc (doc.go, rendered on pkg.go.dev) both enumerate the sub-clients, risking drift. Frame the README table as a quick-scan cheat sheet and link to the package overview's Sub-clients section on pkg.go.dev as the authoritative catalog for the partition model, alias fields, and name-collision semantics -- which doc.go now owns. Also align the Client Creation password placeholder with the rest of the docs (myStrongPassword123!). Signed-off-by: Sean Chittenden <sean.chittenden@crowdstrike.com>
1 parent 7190bfd commit 8ad54ba

1 file changed

Lines changed: 5 additions & 2 deletions

File tree

opensearchapi/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ client, err := opensearchapi.NewClient(opensearchapi.Config{
1818
Client: opensearch.Config{
1919
Addresses: []string{"https://localhost:9200"},
2020
Username: "admin",
21-
Password: "admin",
21+
Password: "myStrongPassword123!",
2222
},
2323
})
2424

@@ -76,7 +76,10 @@ client.Search(ctx, nil) // searches all indices with default params
7676

7777
## Sub-Clients
7878

79-
Operations are grouped into sub-clients that mirror the OpenSearch API namespaces:
79+
Operations are grouped into sub-clients that mirror the OpenSearch API namespaces. The table
80+
below is a quick-scan cheat sheet; the [package overview on pkg.go.dev](https://pkg.go.dev/github.com/opensearch-project/opensearch-go/v5/opensearchapi#hdr-Sub_clients)
81+
is the authoritative catalog, with the partition model, alias fields, and name-collision
82+
semantics.
8083

8184
| Sub-Client | Example Call |
8285
| ---------------------------- | ----------------------------------------------- |

0 commit comments

Comments
 (0)