Skip to content

Commit 24fd4a7

Browse files
committed
Update mod-level documentation
1 parent b8f36ad commit 24fd4a7

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

src/lib.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@
6666
//! ## Metadata queries
6767
//!
6868
//! Retrieve a list of time series that match a certain label set by providing one or more series [`Selector`]s.
69+
//! More metadata queries are available, e.g. methods to retrieve label names and values.
6970
//!
7071
//! ```rust
7172
//! use prometheus_http_query::{Client, Selector};
@@ -147,13 +148,14 @@
147148
//! Also make sure that default features of `prometheus-http-query` are disabled if you choose a TLS library other than
148149
//! the default:
149150
//!
150-
//! `prometheus-http-query = { version = "0.6", default-features = false, features = ["rustls-tls"] }`
151+
//! `prometheus-http-query = { version = "0.7", default-features = false, features = ["rustls-tls"] }`
151152
//!
152153
//! # Compatibility
153154
//!
154155
//! The crate is generally compatible with Prometheus server >=2.30. However individual [`Client`] methods might
155156
//! only work with the latest Prometheus server version when the corresponding API endpoint has only recently
156157
//! been introduced.<br>
158+
//! The minimum recommended Prometheus server version is v2.46.<br>
157159
//! Also some features may only work when the Prometheus server is started with certain flags. An example
158160
//! are query statistics that can be enabled via [`RangeQueryBuilder::stats`]. The response
159161
//! will not contain per-step stats unless Prometheus is started with `--enable-feature=promql-per-step-stats`.

0 commit comments

Comments
 (0)