Skip to content

docs: sync tab groups in reference documentation #1039

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 3, 2025
Merged

docs: sync tab groups in reference documentation #1039

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 24 additions & 8 deletions docs/reference/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,9 @@ Refer to the [*Installation*](/reference/installation.md) page to learn more.
### Connecting [_connecting]

:::::::{tab-set}

:group: apis
::::::{tab-item} Low-level API
:sync: lowLevel
You can connect to the Elastic Cloud using an API key and the Elasticsearch endpoint for the low level API:

```go
Expand All @@ -40,6 +41,7 @@ client, err := elasticsearch.NewClient(elasticsearch.Config{
::::::

::::::{tab-item} Fully-typed API
:sync: typed
You can connect to the Elastic Cloud using an API key and the Elasticsearch endpoint for the fully-typed API:

```go
Expand Down Expand Up @@ -70,8 +72,9 @@ Time to use Elasticsearch! This section walks you through the basic, and most im
#### Creating an index [_creating_an_index]

:::::::{tab-set}

:group: apis
::::::{tab-item} Low-level API
:sync: lowLevel
This is how you create the `my_index` index with the low level API:

```go
Expand All @@ -80,6 +83,7 @@ client.Indices.Create("my_index")
::::::

::::::{tab-item} Fully-typed API
:sync: typed
This is how you create the `my_index` index with the fully-typed API:

```go
Expand All @@ -92,8 +96,9 @@ typedClient.Indices.Create("my_index").Do(context.TODO())
#### Indexing documents [_indexing_documents]

:::::::{tab-set}

:group: apis
::::::{tab-item} Low-level API
:sync: lowLevel
This is a simple way of indexing a document by using the low-level API:

```go
Expand All @@ -108,6 +113,7 @@ client.Index("my_index", bytes.NewReader(data))
::::::

::::::{tab-item} Fully-typed API
:sync: typed
This is a simple way of indexing a document by using the fully-typed API:

```go
Expand All @@ -128,8 +134,9 @@ typedClient.Index("my_index").
#### Getting documents [_getting_documents]

:::::::{tab-set}

:group: apis
::::::{tab-item} Low-level API
:sync: lowLevel
You can get documents by using the following code with the low-level API:

```go
Expand All @@ -138,6 +145,7 @@ client.Get("my_index", "id")
::::::

::::::{tab-item} Fully-typed API
:sync: typed
This is how you can get documents by using the fully-typed API:

```go
Expand All @@ -150,8 +158,9 @@ typedClient.Get("my_index", "id").Do(context.TODO())
#### Searching documents [_searching_documents]

:::::::{tab-set}

:group: apis
::::::{tab-item} Low-level API
:sync: lowLevel
This is how you can create a single match query with the low-level API:

```go
Expand All @@ -164,6 +173,7 @@ client.Search(
::::::

::::::{tab-item} Fully-typed API
:sync: typed
This is how you can perform a single match query with the fully-typed API:

```go
Expand All @@ -181,8 +191,9 @@ typedClient.Search().
#### Updating documents [_updating_documents]

:::::::{tab-set}

:group: apis
::::::{tab-item} Low-level API
:sync: lowLevel
This is how you can update a document, for example to add a new field, by using the low-level API:

```go
Expand All @@ -191,6 +202,7 @@ client.Update("my_index", "id", strings.NewReader(`{doc: { language: "Go" }}`))
::::::

::::::{tab-item} Fully-typed API
:sync: typed
This is how you can update a document with the fully-typed API:

```go
Expand All @@ -206,14 +218,16 @@ typedClient.Update("my_index", "id").
#### Deleting documents [_deleting_documents]

:::::::{tab-set}

:group: apis
::::::{tab-item} Low-level API
:sync: lowLevel
```go
client.Delete("my_index", "id")
```
::::::

::::::{tab-item} Fully-typed API
:sync: typed
```go
typedClient.Delete("my_index", "id").Do(context.TODO())
```
Expand All @@ -224,14 +238,16 @@ typedClient.Delete("my_index", "id").Do(context.TODO())
#### Deleting an index [_deleting_an_index]

:::::::{tab-set}

:group: apis
::::::{tab-item} Low-level API
:sync: lowLevel
```go
client.Indices.Delete([]string{"my_index"})
```
::::::

::::::{tab-item} Fully-typed API
:sync: typed
```go
typedClient.Indices.Delete("my_index").Do(context.TODO())
```
Expand Down
4 changes: 3 additions & 1 deletion docs/reference/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,9 @@ Full documentation is hosted at [GitHub](https://github.com/elastic/go-elasticse
## Usage [_usage]

:::::::{tab-set}

:group: apis
::::::{tab-item} Low-level API
:sync: lowLevel
```go
package main

Expand All @@ -41,6 +42,7 @@ func main() {
::::::

::::::{tab-item} Fully-typed API
:sync: typed
```go
package main

Expand Down
Loading