Skip to content

Commit b0a2ae7

Browse files
authored
Add versioning section to readme and docs (#8582)
1 parent 5cc3ed3 commit b0a2ae7

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,20 @@ or
1010
**for a free trial of Elastic Cloud**.
1111

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

18+
## Versioning
19+
20+
The *major* and *minor* version parts of the Elasticsearch .NET client are dictated by the version of the Elasticsearch server.
21+
22+
> [!WARNING]
23+
> This means that the Elasticsearch .NET client **does not** strictly follows semantic versioning!
24+
>
25+
> 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.
26+
1827
## Compatibility
1928

2029
Language clients are **forward compatible**:

0 commit comments

Comments
 (0)