From 7cb949d721d1ace6ffd293ba71271bc34e61d3e4 Mon Sep 17 00:00:00 2001 From: Edward Huang Date: Tue, 11 Feb 2025 10:12:13 -0800 Subject: [PATCH] copyedits --- CHANGELOG.md | 42 ++++++++++++++++++++++-------------------- 1 file changed, 22 insertions(+), 20 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 59f2da1787..53aba6396e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,42 +6,44 @@ This project adheres to [Semantic Versioning v2.0.0](https://semver.org/spec/v2. # [2.0.0] - 2025-02-19 -This is a major release of the router containing significant new functionality and improvements to behavior. This changelog entry summarises the work, but for details please refer to: +This is a major release of the router containing significant new functionality and improvements to behavior. -Learn more about [upgrading from 1.x to 2.0](https://www.apollographql.com/docs/graphos/reference/upgrade/from-router-v1). -Learn more about [what's new in 2.0(TBD)](https://www.apollographql.com/docs/graphos/reference/upgrade/from-router-v1). +This entry summarizes the changes in router 2.0.0. To learn more details, go to the [What's New in router v2.x](https://www.apollographql.com/docs/graphos/routing/about-v2) page. -## ❗ BREAKING ❗ +To upgrade to this version, follow the [upgrading from router 1.x to 2.x](https://www.apollographql.com/docs/graphos/reference/upgrade/from-router-v1) guide. + +## ❗ BREAKING CHANGES ❗ -There are a number of breaking improvements to the router in this major release. Most of them are in the areas of configuration and observability and details are available in the upgrade guide. +There are a number of breaking improvements to the router in this major release. Most are in the areas of configuration and observability. For details, refer to the [upgrade guide](https://www.apollographql.com/docs/graphos/reference/upgrade/from-router-v1). ## 🚀 Features This release of the router includes many new features, including: - - Simplified integration of REST services using Apollo Connectors - - Predictable Resource Utilization and Availability with Back Pressure - - Apollo operation usage reporting now defaults to using OpenTelemetry - - Metrics now all follow OpenTelemetry naming conventions. - - Improved validation of CORS configurations, preventing silent failures. - - Documentation for Context keys, improving usability for advanced customers. +- Simplified integration of REST services using Apollo Connectors +- Predictable resource utilization and availability with back pressure +- Apollo operation usage reporting now defaults to using OpenTelemetry +- Metrics now all follow OpenTelemetry naming conventions +- Improved validation of CORS configurations, preventing silent failures +- Documentation for context keys, improving usability for advanced customers -More details about any of these new features can be found in the What's New guide. +For details, go to the features can be found in the [What's New guide](https://www.apollographql.com/docs/graphos/routing/about-v2). ## 📃 Configuration -Configuration changes have been minimised, however there are a number of changes in this release. Breaking changes to configuration are documented in the upgrade guide. Configuration for new features can be found from the What's New guide. +Some changes to router configuration options were necessary in this release. Descriptions for both breaking changes to previous configuration and configuration for new features can be found in the [upgrade guide](https://www.apollographql.com/docs/graphos/reference/upgrade/from-router-v1)). ## 🛠 Maintenance -Many external dependencies (crates) have been updated to modern versions where possible. Major upgrades include: - - axum - - http - - hyper - - opentelemetry - - redis +Many external dependencies (crates) have been updated to modern versions where possible. As the Rust ecosystem evolves, so does the router. Keeping these crates up to date helps keep the router secure and stable. + +Major upgrades include: -Keeping these crates up to date helps to keep the router secure and stable. As the Rust ecosystem evolves, so does the Router. +- axum +- http +- hyper +- opentelemetry +- redis # [2.0.0-preview.0] - 2024-10-01