Deprecate GraphQL #10355

sheidkamp · 2024-11-15T01:37:37Z

Description

Deprecate GraphQL - Mark as deprecated in API and the create changelog entry

API changes

Add deprecation warnings

Checklist:

I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
I have added tests that prove my fix is effective or that my feature works

solo-changelog-bot · 2024-11-15T01:37:48Z

Issues linked to changelog:
https://github.com/solo-io/solo-projects/issues/7159

jenshu · 2024-11-15T15:40:43Z

projects/gloo/api/v1/settings.proto

@@ -287,7 +287,7 @@ message Settings {

        message FdsOptions {
            // Enable function discovery service on GraphQL gRPC and OpenApi upstreams. Defaults to true.


we should also add language about deprecation to the field comments; i don't think the [deprecated = true] tag has any effect on our generated docs.

Good catch, updated text

projects/gloo/api/v1/proxy.proto

jenshu · 2024-11-15T15:48:31Z

projects/gloo/api/v1/settings.proto

 }

-// GraphQL settings used by the control plane and UI.
+// Deprecated: GraphQL settings used by the control plane and UI.
 message GraphqlOptions {


i think there are some other files that we can add the deprecation messages to.

these are all the files i see 'graphql' references in. we probably don't need to modify the external/envoy ones since those are just imported into the user-facing protos

projects/gateway/api/v1/virtual_service.proto projects/gloo/api/external/envoy/extensions/graphql/graphql.proto projects/gloo/api/external/envoy/extensions/graphql/stitching.proto projects/gloo/api/v1/enterprise/options/graphql/v1beta1/graphql.proto projects/gloo/api/v1/options/graphql/graphql.proto projects/gloo/api/v1/options/service_spec.proto projects/gloo/api/v1/proxy.proto projects/gloo/api/v1/settings.proto

TY, I think something has been off with my VS code search. Updated in a bunch of places. Agree that we don't need to update the external/envoy ones as those docs are going to get deleted as part of an in-flight ticket.

Co-authored-by: Jenny Shu <[email protected]>

sheidkamp

UPdated, ty!

sheidkamp · 2024-11-15T16:26:48Z

projects/gloo/api/v1/settings.proto

@@ -287,7 +287,7 @@ message Settings {

        message FdsOptions {
            // Enable function discovery service on GraphQL gRPC and OpenApi upstreams. Defaults to true.


Good catch, updated text

sheidkamp · 2024-11-15T16:38:11Z

projects/gloo/api/v1/settings.proto

 }

-// GraphQL settings used by the control plane and UI.
+// Deprecated: GraphQL settings used by the control plane and UI.
 message GraphqlOptions {


TY, I think something has been off with my VS code search. Updated in a bunch of places. Agree that we don't need to update the external/envoy ones as those docs are going to get deleted as part of an in-flight ticket.

Nadine2016 · 2024-11-15T16:46:32Z

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

@@ -213,7 +213,7 @@ top-level `RouteTable` resources.
 | `redirectAction` | [.gloo.solo.io.RedirectAction](../../../../gloo/api/v1/proxy.proto.sk/#redirectaction) | Redirect actions tell the proxy to return a redirect response to the downstream client. Only one of `redirectAction`, `routeAction`, `directResponseAction`, `delegateAction`, or `graphqlApiRef` can be set. |
 | `directResponseAction` | [.gloo.solo.io.DirectResponseAction](../../../../gloo/api/v1/proxy.proto.sk/#directresponseaction) | Return an arbitrary HTTP response directly, without proxying. Only one of `directResponseAction`, `routeAction`, `redirectAction`, `delegateAction`, or `graphqlApiRef` can be set. |
 | `delegateAction` | [.gateway.solo.io.DelegateAction](../virtual_service.proto.sk/#delegateaction) | Delegate routing actions for the given matcher to one or more RouteTables. Only one of `delegateAction`, `routeAction`, `redirectAction`, `directResponseAction`, or `graphqlApiRef` can be set. |
-| `graphqlApiRef` | [.core.solo.io.ResourceRef](../../../../../../solo-kit/api/v1/ref.proto.sk/#resourceref) | Enterprise-Only: THIS FEATURE IS IN TECH PREVIEW. APIs are versioned as alpha and subject to change. A reference to a GraphQLApi CR. Resolution of the client request to upstream(s) will be delegated to the resolution policies defined in the GraphQLApi CR. If configured, the graphql filter will operate instead of the envoy router filter, so configuration (such as retries) that applies to the router filter will not be applied. Only one of `graphqlApiRef`, `routeAction`, `redirectAction`, `directResponseAction`, or `delegateAction` can be set. |
+| `graphqlApiRef` | [.core.solo.io.ResourceRef](../../../../../../solo-kit/api/v1/ref.proto.sk/#resourceref) | Deprecated, Enterprise-Only: THIS FEATURE WILL BE REMOVED IN A FUTURE RELEASE APIs are versioned as alpha and subject to change. A reference to a GraphQLApi CR. Resolution of the client request to upstream(s) will be delegated to the resolution policies defined in the GraphQLApi CR. If configured, the graphql filter will operate instead of the envoy router filter, so configuration (such as retries) that applies to the router filter will not be applied. Only one of `graphqlApiRef`, `routeAction`, `redirectAction`, `directResponseAction`, or `delegateAction` can be set. |


Suggested change

| `graphqlApiRef` | [.core.solo.io.ResourceRef](../../../../../../solo-kit/api/v1/ref.proto.sk/#resourceref) | Deprecated, Enterprise-Only: THIS FEATURE WILL BE REMOVED IN A FUTURE RELEASE APIs are versioned as alpha and subject to change. A reference to a GraphQLApi CR. Resolution of the client request to upstream(s) will be delegated to the resolution policies defined in the GraphQLApi CR. If configured, the graphql filter will operate instead of the envoy router filter, so configuration (such as retries) that applies to the router filter will not be applied. Only one of `graphqlApiRef`, `routeAction`, `redirectAction`, `directResponseAction`, or `delegateAction` can be set. |

| `graphqlApiRef` | [.core.solo.io.ResourceRef](../../../../../../solo-kit/api/v1/ref.proto.sk/#resourceref) | Deprecated, Enterprise-Only: THIS FEATURE WILL BE REMOVED IN A FUTURE RELEASE. APIs are versioned as alpha and subject to change. A reference to a GraphQLApi CR. Resolution of the client request to upstream(s) will be delegated to the resolution policies defined in the GraphQLApi CR. If configured, the graphql filter will operate instead of the envoy router filter, so configuration (such as retries) that applies to the router filter will not be applied. Only one of `graphqlApiRef`, `routeAction`, `redirectAction`, `directResponseAction`, or `delegateAction` can be set. |

Nadine2016 · 2024-11-15T16:47:24Z

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

@@ -46,6 +46,7 @@ weight: 5
 ### RequestTemplate


+Deprecated: The GraphQL feature of Gloo Gateway will be removed in a future release


Suggested change

Deprecated: The GraphQL feature of Gloo Gateway will be removed in a future release

Deprecated: The GraphQL feature of Gloo Gateway will be removed in a future release.

missing period applies to all of these notes

Nadine2016 · 2024-11-15T16:48:14Z

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

@@ -431,7 +431,7 @@ Routes declare the entry points on virtual hosts and the action to take for matc
 | `routeAction` | [.gloo.solo.io.RouteAction](../proxy.proto.sk/#routeaction) | This action is the primary action to be selected for most routes. The RouteAction tells the proxy to route requests to an upstream. Only one of `routeAction`, `redirectAction`, `directResponseAction`, or `graphqlApiRef` can be set. |
 | `redirectAction` | [.gloo.solo.io.RedirectAction](../proxy.proto.sk/#redirectaction) | Redirect actions tell the proxy to return a redirect response to the downstream client. Only one of `redirectAction`, `routeAction`, `directResponseAction`, or `graphqlApiRef` can be set. |
 | `directResponseAction` | [.gloo.solo.io.DirectResponseAction](../proxy.proto.sk/#directresponseaction) | Return an arbitrary HTTP response directly, without proxying. Only one of `directResponseAction`, `routeAction`, `redirectAction`, or `graphqlApiRef` can be set. |
-| `graphqlApiRef` | [.core.solo.io.ResourceRef](../../../../../../solo-kit/api/v1/ref.proto.sk/#resourceref) | Enterprise-Only: THIS FEATURE IS IN TECH PREVIEW. APIs are versioned as alpha and subject to change. A reference to a GraphQLApi CR. Resolution of the client request to upstream(s) will be delegated to the resolution policies defined in the GraphQLApi CR. If configured, the graphql filter will operate instead of the envoy router filter, so configuration (such as retries) that applies to the router filter will not be applied. Only one of `graphqlApiRef`, `routeAction`, `redirectAction`, or `directResponseAction` can be set. |
+| `graphqlApiRef` | [.core.solo.io.ResourceRef](../../../../../../solo-kit/api/v1/ref.proto.sk/#resourceref) | Deprecated, Enterprise-Only: This feature is deprecated and wil. APIs are versioned as alpha and subject to change. A reference to a GraphQLApi CR. Resolution of the client request to upstream(s) will be delegated to the resolution policies defined in the GraphQLApi CR. If configured, the graphql filter will operate instead of the envoy router filter, so configuration (such as retries) that applies to the router filter will not be applied. Only one of `graphqlApiRef`, `routeAction`, `redirectAction`, or `directResponseAction` can be set. |


Suggested change

| `graphqlApiRef` | [.core.solo.io.ResourceRef](../../../../../../solo-kit/api/v1/ref.proto.sk/#resourceref) | Deprecated, Enterprise-Only: This feature is deprecated and wil. APIs are versioned as alpha and subject to change. A reference to a GraphQLApi CR. Resolution of the client request to upstream(s) will be delegated to the resolution policies defined in the GraphQLApi CR. If configured, the graphql filter will operate instead of the envoy router filter, so configuration (such as retries) that applies to the router filter will not be applied. Only one of `graphqlApiRef`, `routeAction`, `redirectAction`, or `directResponseAction` can be set. |

| `graphqlApiRef` | [.core.solo.io.ResourceRef](../../../../../../solo-kit/api/v1/ref.proto.sk/#resourceref) | Deprecated, Enterprise-Only: THIS FEATURE IS DEPRECATED AND WILL BE REMOVED IN A FUTURE RELEASE. APIs are versioned as alpha and subject to change. A reference to a GraphQLApi CR. Resolution of the client request to upstream(s) will be delegated to the resolution policies defined in the GraphQLApi CR. If configured, the graphql filter will operate instead of the envoy router filter, so configuration (such as retries) that applies to the router filter will not be applied. Only one of `graphqlApiRef`, `routeAction`, `redirectAction`, or `directResponseAction` can be set. |

Nadine2016 · 2024-11-15T16:48:53Z

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

@@ -957,6 +957,7 @@ options for configuring admission control / validation
 ### ConsoleOptions


+Deprecated. The GraphQL feature will be removed in a future release.


Suggested change

Deprecated. The GraphQL feature will be removed in a future release.

Deprecated: The GraphQL feature will be removed in a future release.

Nadine2016 · 2024-11-15T16:49:02Z

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

@@ -977,6 +978,7 @@ Settings used by the Enterprise Console (UI)
 ### GraphqlOptions


+Deprecated. The GraphQL feature will be removed in a future release.


Suggested change

Deprecated. The GraphQL feature will be removed in a future release.

Deprecated: The GraphQL feature will be removed in a future release.

projects/gateway/api/v1/virtual_service.proto

Nadine2016 · 2024-11-15T16:49:20Z

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

@@ -599,7 +599,7 @@ type Route_DelegateAction struct {
 }

 type Route_GraphqlApiRef struct {
-	// Enterprise-Only: THIS FEATURE IS IN TECH PREVIEW. APIs are versioned as alpha and subject to change.
+	// Deprecated, Enterprise-Only: THIS FEATURE WILL BE REMOVED IN A FUTURE RELEASE APIs are versioned as alpha and subject to change.


Suggested change

// Deprecated, Enterprise-Only: THIS FEATURE WILL BE REMOVED IN A FUTURE RELEASE APIs are versioned as alpha and subject to change.

// Deprecated, Enterprise-Only: THIS FEATURE WILL BE REMOVED IN A FUTURE RELEASE. APIs are versioned as alpha and subject to change.

projects/gloo/api/v1/settings.proto

projects/gloo/pkg/api/v1/proxy.pb.go

Nadine2016 · 2024-11-15T16:50:56Z

projects/gloo/pkg/api/v1/settings.pb.go

@@ -268,7 +268,10 @@ type Settings struct {
 	UpstreamOptions *UpstreamOptions `protobuf:"bytes,32,opt,name=upstreamOptions,proto3" json:"upstreamOptions,omitempty"`
 	// Enterprise-only: Settings for the Gloo Edge Enterprise Console (UI)
 	ConsoleOptions *ConsoleOptions `protobuf:"bytes,35,opt,name=console_options,json=consoleOptions,proto3" json:"console_options,omitempty"`
+	// Deprecated. The GraphQL feature will be removed in a future release.


Suggested change

// Deprecated. The GraphQL feature will be removed in a future release.

// Deprecated: The GraphQL feature will be removed in a future release.

Nadine2016 · 2024-11-15T16:51:04Z

projects/gloo/pkg/api/v1/settings.pb.go

@@ -1312,6 +1316,7 @@ func (x *GatewayOptions) GetTranslateEmptyGateways() *wrapperspb.BoolValue {
 	return nil
 }

+// Deprecated. The GraphQL feature will be removed in a future release.


Suggested change

// Deprecated. The GraphQL feature will be removed in a future release.

// Deprecated: The GraphQL feature will be removed in a future release.

Nadine2016 · 2024-11-15T16:51:13Z

projects/gloo/pkg/api/v1/settings.pb.go

@@ -1373,6 +1378,7 @@ func (x *ConsoleOptions) GetApiExplorerEnabled() *wrapperspb.BoolValue {
 	return nil
 }

+// Deprecated. The GraphQL feature will be removed in a future release.


Suggested change

// Deprecated. The GraphQL feature will be removed in a future release.

// Deprecated: The GraphQL feature will be removed in a future release.

Nadine2016 · 2024-11-15T16:51:21Z

projects/gloo/pkg/api/v1/settings.pb.go

@@ -2802,7 +2808,10 @@ type Settings_DiscoveryOptions_FdsOptions struct {
 	sizeCache     protoimpl.SizeCache
 	unknownFields protoimpl.UnknownFields

+	// Deprecated. The GraphQL feature will be removed in a future release.


Suggested change

// Deprecated. The GraphQL feature will be removed in a future release.

// Deprecated: The GraphQL feature will be removed in a future release.

Co-authored-by: Nadine Spies <[email protected]>

…o/gloo into sheidkamp/deprecate-graphql

sam-heilbron

LGTM! Should we also make a note on https://docs.solo.io/gloo-edge/latest/guides/graphql/?

sheidkamp · 2024-11-15T18:08:57Z

LGTM! Should we also make a note on https://docs.solo.io/gloo-edge/latest/guides/graphql/?

Added a warning at the top and a note to https://github.com/solo-io/solo-projects/issues/7161 to include the guides.

sheidkamp · 2024-11-15T18:20:58Z

/kick (unclear failure)

sheidkamp added 4 commits November 14, 2024 11:04

mark deprecated

400c1cd

Create deprecate-graphql.yaml

f091373

Update deprecate-graphql.yaml

cd076d3

Update deprecate-graphql.yaml

eab2475

sheidkamp requested a review from a team as a code owner November 15, 2024 01:37

github-actions bot added keep pr updated work in progress labels Nov 15, 2024

sheidkamp removed the work in progress label Nov 15, 2024

jenshu reviewed Nov 15, 2024

View reviewed changes

projects/gloo/api/v1/proxy.proto Outdated Show resolved Hide resolved

jenshu reviewed Nov 15, 2024

View reviewed changes

sheidkamp and others added 2 commits November 15, 2024 10:49

Apply suggestions from code review

815a600

Co-authored-by: Jenny Shu <[email protected]>

More doc updates

fcb3ab0

sheidkamp commented Nov 15, 2024

View reviewed changes

Nadine2016 reviewed Nov 15, 2024

View reviewed changes

projects/gateway/api/v1/virtual_service.proto Outdated Show resolved Hide resolved

Nadine2016 reviewed Nov 15, 2024

View reviewed changes

projects/gloo/api/v1/settings.proto Outdated Show resolved Hide resolved

Nadine2016 reviewed Nov 15, 2024

View reviewed changes

projects/gloo/pkg/api/v1/proxy.pb.go Outdated Show resolved Hide resolved

Nadine2016 reviewed Nov 15, 2024

View reviewed changes

Apply suggestions from code review

793df39

Co-authored-by: Nadine Spies <[email protected]>

sheidkamp changed the title ~~Sheidkamp/deprecate graphql~~ Deprecate GraphQL Nov 15, 2024

sheidkamp and others added 4 commits November 15, 2024 12:02

PR Feedback

73e1419

Update projects/gloo/pkg/api/v1/proxy.pb.go

1505cf6

Co-authored-by: Nadine Spies <[email protected]>

"Deprecated." => "Deprecated:"

7ab70b4

Merge branch 'sheidkamp/deprecate-graphql' of ssh://github.com/solo-i…

7ef487d

…o/gloo into sheidkamp/deprecate-graphql

Nadine2016 approved these changes Nov 15, 2024

View reviewed changes

sam-heilbron approved these changes Nov 15, 2024

View reviewed changes

regenerate

f92cfdc

Add deprecaton

1bc49eb

Merge branch 'main' into sheidkamp/deprecate-graphql

feb1987

sam-heilbron approved these changes Nov 15, 2024

View reviewed changes

jenshu approved these changes Nov 15, 2024

View reviewed changes

sheidkamp merged commit b9287ef into main Nov 15, 2024
17 of 18 checks passed

sheidkamp deleted the sheidkamp/deprecate-graphql branch November 15, 2024 19:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deprecate GraphQL #10355

Deprecate GraphQL #10355

sheidkamp commented Nov 15, 2024

solo-changelog-bot bot commented Nov 15, 2024

jenshu Nov 15, 2024

sheidkamp Nov 15, 2024

jenshu Nov 15, 2024

sheidkamp Nov 15, 2024

sheidkamp left a comment

sheidkamp Nov 15, 2024

sheidkamp Nov 15, 2024

Nadine2016 Nov 15, 2024

Nadine2016 Nov 15, 2024

Nadine2016 Nov 15, 2024

Nadine2016 Nov 15, 2024

Nadine2016 Nov 15, 2024

Nadine2016 Nov 15, 2024

Nadine2016 Nov 15, 2024

Nadine2016 Nov 15, 2024

Nadine2016 Nov 15, 2024

Nadine2016 Nov 15, 2024

Nadine2016 Nov 15, 2024

sam-heilbron left a comment

sheidkamp commented Nov 15, 2024

sheidkamp commented Nov 15, 2024

		@@ -287,7 +287,7 @@ message Settings {

		message FdsOptions {
		// Enable function discovery service on GraphQL gRPC and OpenApi upstreams. Defaults to true.

		@@ -46,6 +46,7 @@ weight: 5
		### RequestTemplate


		Deprecated: The GraphQL feature of Gloo Gateway will be removed in a future release

		@@ -957,6 +957,7 @@ options for configuring admission control / validation
		### ConsoleOptions


		Deprecated. The GraphQL feature will be removed in a future release.

	Deprecated. The GraphQL feature will be removed in a future release.
	Deprecated: The GraphQL feature will be removed in a future release.

		@@ -977,6 +978,7 @@ Settings used by the Enterprise Console (UI)
		### GraphqlOptions


		Deprecated. The GraphQL feature will be removed in a future release.

	// Deprecated, Enterprise-Only: THIS FEATURE WILL BE REMOVED IN A FUTURE RELEASE APIs are versioned as alpha and subject to change.
	// Deprecated, Enterprise-Only: THIS FEATURE WILL BE REMOVED IN A FUTURE RELEASE. APIs are versioned as alpha and subject to change.

	// Deprecated. The GraphQL feature will be removed in a future release.
	// Deprecated: The GraphQL feature will be removed in a future release.

Deprecate GraphQL #10355

Deprecate GraphQL #10355

Conversation

sheidkamp commented Nov 15, 2024

Description

API changes

Checklist:

solo-changelog-bot bot commented Nov 15, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sheidkamp left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sam-heilbron left a comment

Choose a reason for hiding this comment

sheidkamp commented Nov 15, 2024

sheidkamp commented Nov 15, 2024