Skip to content

Add new overlays #24

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.

Sign up for GitHub

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

Merged
merged 10 commits into from
Oct 9, 2025
Merged

Add new overlays #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
092fd03
Address coderabbit suggestion on removing internal only value NETWORK…
Oct 2, 2025
04574e9
RESOURCE_TYPE_ANY is not available when creating a new ACL
Oct 2, 2025
c50fead
Tiny changes to force deploy preview with overlays applied
Oct 2, 2025
d1c85e2
Fix JSONPath
Oct 6, 2025
ff90cb6
Apply suggestions from automated review
Oct 6, 2025
b9a0c4f
Fix workflow errors
Oct 6, 2025
a4d233d
Fix syntax error
Oct 6, 2025
795cad1
Try using a new component schema instead
Oct 6, 2025
91c497f
Fix api_gateway_access
Oct 9, 2025
6c7eea9
Note about manually updating resource types
Oct 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions cloud-controlplane/overlays/update-api-gateway-access.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# This overlay updates the Cluster object in response examples to only use a
# user-facing value for the api_gateway_access field.
overlay: 1.0.0
info:
title: Update API Gateway Access Values in Response Examples
version: 1.0.0

actions:
# Target api_gateway_access fields that are descendants of any example field within responses
- target: "$..responses..example..*[?(@.api_gateway_access == 'NETWORK_ACCESS_MODE_UNSPECIFIED')]"
update:
api_gateway_access: "NETWORK_ACCESS_MODE_PUBLIC"
2 changes: 1 addition & 1 deletion cloud-dataplane/cloud-dataplane.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -683,7 +683,7 @@ components:
{ "reason": "API_DISABLED"
"domain": "googleapis.com"
"metadata": {
"resource": "projects/123",
"resource": "projects/1234",
"service": "pubsub.googleapis.com"
}
}
Expand Down
30 changes: 30 additions & 0 deletions cloud-dataplane/overlays/remove-resource-type-any.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# This overlay removes the RESOURCE_TYPE_ANY value as an available option for the
# resource_type field in the CreateACLRequest schema.
overlay: 1.0.0
info:
title: Remove RESOURCE_TYPE_ANY from Create ACL Request Body
version: 1.0.0

# Note that we will have to manually update this enum if the Cloud team adds
# new resource types in the future.
actions:
- target: "$.components.schemas"
update:
CreateACLResourceType:
description: |-
The type of resource (topic, consumer group, etc.) this
ACL targets.
enum:
Copy link
Contributor

@JakeSCahill JakeSCahill Oct 9, 2025

Choose a reason for hiding this comment

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

Just to keep in mind - we'll need to manually update this list if the Cloud team add more enums to the source.

- "RESOURCE_TYPE_TOPIC"
- "RESOURCE_TYPE_GROUP"
- "RESOURCE_TYPE_CLUSTER"
- "RESOURCE_TYPE_TRANSACTIONAL_ID"
- "RESOURCE_TYPE_DELEGATION_TOKEN"
- "RESOURCE_TYPE_USER"
- "RESOURCE_TYPE_REGISTRY"
- "RESOURCE_TYPE_SUBJECT"
type: "string"
# Replace the $ref with an inline enum that excludes RESOURCE_TYPE_ANY
- target: "$.components.schemas.CreateACLRequest.properties.resource_type"
update:
$ref: '#/components/schemas/CreateACLResourceType'