Skip to content

Commit b9287ef

Browse files
authored
Merge pull request #10355 from solo-io/sheidkamp/deprecate-graphql
Deprecate GraphQL
2 parents 2c3b8fb + feb1987 commit b9287ef

File tree

19 files changed

+914
-848
lines changed

19 files changed

+914
-848
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
changelog:
2+
- type: FIX
3+
issueLink: https://github.com/solo-io/solo-projects/issues/7159
4+
resolvesIssue: false
5+
description: >-
6+
The GraphQL feature of Gloo Gateway is deprecated and will be removed in a future release

docs/content/guides/graphql/_index.md

+3
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ description: Enable GraphQL resolution.
66

77
Set up API gateway and GraphQL server functionality for your apps in the same process by using Gloo Gateway.
88

9+
{{% notice warning %}}
10+
This feature is deprecated in Gloo Gateway 1.18 and will be removed in a future release
11+
{{% /notice %}}
912
{{% notice note %}}
1013
This feature is available only in Gloo Gateway Enterprise.
1114
{{% /notice %}}

docs/content/reference/api/github.com/solo-io/gloo/projects/gateway/api/v1/virtual_service.proto.sk.md

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/api/github.com/solo-io/gloo/projects/gloo/api/v1/enterprise/options/graphql/v1beta1/graphql.proto.sk.md

+17-6
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/api/github.com/solo-io/gloo/projects/gloo/api/v1/options/graphql/graphql.proto.sk.md

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/api/github.com/solo-io/gloo/projects/gloo/api/v1/proxy.proto.sk.md

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/api/github.com/solo-io/gloo/projects/gloo/api/v1/settings.proto.sk.md

+4-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

projects/gateway/api/v1/virtual_service.proto

+1-1
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ message Route {
223223
// Delegate routing actions for the given matcher to one or more RouteTables.
224224
DelegateAction delegate_action = 5;
225225

226-
// Enterprise-Only: THIS FEATURE IS IN TECH PREVIEW. APIs are versioned as alpha and subject to change.
226+
// Deprecated, Enterprise-Only: THIS FEATURE WILL BE REMOVED IN A FUTURE RELEASE. APIs are versioned as alpha and subject to change.
227227
// A reference to a GraphQLApi CR. Resolution of the client request to upstream(s) will be delegated to
228228
// the resolution policies defined in the GraphQLApi CR. If configured, the graphql filter will operate
229229
// instead of the envoy router filter, so configuration (such as retries) that applies to the router filter

projects/gateway/pkg/api/v1/virtual_service.pb.go

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

projects/gloo/api/v1/enterprise/options/graphql/v1beta1/graphql.proto

+12-1
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ import "google/protobuf/wrappers.proto";
4747
- use `a[*][1]` to create a list of all values from object "a"
4848
*/
4949

50+
// Deprecated: The GraphQL feature of Gloo Gateway will be removed in a future release.
5051
// Defines a configuration for generating outgoing requests for a resolver.
5152
message RequestTemplate {
5253
// Use this attribute to set request headers to your REST service. It consists of a
@@ -77,6 +78,7 @@ message RequestTemplate {
7778
google.protobuf.Value body = 3;
7879
}
7980

81+
// Deprecated: The GraphQL feature of Gloo Gateway will be removed in a future release.
8082
message ResponseTemplate {
8183
/*
8284
Sets the "root" of the upstream response to be turned into a graphql type by the graphql server.
@@ -120,6 +122,7 @@ message ResponseTemplate {
120122
map<string, string> setters = 2;
121123
}
122124

125+
// Deprecated: The GraphQL feature of Gloo Gateway will be removed in a future release.
123126
// Defines a configuration for generating outgoing requests for a resolver.
124127
message GrpcRequestTemplate {
125128
// json representation of outgoing gRPC message to be sent to gRPC service
@@ -138,6 +141,7 @@ message GrpcRequestTemplate {
138141
map<string, string> request_metadata = 4;
139142
}
140143

144+
// Deprecated: The GraphQL feature of Gloo Gateway will be removed in a future release.
141145
// control-plane API
142146
message RESTResolver {
143147
core.solo.io.ResourceRef upstream_ref = 1;
@@ -153,6 +157,7 @@ message RESTResolver {
153157
google.protobuf.Duration timeout = 5;
154158
}
155159

160+
// Deprecated: The GraphQL feature of Gloo Gateway will be removed in a future release.
156161
// Defines a configuration for serializing and deserializing requests for a gRPC resolver.
157162
// Is a Schema Extension
158163
message GrpcDescriptorRegistry {
@@ -199,6 +204,7 @@ message GrpcResolver {
199204
google.protobuf.Duration timeout = 5;
200205
}
201206

207+
// Deprecated: The GraphQL feature of Gloo Gateway will be removed in a future release.
202208
message StitchedSchema {
203209

204210
message SubschemaConfig {
@@ -286,6 +292,7 @@ message StitchedSchema {
286292
repeated SubschemaConfig subschemas = 1;
287293
}
288294

295+
// Deprecated: The GraphQL feature of Gloo Gateway will be removed in a future release.
289296
message MockResolver {
290297
message AsyncResponse {
291298
// The response from the resolver as a JSON.
@@ -305,6 +312,7 @@ message MockResolver {
305312
}
306313
}
307314

315+
// Deprecated: The GraphQL feature of Gloo Gateway will be removed in a future release.
308316
// Define a named resolver which can be then matched to a field using the `resolve` directive.
309317
// if a field does not have resolver, the default resolver will be used.
310318
// the default resolver takes the field with the same name from the parent, and uses that value
@@ -331,7 +339,7 @@ message Resolution {
331339
google.protobuf.StringValue stat_prefix = 3;
332340
}
333341

334-
// Enterprise-Only: THIS FEATURE IS IN TECH PREVIEW. APIs are versioned as alpha and subject to change.
342+
// Deprecated, Enterprise-Only: THIS FEATURE IS DEPRECATED AND WILL BE REMOVED IN A FUTURE RELEASE. APIs are versioned as alpha and subject to change.
335343
// User-facing CR config for resolving client requests to graphql schemas.
336344
// Routes that have this config will execute graphql queries, and will not make it to the router filter. i.e. this
337345
// filter will terminate the request for these routes.
@@ -381,12 +389,14 @@ message GraphQLApi {
381389
GraphQLApiOptions options = 8;
382390
}
383391

392+
// Deprecated: The GraphQL feature of Gloo Gateway will be removed in a future release.
384393
// This message specifies Persisted Query Cache configuration.
385394
message PersistedQueryCacheConfig {
386395
// The unit is number of queries to store, default to 1000.
387396
uint32 cache_size = 1;
388397
}
389398

399+
// Deprecated: The GraphQL feature of Gloo Gateway will be removed in a future release.
390400
message ExecutableSchema {
391401
// Schema to use in string format.
392402

@@ -420,6 +430,7 @@ message ExecutableSchema {
420430
GrpcDescriptorRegistry grpc_descriptor_registry = 3;
421431
}
422432

433+
// Deprecated: The GraphQL feature of Gloo Gateway will be removed in a future release.
423434
message Executor {
424435
// Execute schema using resolvers.
425436
message Local {

0 commit comments

Comments
 (0)