Skip to content

Commit

Permalink
Add CHANGELOG.md entry for migrating to GA config
Browse files Browse the repository at this point in the history
  • Loading branch information
pubmodmatt committed Feb 10, 2025
1 parent f9fbc55 commit 3b15e47
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 1 deletion.
40 changes: 40 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,46 @@ All notable changes to Router will be documented in this file.

This project adheres to [Semantic Versioning v2.0.0](https://semver.org/spec/v2.0.0.html).

# [2.0.0]

## 🚀 Features

### General availability of Apollo Connectors

Apollo Connectors is now [generally available](https://www.apollographql.com/docs/graphos/reference/feature-launch-stages#general-availability).

#### Migrating from Apollo Connectors preview releases

Preview configuration will continue to work, but a warning message will be emitted on router startup. It is recommended that you migrate your router configuration to use the GA configuration. The top level router configuration has moved from `preview_connectors` to `connectors`. In addition, configuration that was previously under `subgraphs` has now moved to `sources`. Each connector source can be configured individually under an entry consisting of the subgraph name and source name separated by a `.`, for example: `subgraph_name.source_name`. `$config` items have moved under each individual source configuration.

Example preview configuration:
```yaml
preview_connectors:
max_requests_per_operation_per_source: 100 # This applies globally to all connectors
subgraphs:
example: # The name of the subgraph
$config:
my.config.value: true # applies to all sources in this subgraph
sources:
v1: # Refers to @source(name: "v1")
# These apply to connectors with this source (v1) in this subgraph (example)
override_url: 'https://localhost:5000'
max_requests_per_operation: 50
```

Example GA configuration:
```yaml
connectors:
max_requests_per_operation_per_source: 100 # This applies globally to all connectors
sources:
example.v1: # subgraph.source
# These apply to connectors with this source (v1) in this subgraph (example)
override_url: 'https://localhost:5000'
max_requests_per_operation: 50
$config:
my.config.value: true # applies only to this source
```

# [2.0.0-preview.0] - 2024-10-01

Learn more about [migrating from 1.x to 2.0](https://www.apollographql.com/docs/graphos/reference/migration/from-router-v1).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ actions:
- type: log
level: warn
path: connectors.subgraphs
# TODO: add doc link about how to migrate subgraphs and $config
log: "In the General Availability (GA) release of Apollo Connectors, `subgraphs` has been replaced by `sources`. Please update your configuration."

0 comments on commit 3b15e47

Please sign in to comment.