Skip to content

Commit

Permalink
docs: Remove section on overriding bollard-stubs
Browse files Browse the repository at this point in the history
  • Loading branch information
fussybeaver committed Nov 13, 2024
1 parent efd8f4e commit bb1e9fb
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 28 deletions.
17 changes: 2 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,23 +54,10 @@ encouraged.

### Version

The [Docker API](https://docs.docker.com/engine/api/v1.44/) used by Bollard is using the latest
`1.44` documentation schema published by the [moby](https://github.com/moby/moby) project to
The [Docker API](https://docs.docker.com/engine/api/v1.46/) used by Bollard is using the latest
`1.46` documentation schema published by the [moby](https://github.com/moby/moby) project to
generate its serialization interface.

Breaking change releases in Bollard will depend on a moby API server version corresponding to the
date of that release, so for example a January minor version change will use the
matching [moby swagger API](https://github.com/moby/moby/blob/master/api/swagger.yaml)
available in January. The associated [`bollard-stubs`](https://crates.io/crate/bollard-stubs)
project will release separate versions that you can pin your project against, if you need a
more modern or older API according to your docker server version.

For example:
```nocompile
[dependencies]
bollard-stubs = { version = "=1.44.0-rc.26.0.0" }
```

This library also supports [version
negotiation](https://docs.rs/bollard/latest/bollard/struct.Docker.html#method.negotiate_version),
to allow downgrading to an older API version.
Expand Down
13 changes: 0 additions & 13 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -58,19 +58,6 @@
//! `1.46` documentation schema published by the [moby](https://github.com/moby/moby) project to
//! generate its serialization interface.
//!
//! Breaking change releases in Bollard will depend on a moby API server version corresponding to the
//! date of that release, so for example a January minor version change will use the
//! matching [moby swagger API](https://github.com/moby/moby/blob/master/api/swagger.yaml)
//! available in January. The associated [`bollard-stubs`](https://crates.io/crate/bollard-stubs)
//! project will release separate versions that you can pin your project against, if you need a
//! more modern or older API according to your docker server version.
//!
//! For example:
//! ```nocompile
//! [dependencies]
//! bollard-stubs = { version = "=1.47.0-rc.27.3.1" }
//! ```
//!
//! This library also supports [version
//! negotiation](https://docs.rs/bollard/latest/bollard/struct.Docker.html#method.negotiate_version),
//! to allow downgrading to an older API version.
Expand Down

0 comments on commit bb1e9fb

Please sign in to comment.