Skip to content

Commit

Permalink
update changelog for upcoming release (#1175)
Browse files Browse the repository at this point in the history
  • Loading branch information
davepacheco authored Nov 13, 2024
1 parent 135934e commit b7be485
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions CHANGELOG.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,13 @@

https://github.com/oxidecomputer/dropshot/compare/v0.12.0\...HEAD[Full list of commits]

=== Breaking Changes

* Dropshot now expects that APIs use https://semver.org/[Semver] values for their version string. Concretely, this only means that the `version` argument to `ApiDescription::openapi` (which generates an OpenAPI document) must be a `semver::Version`. Previously, it was `AsRef<str>`.
* If you're invoking `ApiEndpoint::new` directly or constructing one as a literal (both of which are uncommon), you must provide a new `ApiEndpointVersions` value describing which versions this endpoint implements. You can use `ApiEndpointVersions::All` if you don't care about versioning.

=== Other notable changes

* https://github.com/oxidecomputer/dropshot/pull/1122[#1122] Adds a new `ServerBuilder` as the primary way of constructing a Dropshot server. This replaces `HttpServerStarter::new()` and `HttpServerStarter::new_with_tls()`. These older functions still exist for compatibility. They may be removed in an upcoming release, along with the `HttpServerStarter`.
+
In this release, using the builder interface is not very different from using these older functions. But as we look at adding new construction-time options (e.g., for API versioning), those will only be added to the builder.
Expand Down Expand Up @@ -67,12 +74,6 @@ We'd like to remove the `HttpServerStarter` altogether, so let us know if you're
+
By "experimental" we only mean that the API may change in upcoming releases.

=== Breaking Changes

* Dropshot now expects that APIs use https://semver.org/[Semver] values for their version string. Concretely, this only means that the `version` argument to `ApiDescription::openapi` (which generates an OpenAPI document) must be a `semver::Version`. Previously, it was `AsRef<str>`.
* If you're invoking `ApiEndpoint::new` directly or constructing one as a literal (both of which are uncommon), you must provide a new `ApiEndpointVersions` value describing which versions this endpoint implements. You can use `ApiEndpointVersions::All` if you don't care about versioning.


== 0.12.0 (released 2024-09-26)

https://github.com/oxidecomputer/dropshot/compare/v0.11.0\...v0.12.0[Full list of commits]
Expand Down

0 comments on commit b7be485

Please sign in to comment.