Skip to content

Commit 2cd40d9

Browse files
authored
versioned docs: replace references to master branch with 3.x.x (#1172)
* update links to examples * Update spring-schema.md * versioned docs: replace references to `master` branch with `3.x.x`
1 parent 9b364e0 commit 2cd40d9

24 files changed

+58
-58
lines changed

website/versioned_docs/version-3.x.x/client/client-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ Equivalent `pom.xml` Maven configuration
9191

9292
```
9393

94-
See [graphql-kotlin-client-example](https://github.com/ExpediaGroup/graphql-kotlin/tree/master/examples/client) project for complete
94+
See [graphql-kotlin-client-example](https://github.com/ExpediaGroup/graphql-kotlin/tree/3.x.x/examples/client) project for complete
9595
working examples of Gradle and Maven based projects.
9696

9797
## Generating GraphQL Client

website/versioned_docs/version-3.x.x/contributors/release-proc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ original_id: release-proc
66
In order to [release a new version](https://github.com/ExpediaGroup/graphql-kotlin/releases) we need to draft a new release
77
and tag the commit. Releases are following [semantic versioning](https://semver.org/) and specify major, minor and patch version.
88

9-
Once release is published it will trigger corresponding [Github Action](https://github.com/ExpediaGroup/graphql-kotlin/blob/master/.github/workflows/release.yml)
9+
Once release is published it will trigger corresponding [Github Action](https://github.com/ExpediaGroup/graphql-kotlin/blob/3.x.x/.github/workflows/release.yml)
1010
based on the published release event. Release workflow will then proceed to build and publish all library artifacts to [Maven Central](https://central.sonatype.org/).
1111

1212
### Release requirements

website/versioned_docs/version-3.x.x/examples.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,23 @@ id: examples
33
title: Examples
44
original_id: examples
55
---
6-
A collection of example apps that use graphql-kotlin libraries to test and demonstrate usages can be found in the [examples module](https://github.com/ExpediaGroup/graphql-kotlin/tree/master/examples).
6+
A collection of example apps that use graphql-kotlin libraries to test and demonstrate usages can be found in the [examples module](https://github.com/ExpediaGroup/graphql-kotlin/tree/3.x.x/examples).
77

88
## Client Example
99

10-
A `graphql-kotlin-client` can be generated using the Maven and Gradle plugins in `graphql-kotlin-plugins`. For examples see the [examples/client](https://github.com/ExpediaGroup/graphql-kotlin/tree/master/examples/client) folder.
10+
A `graphql-kotlin-client` can be generated using the Maven and Gradle plugins in `graphql-kotlin-plugins`. For examples see the [examples/client](https://github.com/ExpediaGroup/graphql-kotlin/tree/3.x.x/examples/client) folder.
1111

1212
## Spring Server Example
1313

1414
One way to run a GraphQL server is with [Spring Boot](https://github.com/spring-projects/spring-boot). A sample Spring
1515
Boot app that uses [Spring
1616
Webflux](https://docs.spring.io/spring/docs/current/spring-framework-reference/web-reactive.html) together with
1717
`graphql-kotlin-schema-generator` and [graphql-playground](https://github.com/prisma/graphql-playground) is provided as
18-
a [examples/spring](https://github.com/ExpediaGroup/graphql-kotlin/tree/master/examples/spring). All the examples used
18+
a [examples/spring](https://github.com/ExpediaGroup/graphql-kotlin/tree/3.x.x/examples/spring). All the examples used
1919
in this documentation should be available in the sample app.
2020

2121
In order to run it you can run
22-
[Application.kt](https://github.com/ExpediaGroup/graphql-kotlin/blob/master/examples/spring/src/main/kotlin/com/expediagroup/graphql/examples/Application.kt)
22+
[Application.kt](https://github.com/ExpediaGroup/graphql-kotlin/blob/3.x.x/examples/spring/src/main/kotlin/com/expediagroup/graphql/examples/Application.kt)
2323
directly from your IDE. Alternatively you can also use the Spring Boot plugin from the command line.
2424

2525
```shell script
@@ -33,9 +33,9 @@ http:.
3333

3434
## Federation Example
3535

36-
There is also an example of [Apollo Federation](https://www.apollographql.com/docs/apollo-server/federation/introduction/) with two Spring Boot apps using `` and an Apollo Gateway app in Nodejs that exposes a single federated schema in [examples/federation](https://github.com/ExpediaGroup/graphql-kotlin/tree/master/examples/federation)
36+
There is also an example of [Apollo Federation](https://www.apollographql.com/docs/apollo-server/federation/introduction/) with two Spring Boot apps using `` and an Apollo Gateway app in Nodejs that exposes a single federated schema in [examples/federation](https://github.com/ExpediaGroup/graphql-kotlin/tree/3.x.x/examples/federation)
3737
project. Please refer to the README files for details on how to run each application.
3838

3939
## Spark Example
4040

41-
The spark example provides a demonstration of delivering a GraphQL service via the [Spark HTTP framework](http://sparkjava.com/). This example also demonstrates how to include [``](https://github.com/graphql-java/java-dataloader) in your query execution. This example can be found at [examples/spark](https://github.com/ExpediaGroup/graphql-kotlin/tree/master/examples/spark)
41+
The spark example provides a demonstration of delivering a GraphQL service via the [Spark HTTP framework](http://sparkjava.com/). This example also demonstrates how to include [``](https://github.com/graphql-java/java-dataloader) in your query execution. This example can be found at [examples/spark](https://github.com/ExpediaGroup/graphql-kotlin/tree/3.x.x/examples/spark)

website/versioned_docs/version-3.x.x/federated/apollo-federation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,11 @@ compliant schemas.
4848
### `toFederatedSchema`
4949

5050
Just like the basic [toSchema](../schema-generator/schema-generator-getting-started.md), `toFederatedSchema` accepts four parameters: `config`, `queries`, `mutations` and `subscriptions`.
51-
The difference is that the `config` class is of type [FederatedSchemaGeneratorConfig](https://github.com/ExpediaGroup/graphql-kotlin/blob/master/graphql-kotlin-federation/src/main/kotlin/com/expediagroup/graphql/federation/FederatedSchemaGeneratorConfig.kt).
51+
The difference is that the `config` class is of type [FederatedSchemaGeneratorConfig](https://github.com/ExpediaGroup/graphql-kotlin/blob/3.x.x/graphql-kotlin-federation/src/main/kotlin/com/expediagroup/graphql/federation/FederatedSchemaGeneratorConfig.kt).
5252
This class extends the [base configuration class](../schema-generator/customizing-schemas/generator-config.md) and adds some default logic. You can override the logic if needed, but do so with caution as you may no longer generate a spec compliant schema.
5353

5454
You can see the definition for `toFederatedSchema` [in the
55-
source](https://github.com/ExpediaGroup/graphql-kotlin/blob/master/graphql-kotlin-federation/src/main/kotlin/com/expediagroup/graphql/federation/toFederatedSchema.kt)
55+
source](https://github.com/ExpediaGroup/graphql-kotlin/blob/3.x.x/graphql-kotlin-federation/src/main/kotlin/com/expediagroup/graphql/federation/toFederatedSchema.kt)
5656

5757
## Example
5858

website/versioned_docs/version-3.x.x/federated/federated-schemas.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ are explicitly picked up by the schema generator based on their directives. Due
1414
a way to instantiate the underlying federated objects by implementing corresponding `FederatedTypeResolvers`. See
1515
[type resolution wiki](type-resolution) for more details on how federated types are resolved. Final federated schema
1616
is then generated by invoking the `toFederatedSchema` function
17-
([link](https://github.com/ExpediaGroup/graphql-kotlin/blob/master/graphql-kotlin-federation/src/main/kotlin/com/expediagroup/graphql/federation/toFederatedSchema.kt#L34)).
17+
([link](https://github.com/ExpediaGroup/graphql-kotlin/blob/3.x.x/graphql-kotlin-federation/src/main/kotlin/com/expediagroup/graphql/federation/toFederatedSchema.kt#L34)).
1818

1919
**In order to generate valid federated schemas, you will need to annotate both your base schema and the one extending
2020
it**. Federated Gateway (e.g. Apollo) will then combine the individual graphs to form single federated graph.
@@ -173,4 +173,4 @@ type Query {
173173

174174
```
175175

176-
See our [federation example](https://github.com/ExpediaGroup/graphql-kotlin/tree/master/examples/federation) for additional details.
176+
See our [federation example](https://github.com/ExpediaGroup/graphql-kotlin/tree/3.x.x/examples/federation) for additional details.

website/versioned_docs/version-3.x.x/federated/type-resolution.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ query ($_representations: [_Any!]!) {
3636

3737
In order to simplify the integrations, `graphql-kotlin-federation` provides default `_entities` query resolver that
3838
relies on
39-
[FederatedTypeRegistry](https://github.com/ExpediaGroup/graphql-kotlin/blob/master/graphql-kotlin-federation/src/main/kotlin/com/expediagroup/graphql/federation/execution/FederatedTypeRegistry.kt)
39+
[FederatedTypeRegistry](https://github.com/ExpediaGroup/graphql-kotlin/blob/3.x.x/graphql-kotlin-federation/src/main/kotlin/com/expediagroup/graphql/federation/execution/FederatedTypeRegistry.kt)
4040
to retrieve
41-
[FederatedTypeResolver](https://github.com/ExpediaGroup/graphql-kotlin/blob/master/graphql-kotlin-federation/src/main/kotlin/com/expediagroup/graphql/federation/execution/FederatedTypeResolver.kt)
41+
[FederatedTypeResolver](https://github.com/ExpediaGroup/graphql-kotlin/blob/3.x.x/graphql-kotlin-federation/src/main/kotlin/com/expediagroup/graphql/federation/execution/FederatedTypeResolver.kt)
4242
that is used to resolve target object. When configuring the federated schema generator hooks you have to explicitly
4343
provide those resolver mappings to the configuration.
4444

website/versioned_docs/version-3.x.x/getting-started.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,19 @@ GraphQL Kotlin is a collection of libraries, built on top of [graphql-java](http
88

99
## Modules
1010

11-
- [examples](https://github.com/ExpediaGroup/graphql-kotlin/tree/master/examples)
11+
- [examples](https://github.com/ExpediaGroup/graphql-kotlin/tree/3.x.x/examples)
1212
— Example apps that use graphql-kotlin libraries to test and demonstrate usages
13-
- [graphql-kotlin-client](https://github.com/ExpediaGroup/graphql-kotlin/tree/master/graphql-kotlin-client) ([Javadoc](https://www.javadoc.io/doc/com.expediagroup/graphql-kotlin-client))
13+
- [graphql-kotlin-client](https://github.com/ExpediaGroup/graphql-kotlin/tree/3.x.x/graphql-kotlin-client) ([Javadoc](https://www.javadoc.io/doc/com.expediagroup/graphql-kotlin-client))
1414
— Lightweight GraphQL Kotlin HTTP client
15-
- [graphql-kotlin-schema-generator](https://github.com/ExpediaGroup/graphql-kotlin/tree/master/graphql-kotlin-schema-generator) ([Javadoc](https://www.javadoc.io/doc/com.expediagroup/graphql-kotlin-schema-generator))
15+
- [graphql-kotlin-schema-generator](https://github.com/ExpediaGroup/graphql-kotlin/tree/3.x.x/graphql-kotlin-schema-generator) ([Javadoc](https://www.javadoc.io/doc/com.expediagroup/graphql-kotlin-schema-generator))
1616
— Code only GraphQL schema generation for Kotlin
17-
- [graphql-kotlin-federation](https://github.com/ExpediaGroup/graphql-kotlin/tree/master/graphql-kotlin-federation) ([Javadoc](https://www.javadoc.io/doc/com.expediagroup/graphql-kotlin-federation))
17+
- [graphql-kotlin-federation](https://github.com/ExpediaGroup/graphql-kotlin/tree/3.x.x/graphql-kotlin-federation) ([Javadoc](https://www.javadoc.io/doc/com.expediagroup/graphql-kotlin-federation))
1818
— Schema generator extension to build federated GraphQL schemas
19-
- [graphql-kotlin-spring-server](https://github.com/ExpediaGroup/graphql-kotlin/tree/master/graphql-kotlin-spring-server) ([Javadoc](https://www.javadoc.io/doc/com.expediagroup/graphql-kotlin-spring-server))
19+
- [graphql-kotlin-spring-server](https://github.com/ExpediaGroup/graphql-kotlin/tree/3.x.x/graphql-kotlin-spring-server) ([Javadoc](https://www.javadoc.io/doc/com.expediagroup/graphql-kotlin-spring-server))
2020
— Spring Boot auto-configuration library to create GraphQL server
21-
- [graphql-kotlin-types](https://github.com/ExpediaGroup/graphql-kotlin/tree/master/graphql-kotlin-types) ([Javadoc](https://www.javadoc.io/doc/com.expediagroup/graphql-kotlin-types))
21+
- [graphql-kotlin-types](https://github.com/ExpediaGroup/graphql-kotlin/tree/3.x.x/graphql-kotlin-types) ([Javadoc](https://www.javadoc.io/doc/com.expediagroup/graphql-kotlin-types))
2222
— Core types used by both client and server
23-
- [plugins](https://github.com/ExpediaGroup/graphql-kotlin/tree/master/plugins)
23+
- [plugins](https://github.com/ExpediaGroup/graphql-kotlin/tree/3.x.x/plugins)
2424
— GraphQL Kotlin Gradle and Maven plugins
2525

2626
If you encounter any problems using this library please open up a new

website/versioned_docs/version-3.x.x/plugins/gradle-plugin.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ plugins {
2222
## Extension
2323

2424
GraphQL Kotlin Gradle Plugin uses an extension on the project named `graphql` of type
25-
[GraphQLPluginExtension](https://github.com/ExpediaGroup/graphql-kotlin/blob/master/plugins/graphql-kotlin-gradle-plugin/src/main/kotlin/com/expediagroup/graphql/plugin/gradle/GraphQLPluginExtension.kt).
25+
[GraphQLPluginExtension](https://github.com/ExpediaGroup/graphql-kotlin/blob/3.x.x/plugins/graphql-kotlin-gradle-plugin/src/main/kotlin/com/expediagroup/graphql/plugin/gradle/GraphQLPluginExtension.kt).
2626
This extension can be used to configure global options instead of explicitly configuring individual tasks. Once extension
2727
is configured, it will automatically download SDL/run introspection to generate GraphQL schema and subsequently generate
2828
all GraphQL clients. GraphQL Extension should be used by default, except for cases where you need to only run individual
@@ -227,7 +227,7 @@ Generated classes will be automatically added to the project compile sources.
227227
### Generating Client with Custom Scalars
228228

229229
By default, all custom GraphQL scalars will be serialized as Strings. You can override this default behavior by specifying
230-
custom [scalar converter](https://github.com/ExpediaGroup/graphql-kotlin/blob/master/graphql-kotlin-client/src/main/kotlin/com/expediagroup/graphql/client/converter/ScalarConverter.kt).
230+
custom [scalar converter](https://github.com/ExpediaGroup/graphql-kotlin/blob/3.x.x/graphql-kotlin-client/src/main/kotlin/com/expediagroup/graphql/client/converter/ScalarConverter.kt).
231231

232232
For example given following custom scalar in our GraphQL schema
233233

website/versioned_docs/version-3.x.x/plugins/maven-plugin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ Generated classes will be automatically added to the project compile sources.
228228
### Generating Client with Custom Scalars
229229
230230
By default, all custom GraphQL scalars will be serialized as Strings. You can override this default behavior by specifying
231-
custom [scalar converter](https://github.com/ExpediaGroup/graphql-kotlin/blob/master/graphql-kotlin-client/src/main/kotlin/com/expediagroup/graphql/client/converter/ScalarConverter.kt).
231+
custom [scalar converter](https://github.com/ExpediaGroup/graphql-kotlin/blob/3.x.x/graphql-kotlin-client/src/main/kotlin/com/expediagroup/graphql/client/converter/ScalarConverter.kt).
232232
233233
For example given following custom scalar in our GraphQL schema
234234

website/versioned_docs/version-3.x.x/schema-generator/customizing-schemas/advanced-features.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This may be required for [Apollo Federation](../../federated/apollo-federation.m
1111
### `SchemaGenerator::addAdditionalTypesWithAnnotation`
1212

1313
This method is protected so if you override the `SchemaGenerator` used you can call this method to add types that have a specific annotation.
14-
You can see how this is used in `graphql-kotlin-federation` as [an example](https://github.com/ExpediaGroup/graphql-kotlin/blob/master/graphql-kotlin-federation/src/main/kotlin/com/expediagroup/graphql/federation/FederatedSchemaGenerator.kt).
14+
You can see how this is used in `graphql-kotlin-federation` as [an example](https://github.com/ExpediaGroup/graphql-kotlin/blob/3.x.x/graphql-kotlin-federation/src/main/kotlin/com/expediagroup/graphql/federation/FederatedSchemaGenerator.kt).
1515

1616
### `SchemaGenerator::generateAdditionalTypes`
1717

0 commit comments

Comments
 (0)