Skip to content

Commit 1c58a46

Browse files
samuelAndalonSamuel Vazquez
samuelAndalon
and
Samuel Vazquez
authored
chore: update v6 and v7 docs (#2044)
Co-authored-by: Samuel Vazquez <samvazquez@expediagroup.com>
1 parent cca3202 commit 1c58a46

File tree

3 files changed

+57
-40
lines changed

3 files changed

+57
-40
lines changed

‎servers/graphql-kotlin-spring-server/src/main/kotlin/com/expediagroup/graphql/server/spring/GraphQLServerCodecConfiguration.kt

+15
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
/*
2+
* Copyright 2024 Expedia, Inc
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
116
package com.expediagroup.graphql.server.spring
217

318
import com.alibaba.fastjson2.JSONWriter

‎website/versioned_docs/version-6.x.x/server/spring-server/spring-properties.md

+19-18
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,22 @@ to provide various customizations of the auto-configuration library. All applica
77
metadata](https://docs.spring.io/spring-boot/docs/current/reference/html/configuration-metadata.html) that provide
88
details on the supported configuration properties.
99

10-
| Property | Description | Default Value |
11-
|-----------------------------------------|------------------------------------------------------------------------------------------------------------------|-------------------------------|
12-
| graphql.endpoint | GraphQL server endpoint | graphql |
13-
| graphql.packages | List of supported packages that can contain GraphQL schema type definitions | |
14-
| graphql.printSchema | Boolean flag indicating whether to print the schema after generator creates it | false |
15-
| graphql.federation.enabled | Boolean flag indicating whether to generate federated GraphQL model | false |
16-
| graphql.federation.optInV2 | Boolean flag indicating whether to generate Federation v2 GraphQL model | false |
17-
| graphql.federation.tracing.enabled | Boolean flag indicating whether add federated tracing data to the extensions | true (if federation enabled) |
18-
| graphql.federation.tracing.debug | Boolean flag to log debug info in the federated tracing | false (if federation enabled) |
19-
| graphql.introspection.enabled | Boolean flag indicating whether introspection queries are enabled | true |
20-
| graphql.playground.enabled | Boolean flag indicating whether to enabled Prisma Labs Playground GraphQL IDE | true |
21-
| graphql.playground.endpoint | Prisma Labs Playground GraphQL IDE endpoint | playground |
22-
| graphql.sdl.enabled | Boolean flag indicating whether to expose SDL endpoint | true |
23-
| graphql.sdl.endpoint | GraphQL SDL endpoint | sdl |
24-
| graphql.subscriptions.endpoint | GraphQL subscriptions endpoint | subscriptions |
25-
| graphql.subscriptions.keepAliveInterval | Keep the websocket alive and send a message to the client every interval in ms. Defaults to not sending messages | null |
26-
| graphql.batching.enabled | Boolean flag indicating whether to enable custom dataloader instrumentations for 1 or more GraphQL Operations | false |
27-
| graphql.batching.strategy | Configure which custom dataloader instrumentation will be used (LEVEL_DISPATCHED or SYNC_EXHAUSTION) | LEVEL_DISPATCHED |
10+
| Property | Description | Default Value |
11+
|-----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------|
12+
| graphql.endpoint | GraphQL server endpoint | graphql |
13+
| graphql.packages | List of supported packages that can contain GraphQL schema type definitions | |
14+
| graphql.printSchema | Boolean flag indicating whether to print the schema after generator creates it | false |
15+
| graphql.serializationLibrary | Configure which serialization library will be used for GraphQLRequest and GraphQLResponse types, supported libraries: JACKSON / FASTJSON | JACKSON |
16+
| graphql.federation.enabled | Boolean flag indicating whether to generate federated GraphQL model | false |
17+
| graphql.federation.optInV2 | Boolean flag indicating whether to generate Federation v2 GraphQL model | false |
18+
| graphql.federation.tracing.enabled | Boolean flag indicating whether add federated tracing data to the extensions | true (if federation enabled) |
19+
| graphql.federation.tracing.debug | Boolean flag to log debug info in the federated tracing | false (if federation enabled) |
20+
| graphql.introspection.enabled | Boolean flag indicating whether introspection queries are enabled | true |
21+
| graphql.playground.enabled | Boolean flag indicating whether to enabled Prisma Labs Playground GraphQL IDE | true |
22+
| graphql.playground.endpoint | Prisma Labs Playground GraphQL IDE endpoint | playground |
23+
| graphql.sdl.enabled | Boolean flag indicating whether to expose SDL endpoint | true |
24+
| graphql.sdl.endpoint | GraphQL SDL endpoint | sdl |
25+
| graphql.subscriptions.endpoint | GraphQL subscriptions endpoint | subscriptions |
26+
| graphql.subscriptions.keepAliveInterval | Keep the websocket alive and send a message to the client every interval in ms. Defaults to not sending messages | null |
27+
| graphql.batching.enabled | Boolean flag indicating whether to enable custom dataloader instrumentations for 1 or more GraphQL Operations | false |
28+
| graphql.batching.strategy | Configure which custom dataloader instrumentation will be used (LEVEL_DISPATCHED or SYNC_EXHAUSTION) | LEVEL_DISPATCHED |

‎website/versioned_docs/version-7.x.x/server/spring-server/spring-properties.md

+23-22
Original file line numberDiff line numberDiff line change
@@ -10,25 +10,26 @@ expose [configuration
1010
metadata](https://docs.spring.io/spring-boot/docs/current/reference/html/configuration-metadata.html) that provide
1111
details on the supported configuration properties.
1212

13-
| Property | Description | Default Value |
14-
|---------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------|-------------------------------|
15-
| graphql.endpoint | GraphQL server endpoint | graphql |
16-
| graphql.packages | List of supported packages that can contain GraphQL schema type definitions | |
17-
| graphql.printSchema | Boolean flag indicating whether to print the schema after generator creates it | false |
18-
| graphql.federation.enabled | Boolean flag indicating whether to generate federated GraphQL model | false |
19-
| graphql.federation.optInV2 | Boolean flag indicating whether to generate Federation v2 GraphQL model | false |
20-
| graphql.federation.tracing.enabled | Boolean flag indicating whether add federated tracing data to the extensions | true (if federation enabled) |
21-
| graphql.federation.tracing.debug | Boolean flag to log debug info in the federated tracing | false (if federation enabled) |
22-
| graphql.introspection.enabled | Boolean flag indicating whether introspection queries are enabled | true |
23-
| graphql.playground.enabled | Boolean flag indicating whether to enable Prisma Labs Playground GraphQL IDE | false |
24-
| graphql.playground.endpoint | Prisma Labs Playground GraphQL IDE endpoint | playground |
25-
| graphql.graphiql.enabled | Boolean flag indicating whether to enable GraphiQL GraphQL IDE | true |
26-
| graphql.graphiql.endpoint | Prisma Labs Playground GraphQL IDE endpoint | graphiql |
27-
| graphql.sdl.enabled | Boolean flag indicating whether to expose SDL endpoint | true |
28-
| graphql.sdl.endpoint | GraphQL SDL endpoint | sdl |
29-
| graphql.subscriptions.connectionInitTimeout | Server timeout (in milliseconds) between establishing web socket connection and receiving connection-init message | 60_000 |
30-
| graphql.subscriptions.endpoint | GraphQL subscriptions endpoint | subscriptions |
31-
| graphql.subscriptions.keepAliveInterval | **Deprecated**. Keep the websocket alive and send a message to the client every interval in ms. Defaults to not sending messages | null |
32-
| graphql.subscriptions.protocol | WebSocket based subscription protocol. Supported protocols: APOLLO_SUBSCRIPTIONS_WS / GRAPHQL_WS | GRAPHQL_WS |
33-
| graphql.batching.enabled | Boolean flag indicating whether to enable custom dataloader instrumentations for 1 or more GraphQL Operations | false |
34-
| graphql.batching.strategy | Configure which custom dataloader instrumentation will be used (LEVEL_DISPATCHED or SYNC_EXHAUSTION) | LEVEL_DISPATCHED |
13+
| Property | Description | Default Value |
14+
|---------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------|
15+
| graphql.endpoint | GraphQL server endpoint | graphql |
16+
| graphql.packages | List of supported packages that can contain GraphQL schema type definitions | |
17+
| graphql.printSchema | Boolean flag indicating whether to print the schema after generator creates it | false |
18+
| graphql.serializationLibrary | Configure which serialization library will be used for GraphQLRequest and GraphQLResponse types, supported libraries: JACKSON / FASTJSON | JACKSON |
19+
| graphql.federation.enabled | Boolean flag indicating whether to generate federated GraphQL model | false |
20+
| graphql.federation.optInV2 | Boolean flag indicating whether to generate Federation v2 GraphQL model | false |
21+
| graphql.federation.tracing.enabled | Boolean flag indicating whether add federated tracing data to the extensions | true (if federation enabled) |
22+
| graphql.federation.tracing.debug | Boolean flag to log debug info in the federated tracing | false (if federation enabled) |
23+
| graphql.introspection.enabled | Boolean flag indicating whether introspection queries are enabled | true |
24+
| graphql.playground.enabled | Boolean flag indicating whether to enable Prisma Labs Playground GraphQL IDE | false |
25+
| graphql.playground.endpoint | Prisma Labs Playground GraphQL IDE endpoint | playground |
26+
| graphql.graphiql.enabled | Boolean flag indicating whether to enable GraphiQL GraphQL IDE | true |
27+
| graphql.graphiql.endpoint | Prisma Labs Playground GraphQL IDE endpoint | graphiql |
28+
| graphql.sdl.enabled | Boolean flag indicating whether to expose SDL endpoint | true |
29+
| graphql.sdl.endpoint | GraphQL SDL endpoint | sdl |
30+
| graphql.subscriptions.connectionInitTimeout | Server timeout (in milliseconds) between establishing web socket connection and receiving connection-init message | 60_000 |
31+
| graphql.subscriptions.endpoint | GraphQL subscriptions endpoint | subscriptions |
32+
| graphql.subscriptions.keepAliveInterval | **Deprecated**. Keep the websocket alive and send a message to the client every interval in ms. Defaults to not sending messages | null |
33+
| graphql.subscriptions.protocol | WebSocket based subscription protocol. Supported protocols: APOLLO_SUBSCRIPTIONS_WS / GRAPHQL_WS | GRAPHQL_WS |
34+
| graphql.batching.enabled | Boolean flag indicating whether to enable custom dataloader instrumentations for 1 or more GraphQL Operations | false |
35+
| graphql.batching.strategy | Configure which custom dataloader instrumentation will be used (LEVEL_DISPATCHED or SYNC_EXHAUSTION) | LEVEL_DISPATCHED |

0 commit comments

Comments
 (0)