The OpenSearch mapping APIs — the endpoints tagged Mappings in the OpenSearch OpenAPI specification.

Built on Dowser.Client. Required OpenSearch attributes are positional arguments; everything optional lives in opts.

OpenSearch tags these separately from the index APIs, so they live here rather than on Dowser.Opensearch.Index; the index-target helper they share is Dowser.Opensearch.Target.

Note that a mapping fetched through get_mapping/1 is not what Dowser.Opensearch.Codec casts against — that one comes from Dowser.Opensearch.MappingCacher, which caches it per index and context.

Shared conventions

• An index target may be nil (all indices), a single index/alias/ data-stream name (string or atom), or a list of them (joined with ,). put_mapping/3 requires one and takes it as an argument; the reads take it as the :index option.
• Endpoints that accept a request body take it as their first argument, required — pass %{} to send nothing.

All remaining options are forwarded to Dowser.Client.request/4, e.g. :context, :params (query-string parameters), :format, :keys and :http_opts (including :headers) — plus :codec, this package's own, which picks the per-field codec for this one request (see Dowser.Opensearch.Codec).

On a 2xx response every function returns {:ok, body} with the decoded response body. A non-2xx response returns {:error, %Dowser.Opensearch.Error{}}; a transport, encoding or decoding failure returns {:error, exception} from Dowser.Client. A required argument that is missing or empty is reported the same way, before any request is made: {:error, %ArgumentError{}}. Each function has a bang variant that returns the body directly or raises the error exception.