Add new overlays

[kbatuigas]

This pull request introduces targeted updates to the API schema overlays and response examples for the cloud control plane and data plane. The changes focus on improving user-facing clarity, enforcing stricter schema validation, and correcting resource identifiers in error metadata.

API schema and response example improvements:

• Updated response examples for the Cluster object to use a more descriptive value (NETWORK_ACCESS_MODE_PUBLIC) for the api_gateway_access field, replacing the previous unspecified mode.

Schema validation and enum restrictions:

• Removed RESOURCE_TYPE_ANY as a valid option for the resource_type field in the CreateACLRequest schema, ensuring only specific resource types are allowed. The enum is now explicitly defined in a new restricted component CreateACLResourceType and the $ref is updated to point to the restricted schema.

Resolves https://redpandadata.atlassian.net/browse/DOC-1657

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

Adds two overlay YAML files:

• cloud-controlplane/overlays/update-api-gateway-access.yaml: Rewrites response example values for example.api_gateway_access from NETWORK_ACCESS_MODE_UNSPECIFIED to NETWORK_ACCESS_MODE_PUBLIC using a JSONPath selector and update action.
• cloud-dataplane/overlays/remove-resource-type-any.yaml: Modifies CreateACLRequest.properties.resource_type schema by inlining an enum and removing RESOURCE_TYPE_ANY; retains type: string and lists specific allowed values.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

• micheleRP

Pre-merge checks and finishing touches

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Out of Scope Changes Check	⚠️ Warning	The addition of an overlay updating the api_gateway_access response examples is not covered by the linked DOC-1657 issue and introduces changes outside the specified objectives for updating ACL values in the data plane API.	Either remove the api_gateway_access overlay from this pull request or link it to the appropriate control plane issue that authorizes those example updates.
Title Check	❓ Inconclusive	The title “Add new overlays” is too generic and does not convey the specific schema updates introduced in this pull request, making it unclear to readers what the main changes are.	Consider revising the title to clearly summarize the primary changes, for example “Update api_gateway_access examples and remove RESOURCE_TYPE_ANY from ACL schema”.

✅ Passed checks (3 passed)

Check name	Status	Explanation
Linked Issues Check	✅ Passed	The changes remove the RESOURCE_TYPE_ANY enum value from CreateACLRequest as specified in DOC-1657, fulfilling the coding requirement for updating ACL values in the data plane API.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.
Description Check	✅ Passed	The pull request description accurately outlines the changes made to the API schema overlays by detailing the update of the api_gateway_access example to NETWORK_ACCESS_MODE_PUBLIC and the removal of RESOURCE_TYPE_ANY from the CreateACLRequest schema, and it directly reflects the modifications in the provided overlay files.

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[github-actions]

ℹ️ API content change detected:

No structural change, nothing to display.

Preview documentation

Powered by Bump.sh

[JakeSCahill]

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