Skip to content

[codex] Remove 1.9 atomic create params from 1.8 specs#44

Merged
ChiragAgg5k merged 1 commit intomainfrom
codex/remove-1-9-atomic-create-params-from-1-8-specs
Mar 31, 2026
Merged

[codex] Remove 1.9 atomic create params from 1.8 specs#44
ChiragAgg5k merged 1 commit intomainfrom
codex/remove-1-9-atomic-create-params-from-1-8-specs

Conversation

@ChiragAgg5k
Copy link
Copy Markdown
Member

@ChiragAgg5k ChiragAgg5k commented Mar 31, 2026

Summary

Removes 1.9-only atomic schema creation parameters from the 1.8.x create API surface.

What changed

  • Removed attributes and indexes from 1.8.x databases.createCollection in the server and console Swagger/OpenAPI specs.
  • Removed columns and indexes from 1.8.x tablesDB.createTable in the server and console Swagger/OpenAPI specs.
  • Updated the affected 1.8.x create-collection and create-table examples across SDK/platform directories so they no longer pass those params inline.

Why

These inline schema/index creation params are a 1.9.x feature and should not appear in 1.8.x specs or examples.

Impact

  • 1.8.x generated SDK/docs will no longer advertise unsupported create-time schema params.
  • 1.8.x examples now match the intended version behavior.
  • Standalone create-column/create-attribute/create-index flows are unchanged.

Validation

  • git diff --check
  • targeted rg verification that 1.8.x databases/create-collection.md examples no longer include inline attributes/indexes
  • targeted rg verification that 1.8.x tablesdb/create-table.md examples no longer include inline columns/indexes
  • spot-checks of the four 1.8.x spec files to confirm the create request bodies now stop at enabled

Summary by CodeRabbit

  • Documentation

    • Simplified collection and table creation examples across all SDK documentation by removing empty optional parameters for attributes/columns and indexes.
  • API Specification

    • Updated OpenAPI and Swagger specifications to remove optional attributes and indexes properties from collection creation schemas and columns and indexes from table creation schemas.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 31, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 1c982b0b-d70a-403f-87c6-006208c381e4

📥 Commits

Reviewing files that changed from the base of the PR and between bd8ee02 and cd62f52.

📒 Files selected for processing (30)
  • examples/1.8.x/console-web/examples/databases/create-collection.md
  • examples/1.8.x/console-web/examples/tablesdb/create-table.md
  • examples/1.8.x/server-dart/examples/databases/create-collection.md
  • examples/1.8.x/server-dart/examples/tablesdb/create-table.md
  • examples/1.8.x/server-dotnet/examples/databases/create-collection.md
  • examples/1.8.x/server-dotnet/examples/tablesdb/create-table.md
  • examples/1.8.x/server-go/examples/databases/create-collection.md
  • examples/1.8.x/server-go/examples/tablesdb/create-table.md
  • examples/1.8.x/server-graphql/examples/databases/create-collection.md
  • examples/1.8.x/server-graphql/examples/tablesdb/create-table.md
  • examples/1.8.x/server-kotlin/java/databases/create-collection.md
  • examples/1.8.x/server-kotlin/java/tablesdb/create-table.md
  • examples/1.8.x/server-kotlin/kotlin/databases/create-collection.md
  • examples/1.8.x/server-kotlin/kotlin/tablesdb/create-table.md
  • examples/1.8.x/server-nodejs/examples/databases/create-collection.md
  • examples/1.8.x/server-nodejs/examples/tablesdb/create-table.md
  • examples/1.8.x/server-php/examples/databases/create-collection.md
  • examples/1.8.x/server-php/examples/tablesdb/create-table.md
  • examples/1.8.x/server-python/examples/databases/create-collection.md
  • examples/1.8.x/server-python/examples/tablesdb/create-table.md
  • examples/1.8.x/server-rest/examples/databases/create-collection.md
  • examples/1.8.x/server-rest/examples/tablesdb/create-table.md
  • examples/1.8.x/server-ruby/examples/databases/create-collection.md
  • examples/1.8.x/server-ruby/examples/tablesdb/create-table.md
  • examples/1.8.x/server-swift/examples/databases/create-collection.md
  • examples/1.8.x/server-swift/examples/tablesdb/create-table.md
  • specs/1.8.x/open-api3-1.8.x-console.json
  • specs/1.8.x/open-api3-1.8.x-server.json
  • specs/1.8.x/swagger2-1.8.x-console.json
  • specs/1.8.x/swagger2-1.8.x-server.json
💤 Files with no reviewable changes (9)
  • examples/1.8.x/server-dart/examples/databases/create-collection.md
  • examples/1.8.x/server-go/examples/tablesdb/create-table.md
  • examples/1.8.x/server-kotlin/java/tablesdb/create-table.md
  • examples/1.8.x/server-go/examples/databases/create-collection.md
  • specs/1.8.x/swagger2-1.8.x-console.json
  • examples/1.8.x/server-dart/examples/tablesdb/create-table.md
  • examples/1.8.x/server-kotlin/java/databases/create-collection.md
  • specs/1.8.x/swagger2-1.8.x-server.json
  • specs/1.8.x/open-api3-1.8.x-server.json

Walkthrough

This pull request systematically removes optional attributes and indexes parameters from database collection creation examples across all supported SDK language variants (Dart, Go, Kotlin, Node.js, PHP, Python, Ruby, Swift, GraphQL, and REST). Similarly, columns and indexes parameters are removed from table creation examples. Additionally, the OpenAPI/Swagger specification files are updated to reflect these schema property removals from the corresponding request definitions in both server and console API specs.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: removing 1.9-only atomic parameters from 1.8 API specifications and examples.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/remove-1-9-atomic-create-params-from-1-8-specs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@ChiragAgg5k ChiragAgg5k marked this pull request as ready for review March 31, 2026 16:03
@greptile-apps
Copy link
Copy Markdown

greptile-apps bot commented Mar 31, 2026

Greptile Summary

This PR surgically removes 1.9.x-only atomic creation parameters (attributes, indexes, columns) from all four 1.8.x OpenAPI/Swagger spec files and their corresponding SDK/platform examples, ensuring the 1.8.x API surface correctly reflects only the parameters supported in that version.

  • Removed attributes and indexes from the databases.createCollection request body in all four 1.8.x spec files (open-api3-server, open-api3-console, swagger2-server, swagger2-console)
  • Removed columns and indexes from the tablesDB.createTable request body in the same four spec files
  • Updated 26 example .md files across 13 SDK/platform directories to no longer pass those params inline
  • JSON structure in all four spec files is valid after the changes — no trailing comma or missing brace issues
  • Coverage is complete: server-deno already lacked these params before this PR; console-cli and client-side examples never included them; the GraphQL response selection sets (which legitimately reference attributes/indexes as return fields) are correctly untouched

Confidence Score: 5/5

This PR is safe to merge — it is a targeted, correct removal of unsupported parameters from versioned specs and examples with no logic changes.

All changes are pure deletions of 1.9.x-only fields from 1.8.x specs and examples. JSON validity is confirmed, syntax in all SDK examples is correct after the removals, coverage across platforms is complete, and no 1.9.x specs were inadvertently touched. No P0 or P1 findings.

No files require special attention.

Important Files Changed

Filename Overview
specs/1.8.x/open-api3-1.8.x-server.json Removed attributes/indexes from databases.createCollection and columns/indexes from tablesDB.createTable request body schemas. JSON structure is valid after the change.
specs/1.8.x/open-api3-1.8.x-console.json Same removals as the server OpenAPI3 spec, plus a fix adding a trailing newline at end of file. JSON structure is valid.
specs/1.8.x/swagger2-1.8.x-server.json Removed attributes/indexes and columns/indexes from Swagger 2 server spec request body schemas. JSON structure is valid.
specs/1.8.x/swagger2-1.8.x-console.json Removed attributes/indexes and columns/indexes from Swagger 2 console spec request body schemas. JSON structure is valid.
examples/1.8.x/server-nodejs/examples/databases/create-collection.md Removed attributes and indexes inline params from the Node.js create-collection example; enabled is now the last optional parameter.
examples/1.8.x/server-dotnet/examples/databases/create-collection.md Removed attributes/indexes params from .NET example; trailing comma correctly removed from the now-last enabled parameter.
examples/1.8.x/server-graphql/examples/databases/create-collection.md Removed attributes/indexes from mutation input; attributes and indexes remain correctly in the GraphQL response selection set where they belong as response fields.
examples/1.8.x/server-kotlin/kotlin/databases/create-collection.md Removed attributes/indexes from Kotlin create-collection example; no trailing comma issue since Kotlin named parameters don't require one on the last arg.

Reviews (1): Last reviewed commit: "Remove 1.9 atomic create params from 1.8..." | Re-trigger Greptile

@ChiragAgg5k ChiragAgg5k merged commit 12d57e9 into main Mar 31, 2026
3 checks passed
@ChiragAgg5k ChiragAgg5k deleted the codex/remove-1-9-atomic-create-params-from-1-8-specs branch March 31, 2026 16:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant