Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

1.17.x - delete internal api docs #10372

Merged
merged 4 commits into from
Nov 19, 2024

Conversation

sheidkamp
Copy link

Description

Backport of kgateway-dev#10334

@sheidkamp sheidkamp requested a review from a team as a code owner November 18, 2024 20:52
@solo-changelog-bot
Copy link

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

@@ -66,7 +66,7 @@ and FilterChain configuration (MatchableHttpGateway CR)

| Field | Type | Description |
| ----- | ---- | ----------- |
| `sourcePrefixRanges` | [[]solo.io.envoy.config.core.v3.CidrRange](../../../../gloo/api/external/envoy/config/core/v3/address.proto.sk/#cidrrange) | CidrRange specifies an IP Address and a prefix length to construct the subnet mask for a CIDR range. See https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/address.proto#envoy-v3-api-msg-config-core-v3-cidrrange. |

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is a change like this safe?

This CidrRange API is part of our public MatchableHttpGateway API, right? The fact that the API is an attempted mirror of an Envoy API is an implementation detail, but I would image we would still want users to have a link to the proto definition.

Am I missing something?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There was a discussion of this here: https://solo-io-corp.slack.com/archives/C03MFATU265/p1731608037978029?thread_ts=1731598700.372589&cid=C03MFATU265

with a follow-up issue to restore the links created: kgateway-dev#10349

After I'm done the licensing ticket, I'll take a look to see if that can be done quickly.

@soloio-bulldozer soloio-bulldozer bot merged commit 76c3470 into v1.17.x Nov 19, 2024
17 checks passed
@soloio-bulldozer soloio-bulldozer bot deleted the 1.17.x-delete-internal-api-docs branch November 19, 2024 17:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants