auto-docs: Update Cloud API spec#64
Open
vbotbuildovich wants to merge 1 commit into
Open
Conversation
ℹ️ Redpanda/cloud-dataplane API content change detectedNo structural change, nothing to display. Powered by Bump.sh |
📝 WalkthroughWalkthroughThis pull request updates the Cloud Dataplane OpenAPI specification file with enum extensions and documentation refinements. The changes include: adding Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@cloud-dataplane/cloud-dataplane.yaml`:
- Line 7841: The OpenAPI example is currently a JSON string but schema.type is
object; update the `example` value to be an actual object (not a string)
matching the schema for this payload: use an object with keys name,
input_topic_name, output_topic_names (array of strings), and
environment_variables (array of objects with key and value) so the example's
type aligns with schema.type: object.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: ba073741-2761-4144-b314-f5e57f430b7f
📒 Files selected for processing (1)
cloud-dataplane/cloud-dataplane.yaml
| multipart/form-data: | ||
| schema: | ||
| example: '{"name":"redact-orders","input_topic_name":"orders","output_topic_names":["orders-redacted"],"environment_variables":[{"key":"LOGGER_LEVEL","value":"DEBUG"}]}' | ||
| example: '{"name":"redact-orders", "input_topic_name":"orders", "output_topic_names":["orders-redacted"], "environment_variables":[{"key":"LOGGER_LEVEL", "value":"DEBUG"}]}' |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
python -m pip install --quiet pyyaml >/dev/null
python - <<'PY'
import yaml
p = "cloud-dataplane/cloud-dataplane.yaml"
with open(p, "r", encoding="utf-8") as f:
doc = yaml.safe_load(f)
schema = doc["paths"]["/v1/transforms"]["put"]["requestBody"]["content"]["multipart/form-data"]["schema"]
example = schema.get("example")
print("schema.type =", schema.get("type"))
print("example python type =", type(example).__name__)
print("mismatch =", schema.get("type") == "object" and not isinstance(example, dict))
PYRepository: redpanda-data/api-docs
Length of output: 128
Fix example type to match schema type object.
At line 7841, the example is a JSON string literal but schema.type is object. OpenAPI requires the example value to match its schema type.
Proposed fix
- example: '{"name":"redact-orders", "input_topic_name":"orders", "output_topic_names":["orders-redacted"], "environment_variables":[{"key":"LOGGER_LEVEL", "value":"DEBUG"}]}'
+ example:
+ name: redact-orders
+ input_topic_name: orders
+ output_topic_names:
+ - orders-redacted
+ environment_variables:
+ - key: LOGGER_LEVEL
+ value: DEBUG📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| example: '{"name":"redact-orders", "input_topic_name":"orders", "output_topic_names":["orders-redacted"], "environment_variables":[{"key":"LOGGER_LEVEL", "value":"DEBUG"}]}' | |
| example: | |
| name: redact-orders | |
| input_topic_name: orders | |
| output_topic_names: | |
| - orders-redacted | |
| environment_variables: | |
| - key: LOGGER_LEVEL | |
| value: DEBUG |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@cloud-dataplane/cloud-dataplane.yaml` at line 7841, The OpenAPI example is
currently a JSON string but schema.type is object; update the `example` value to
be an actual object (not a string) matching the schema for this payload: use an
object with keys name, input_topic_name, output_topic_names (array of strings),
and environment_variables (array of objects with key and value) so the example's
type aligns with schema.type: object.
vbotbuildovich
force-pushed
the
update-branch-api
branch
from
94a5ba8 to
241993f
Compare
🤖 Redpanda/cloud-controlplane API structural change detectedStructural change detailsModified (20)
Powered by Bump.sh |
vbotbuildovich
force-pushed
the
update-branch-api
branch
2 times, most recently
from
2acb61c to
5581991
Compare
vbotbuildovich
force-pushed
the
update-branch-api
branch
from
5581991 to
9b258d3
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR updates the OpenAPI spec file for the Cloud API.
Triggered by commit: 2a72f471c11d2cb60fcfae45905ac6e3f40c8e41