Skip to content

Commit

Permalink
chore: add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Samuel Vazquez committed Oct 3, 2024
1 parent 867ce5d commit bfa5505
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 42 deletions.
43 changes: 22 additions & 21 deletions website/docs/server/spring-server/spring-properties.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,24 +10,25 @@ 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.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 | SYNC_EXHAUSTION |
| 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.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 | SYNC_EXHAUSTION |
43 changes: 22 additions & 21 deletions website/versioned_docs/version-8.x.x/server/spring-server/spring-properties.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,24 +10,25 @@ 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.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 | SYNC_EXHAUSTION |
| 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.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 | SYNC_EXHAUSTION |

0 comments on commit bfa5505

Please sign in to comment.