This is the version-history index for the OpenSearch Go client. Each entry below covers what changed in a given release line and what a caller must do when jumping to it. Pick the file matching the major version you are upgrading to.
| Upgrade target | Guide |
|---|---|
>= 5.0.0 |
UPGRADING_V5.md |
>= 4.0.0 |
UPGRADING_V4.md |
>= 3.0.0 |
UPGRADING_V3.md |
>= 2.3.0 |
UPGRADING_V2.md |
Upgrading from the hand-written v4 opensearchapi/ package to the code-generated v5 surface is the largest single change in v5. UPGRADING_V5.md summarizes it; for the field-level delta (every rename, the *Params change, embedded TimeoutParams/DebugParams, BulkResp.Items becoming []BulkItem) and the optional forward-compatible replace directive, see the deep-dive at opensearchapi/UPGRADING_V4_TO_V5.md.
The osapilint tool automates most of this delta (import bump, type/method/field renames, value-to-pointer adjustments); see the Automated migration section.
The v4 opensearchapi/ package keeps the v3 client and its sub-clients unchanged, so most call sites only need the new import path. The one change needing a human hand is the error model, which moved out of opensearchapi into the root opensearch package (UPGRADING_V4.md covers it). For the tool-assisted delta - the import bump, the error-model follow-ups, and the response/transport fields the tool reports rather than rewrites - see the deep-dive at opensearchapi/UPGRADING_V3_TO_V4.md and its Automated migration section.
v3.0.0 is the project's largest structural boundary: the function-based request API (opensearchapi.<X>Request{...}.Do(ctx, client)) became a typed sub-client API (client.<Group>.<Op>(ctx, <X>Req{...})), and the root client lost its API method fields. UPGRADING_V3.md walks the client-creation, request, response, and error-handling changes with before/after examples. osapilint assists but does not fully automate this hop - it bumps the import path, rewrites the two seed root-client ops best-effort, and reports the rest as manual worklist items; see the Automated migration section.
COMPATIBILITY.md- client/server version support matrix.opensearchapi/README.md- everyday usage (errors, routing, response handling).guides/README.md- task-oriented guides.