Catch up to latest spec versions from docs/api branch #18
Conversation
📝 WalkthroughWalkthroughThe schema-registry OpenAPI JSON updates from v1.0.6 to v1.1.0 and changes host to localhost:8081. A new /security/acls path is added with GET/POST/DELETE using a new security_acl definition. The subject_schema definition is renamed to stored_schema with all $ref updates. A new string query parameter format is added to several schema retrieval endpoints with 501 responses for unsupported values. The deleted query parameter type changes from string to boolean on multiple subject/version endpoints. Minor error description text is updated. Sequence Diagram(s)sequenceDiagram
participant Client
participant Registry API
Note over Client,Registry API: ACL Management (/security/acls)
Client->>Registry API: GET /security/acls?principal=&resource=&...
Registry API-->>Client: 200 [security_acl[]] | 401/403/500
Client->>Registry API: POST /security/acls { acls: security_acl[] }
Registry API-->>Client: 201 | 400/401/403/500
Client->>Registry API: DELETE /security/acls { acls: security_acl[] }
Registry API-->>Client: 200 [security_acl[]] | 400/401/403/500
sequenceDiagram
participant Client
participant Registry API
Note over Client,Registry API: Schema retrieval with format parameter
Client->>Registry API: GET /schemas/ids/{id}?format={value}
alt supported format
Registry API-->>Client: 200 stored_schema
else unsupported format
Registry API-->>Client: 501 Not Implemented
end
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
|
🚨 Breaking API change detected: Added (3)
Modified (6)
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (10)
schema-registry/schema-registry.json (10)
556-560: Booleanize deleted parameter: add an explicit defaultConsider documenting the default to reduce ambiguity in generated clients and docs.
Apply this diff:
{ "name": "deleted", "in": "query", "required": false, - "type": "boolean" + "type": "boolean", + "default": false }
598-602: Booleanize deleted parameter: add an explicit defaultSame suggestion for /subjects.
{ "name": "deleted", "in": "query", "required": false, - "type": "boolean" + "type": "boolean", + "default": false }
780-784: Booleanize deleted parameter: add an explicit defaultSame suggestion for /subjects/{subject}/versions.
{ "name": "deleted", "in": "query", "required": false, - "type": "boolean" + "type": "boolean", + "default": false }
900-904: Booleanize deleted parameter: add an explicit defaultSame suggestion for GET /subjects/{subject}/versions/{version}.
{ "name": "deleted", "in": "query", "required": false, - "type": "boolean" + "type": "boolean", + "default": false }
1026-1030: Booleanize deleted parameter: add an explicit defaultSame suggestion for GET raw schema.
{ "name": "deleted", "in": "query", "required": false, - "type": "boolean" + "type": "boolean", + "default": false }
446-451: Constrain format values with enum + default (helps client SDKs and docs)Defining allowed values improves codegen and prevents invalid inputs. You can still document Protobuf-only semantics in the description.
Note: Some code generators struggle with empty string enums; if that’s a concern, we can alternatively omit enum for "" and only enumerate "serialized". As-is, adding both works with most tools.
{ "name": "format", "in": "query", "required": false, - "type": "string", - "description": "Redpanda version 25.2 or later. For Avro and Protobuf schemas only. Supported values: an empty string `''` returns the schema in its current format (default), and `serialized` (Protobuf only) returns the schema in its Base64-encoded wire binary format. Unsupported values return a 501 error." + "type": "string", + "enum": ["", "serialized"], + "default": "", + "description": "Redpanda version 25.2 or later. Avro/Protobuf only. Supported values: empty string `''` (default) returns the schema in its current format; `serialized` (Protobuf only) returns the Base64-encoded wire binary format. Other values return 501." }
663-668: Apply the same enum/default to format on POST /subjects/{subject}Keep the parameter contract consistent across endpoints.
{ "name": "format", "in": "query", "required": false, - "type": "string", - "description": "Redpanda version 25.2 or later. For Avro and Protobuf schemas only. Supported values: an empty string `''` returns the schema in its current format (default), and `serialized` (Protobuf only) returns the schema in its Base64-encoded wire binary format. Unsupported values return a 501 error." + "type": "string", + "enum": ["", "serialized"], + "default": "", + "description": "Redpanda version 25.2 or later. Avro/Protobuf only. Supported values: empty string `''` (default) returns the schema in its current format; `serialized` (Protobuf only) returns the Base64-encoded wire binary format. Other values return 501." },
906-911: Apply the same enum/default to format on GET subject versionAligns with other endpoints.
{ "name": "format", "in": "query", "required": false, - "type": "string", - "description": "Redpanda version 25.2 or later. For Avro and Protobuf schemas only. Supported values: an empty string `''` returns the schema in its current format (default), and `serialized` (Protobuf only) returns the schema in its Base64-encoded wire binary format. Unsupported values return a 501 error." + "type": "string", + "enum": ["", "serialized"], + "default": "", + "description": "Redpanda version 25.2 or later. Avro/Protobuf only. Supported values: empty string `''` (default) returns the schema in its current format; `serialized` (Protobuf only) returns the Base64-encoded wire binary format. Other values return 501." }
1032-1036: Apply the same enum/default to format on GET raw schemaAligns with other endpoints.
{ "name": "format", "in": "query", "required": false, - "type": "string", - "description": "Redpanda version 25.2 or later. For Avro and Protobuf schemas only. Supported values: an empty string `''` returns the schema in its current format (default), and `serialized` (Protobuf only) returns the schema in its Base64-encoded wire binary format. Unsupported values return a 501 error." + "type": "string", + "enum": ["", "serialized"], + "default": "", + "description": "Redpanda version 25.2 or later. Avro/Protobuf only. Supported values: empty string `''` (default) returns the schema in its current format; `serialized` (Protobuf only) returns the Base64-encoded wire binary format. Other values return 501." }
1271-1479: New /security/acls API surface looks coherent; consider tagging operations for groupingThe GET/POST/DELETE shapes, enums, examples, and error responses look good. To improve UI grouping and client discoverability, add a “Security” tag to these operations.
"get": { + "tags": ["Security"], "summary": "List ACLs", "description": "Returns a list of ACL rules that match the specified filters.", "operationId": "get_security_acls","post": { + "tags": ["Security"], "summary": "Create ACLs", "description": "Create new ACL rules.", "operationId": "post_security_acls","delete": { + "tags": ["Security"], "summary": "Delete ACLs", "description": "Delete ACL rules that match the specified definitions exactly.", "operationId": "delete_security_acls",
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
schema-registry/schema-registry.json(36 hunks)
🔇 Additional comments (8)
schema-registry/schema-registry.json (8)
5-8: Version and host bump look goodSpec version bumped to 1.1.0 and host updated to localhost:8081. No concerns.
44-45: Consistent capitalization in error descriptions“Internal Server Error” capitalization and “Not Found: …” messages are now consistent across endpoints. Good cleanup.
Also applies to: 87-88, 124-125, 150-151, 187-188, 213-214, 256-257, 303-304, 359-360, 397-398, 426-427, 480-487, 536-537, 584-585
686-687: Ref updated to stored_schemaThe response schema now references stored_schema. Rename is applied correctly here.
921-923: Ref update to stored_schema on GET subject versionThe entity rename is correctly reflected in this response too.
1009-1012: Improved summary/description for raw schemaThe wording clarifies output format without escaping. Reads better and matches behavior.
1521-1557: stored_schema definition is well-structuredFields align with responses and existing schema_def shape. Looks good.
1600-1662: security_acl definition is comprehensive and consistent with query enumsThe required list and enums reflect the API surface accurately.
1-1664: Validation Checks Passed: JSON parses, no stray subject_schema refs, and all format endpoints include 501 responsesAll automated verifications succeeded:
- schema-registry.json is valid JSON.
- No leftover
#/definitions/subject_schemareferences.- Every operation that defines a
formatquery parameter declares a 501 response.No further changes required.
This PR ensures that this repo has the latest version of the API spec files from https://github.com/redpanda-data/docs/tree/api/modules/ROOT/attachments (Cloud APIs are handled by GH automation).