Skip to content

[8.19] Add versioning section to readme and docs #8582

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
Jun 16, 2025
Merged

[8.19] Add versioning section to readme and docs #8582

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
13 changes: 11 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,20 @@ or
**for a free trial of Elastic Cloud**.

The .NET client for Elasticsearch provides strongly typed requests and responses
for Elasticsearch APIs. It delegates protocol handling to the
[Elastic.Transport](https://github.com/elastic/elastic-transport-net) library,
for Elasticsearch APIs. It delegates protocol handling to the
[Elastic.Transport](https://github.com/elastic/elastic-transport-net) library,
which takes care of all transport-level concerns (HTTP connection establishment
and pooling, retries, etc.).

## Versioning

The *major* and *minor* version parts of the Elasticsearch .NET client are dictated by the version of the Elasticsearch server.

> [!WARNING]
> This means that the Elasticsearch .NET client **does not** strictly follows semantic versioning!
>
> Although we try to avoid this as much as possible, it can happen that a *minor* or even *patch* version contains breaking changes (see also: [breaking changes policy](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/breaking-changes-policy.html)). Please always check the [release notes](https://github.com/elastic/elasticsearch-net/releases) before updating the client package.

## Compatibility

Language clients are **forward compatible**:
Expand Down