Skip to content

Rename "column" to "attribute" to fix RES API compatibility#2770

Open
TechnoDD wants to merge 1 commit intoappwrite:mainfrom
TechnoDD:patch-1
Open

Rename "column" to "attribute" to fix RES API compatibility#2770
TechnoDD wants to merge 1 commit intoappwrite:mainfrom
TechnoDD:patch-1

Conversation

@TechnoDD
Copy link

@TechnoDD TechnoDD commented Feb 25, 2026

What does this PR do?

(Provide a description of what this PR does.)

Test Plan

(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work.)

Related PRs and Issues

(If this PR is related to any other PR or resolves any issue or related to any issue link all related PR and issues here.)

Have you read the Contributing Guidelines on issues?

(Write your answer here.)

Summary by CodeRabbit

  • Documentation
    • Updated REST API documentation examples to use "attribute" field name in query JSON snippets across various query types and use cases.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 25, 2026

Walkthrough

The pull request updates the REST API documentation file to standardize field naming in query JSON examples. The change replaces the field name column with attribute across multiple code snippets, including examples for unescaped query strings, null checks, range queries, and nested query structures. These modifications affect documentation display only, with no changes to functional code or logic.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 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 clearly and concisely describes the main change: renaming 'column' to 'attribute' for REST API compatibility, which aligns with the documentation updates in the changeset.
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
  • Post copyable unit tests in a comment

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
src/routes/docs/apis/rest/+page.markdoc (1)

282-357: ⚠️ Potential issue | 🟠 Major

Unify query key naming across this section (column vs attribute)

This change is only partial: the same page still uses column at Line 274 and in text at Line 344, while changed examples now use attribute. Please make this section internally consistent with one canonical key; otherwise readers will get conflicting request formats.

Based on learnings, documentation terms in .markdoc files should be applied consistently across content and code samples.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@src/routes/docs/apis/rest/`+page.markdoc around lines 282 - 357, The docs mix
two JSON key names ("column" and "attribute") which creates inconsistent
examples; standardize on "attribute" across this section by replacing all
occurrences of the "column" key and any prose references to "column" with
"attribute" (update the JSON examples that currently show "column" and the
explanatory text that mentions "column" so they match the existing examples
using "attribute", e.g., the nested-query sample and the earlier example at Line
274/344).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Outside diff comments:
In `@src/routes/docs/apis/rest/`+page.markdoc:
- Around line 282-357: The docs mix two JSON key names ("column" and
"attribute") which creates inconsistent examples; standardize on "attribute"
across this section by replacing all occurrences of the "column" key and any
prose references to "column" with "attribute" (update the JSON examples that
currently show "column" and the explanatory text that mentions "column" so they
match the existing examples using "attribute", e.g., the nested-query sample and
the earlier example at Line 274/344).

ℹ️ Review info

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3d9103f and 37d2f24.

📒 Files selected for processing (1)
  • src/routes/docs/apis/rest/+page.markdoc

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