Skip to content

Commit

Permalink
chore: update v6 and v7 docs (#2044)
Browse files Browse the repository at this point in the history 
Co-authored-by: Samuel Vazquez <samvazquez@expediagroup.com>
  • Loading branch information
@samuelAndalon
samuelAndalon and Samuel Vazquez authored Oct 7, 2024
1 parent cca3202 commit 1c58a46
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 40 deletions.
15 changes: 15 additions & 0 deletions ...src/main/kotlin/com/expediagroup/graphql/server/spring/GraphQLServerCodecConfiguration.kt
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,18 @@
/*
* Copyright 2024 Expedia, Inc
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.expediagroup.graphql.server.spring

import com.alibaba.fastjson2.JSONWriter
Expand Down
37 changes: 19 additions & 18 deletions website/versioned_docs/version-6.x.x/server/spring-server/spring-properties.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,22 @@ to provide various customizations of the auto-configuration library. All applica
metadata](https://docs.spring.io/spring-boot/docs/current/reference/html/configuration-metadata.html) that provide
details on the supported configuration properties.

| Property | Description | Default Value |
|-----------------------------------------|------------------------------------------------------------------------------------------------------------------|-------------------------------|
| graphql.endpoint | GraphQL server endpoint | graphql |
| graphql.packages | List of supported packages that can contain GraphQL schema type definitions | |
| graphql.printSchema | Boolean flag indicating whether to print the schema after generator creates it | false |
| graphql.federation.enabled | Boolean flag indicating whether to generate federated GraphQL model | false |
| graphql.federation.optInV2 | Boolean flag indicating whether to generate Federation v2 GraphQL model | false |
| graphql.federation.tracing.enabled | Boolean flag indicating whether add federated tracing data to the extensions | true (if federation enabled) |
| graphql.federation.tracing.debug | Boolean flag to log debug info in the federated tracing | false (if federation enabled) |
| graphql.introspection.enabled | Boolean flag indicating whether introspection queries are enabled | true |
| graphql.playground.enabled | Boolean flag indicating whether to enabled Prisma Labs Playground GraphQL IDE | true |
| graphql.playground.endpoint | Prisma Labs Playground GraphQL IDE endpoint | playground |
| graphql.sdl.enabled | Boolean flag indicating whether to expose SDL endpoint | true |
| graphql.sdl.endpoint | GraphQL SDL endpoint | sdl |
| graphql.subscriptions.endpoint | GraphQL subscriptions endpoint | subscriptions |
| graphql.subscriptions.keepAliveInterval | Keep the websocket alive and send a message to the client every interval in ms. Defaults to not sending messages | null |
| graphql.batching.enabled | Boolean flag indicating whether to enable custom dataloader instrumentations for 1 or more GraphQL Operations | false |
| graphql.batching.strategy | Configure which custom dataloader instrumentation will be used (LEVEL_DISPATCHED or SYNC_EXHAUSTION) | LEVEL_DISPATCHED |
| Property | Description | Default Value |
|-----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------|
| graphql.endpoint | GraphQL server endpoint | graphql |
| graphql.packages | List of supported packages that can contain GraphQL schema type definitions | |
| graphql.printSchema | Boolean flag indicating whether to print the schema after generator creates it | false |
| graphql.serializationLibrary | Configure which serialization library will be used for GraphQLRequest and GraphQLResponse types, supported libraries: JACKSON / FASTJSON | JACKSON |
| graphql.federation.enabled | Boolean flag indicating whether to generate federated GraphQL model | false |
| graphql.federation.optInV2 | Boolean flag indicating whether to generate Federation v2 GraphQL model | false |
| graphql.federation.tracing.enabled | Boolean flag indicating whether add federated tracing data to the extensions | true (if federation enabled) |
| graphql.federation.tracing.debug | Boolean flag to log debug info in the federated tracing | false (if federation enabled) |
| graphql.introspection.enabled | Boolean flag indicating whether introspection queries are enabled | true |
| graphql.playground.enabled | Boolean flag indicating whether to enabled Prisma Labs Playground GraphQL IDE | true |
| graphql.playground.endpoint | Prisma Labs Playground GraphQL IDE endpoint | playground |
| graphql.sdl.enabled | Boolean flag indicating whether to expose SDL endpoint | true |
| graphql.sdl.endpoint | GraphQL SDL endpoint | sdl |
| graphql.subscriptions.endpoint | GraphQL subscriptions endpoint | subscriptions |
| graphql.subscriptions.keepAliveInterval | Keep the websocket alive and send a message to the client every interval in ms. Defaults to not sending messages | null |
| graphql.batching.enabled | Boolean flag indicating whether to enable custom dataloader instrumentations for 1 or more GraphQL Operations | false |
| graphql.batching.strategy | Configure which custom dataloader instrumentation will be used (LEVEL_DISPATCHED or SYNC_EXHAUSTION) | LEVEL_DISPATCHED |
45 changes: 23 additions & 22 deletions website/versioned_docs/version-7.x.x/server/spring-server/spring-properties.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,25 +10,26 @@ expose [configuration
metadata](https://docs.spring.io/spring-boot/docs/current/reference/html/configuration-metadata.html) that provide
details on the supported configuration properties.

| Property | Description | Default Value |
|---------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------|-------------------------------|
| graphql.endpoint | GraphQL server endpoint | graphql |
| graphql.packages | List of supported packages that can contain GraphQL schema type definitions | |
| graphql.printSchema | Boolean flag indicating whether to print the schema after generator creates it | false |
| graphql.federation.enabled | Boolean flag indicating whether to generate federated GraphQL model | false |
| graphql.federation.optInV2 | Boolean flag indicating whether to generate Federation v2 GraphQL model | false |
| graphql.federation.tracing.enabled | Boolean flag indicating whether add federated tracing data to the extensions | true (if federation enabled) |
| graphql.federation.tracing.debug | Boolean flag to log debug info in the federated tracing | false (if federation enabled) |
| graphql.introspection.enabled | Boolean flag indicating whether introspection queries are enabled | true |
| graphql.playground.enabled | Boolean flag indicating whether to enable Prisma Labs Playground GraphQL IDE | false |
| graphql.playground.endpoint | Prisma Labs Playground GraphQL IDE endpoint | playground |
| graphql.graphiql.enabled | Boolean flag indicating whether to enable GraphiQL GraphQL IDE | true |
| graphql.graphiql.endpoint | Prisma Labs Playground GraphQL IDE endpoint | graphiql |
| graphql.sdl.enabled | Boolean flag indicating whether to expose SDL endpoint | true |
| graphql.sdl.endpoint | GraphQL SDL endpoint | sdl |
| graphql.subscriptions.connectionInitTimeout | Server timeout (in milliseconds) between establishing web socket connection and receiving connection-init message | 60_000 |
| graphql.subscriptions.endpoint | GraphQL subscriptions endpoint | subscriptions |
| 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 |
| graphql.subscriptions.protocol | WebSocket based subscription protocol. Supported protocols: APOLLO_SUBSCRIPTIONS_WS / GRAPHQL_WS | GRAPHQL_WS |
| graphql.batching.enabled | Boolean flag indicating whether to enable custom dataloader instrumentations for 1 or more GraphQL Operations | false |
| graphql.batching.strategy | Configure which custom dataloader instrumentation will be used (LEVEL_DISPATCHED or SYNC_EXHAUSTION) | LEVEL_DISPATCHED |
| Property | Description | Default Value |
|---------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------|
| graphql.endpoint | GraphQL server endpoint | graphql |
| graphql.packages | List of supported packages that can contain GraphQL schema type definitions | |
| graphql.printSchema | Boolean flag indicating whether to print the schema after generator creates it | false |
| graphql.serializationLibrary | Configure which serialization library will be used for GraphQLRequest and GraphQLResponse types, supported libraries: JACKSON / FASTJSON | JACKSON |
| graphql.federation.enabled | Boolean flag indicating whether to generate federated GraphQL model | false |
| graphql.federation.optInV2 | Boolean flag indicating whether to generate Federation v2 GraphQL model | false |
| graphql.federation.tracing.enabled | Boolean flag indicating whether add federated tracing data to the extensions | true (if federation enabled) |
| graphql.federation.tracing.debug | Boolean flag to log debug info in the federated tracing | false (if federation enabled) |
| graphql.introspection.enabled | Boolean flag indicating whether introspection queries are enabled | true |
| graphql.playground.enabled | Boolean flag indicating whether to enable Prisma Labs Playground GraphQL IDE | false |
| graphql.playground.endpoint | Prisma Labs Playground GraphQL IDE endpoint | playground |
| graphql.graphiql.enabled | Boolean flag indicating whether to enable GraphiQL GraphQL IDE | true |
| graphql.graphiql.endpoint | Prisma Labs Playground GraphQL IDE endpoint | graphiql |
| graphql.sdl.enabled | Boolean flag indicating whether to expose SDL endpoint | true |
| graphql.sdl.endpoint | GraphQL SDL endpoint | sdl |
| graphql.subscriptions.connectionInitTimeout | Server timeout (in milliseconds) between establishing web socket connection and receiving connection-init message | 60_000 |
| graphql.subscriptions.endpoint | GraphQL subscriptions endpoint | subscriptions |
| 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 |
| graphql.subscriptions.protocol | WebSocket based subscription protocol. Supported protocols: APOLLO_SUBSCRIPTIONS_WS / GRAPHQL_WS | GRAPHQL_WS |
| graphql.batching.enabled | Boolean flag indicating whether to enable custom dataloader instrumentations for 1 or more GraphQL Operations | false |
| graphql.batching.strategy | Configure which custom dataloader instrumentation will be used (LEVEL_DISPATCHED or SYNC_EXHAUSTION) | LEVEL_DISPATCHED |

0 comments on commit 1c58a46

Please sign in to comment.