Skip to content

Commit 94eb318

Browse files
dariuszkucsmyrick
authored and
smyrick
committed
fix readme link to the toFederatedSchema function (ExpediaGroup#296)
* fix readme link to the toFederatedSchema function * Update README.md
1 parent 6d8525f commit 94eb318

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

graphql-kotlin-federation/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# GraphQL Kotlin Federated Schema Generator
22

3-
`graphql-kotlin-federation` extends the functionality of `graphql-kotlin-schema-generator` and allows you to easily generate federated GraphQL schemas directly from the code. Federated schemas rely on a number of directives to instrument the behavior of the underlying graph, see corresponding wiki pages to learn more about new directives. Once all the federated objects are annotated, you will also have to configure corresponding [FederatedTypeResolver]s that are used to instantiate federated objects and finally generate the schema using `toFederatedSchema` function ([link]).
3+
`graphql-kotlin-federation` extends the functionality of `graphql-kotlin-schema-generator` and allows you to easily generate federated GraphQL schemas directly from the code. Federated schemas rely on a number of directives to instrument the behavior of the underlying graph, see corresponding wiki pages to learn more about new directives. Once all the federated objects are annotated, you will also have to configure corresponding [FederatedTypeResolver]s that are used to instantiate federated objects and finally generate the schema using `toFederatedSchema` function ([link](https://github.com/ExpediaDotCom/graphql-kotlin/blob/master/graphql-kotlin-federation/src/main/kotlin/com/expedia/graphql/federation/toFederatedSchema.kt#L18)).
44

55
See more
66
* [Federation Spec](https://www.apollographql.com/docs/apollo-server/federation/federation-spec/)
@@ -27,7 +27,7 @@ compile(group: 'com.expedia', name: 'graphql-kotlin-federation', version: "$late
2727

2828
## Usage
2929

30-
In order to generate valid federated schemas, you will need to annotate both your base schemas and the one extending them. Federated Gateway (e.g. Apollo) will then combine the individual graphs to form single federated graph.
30+
In order to generate valid federated schemas, you will need to annotate both your base schema and the one extending it. Federated Gateway (e.g. Apollo) will then combine the individual graphs to form single federated graph.
3131

3232
#### Base Schema
3333

0 commit comments

Comments
 (0)