Rename "column" to "attribute" to fix RES API compatibility#2770
Rename "column" to "attribute" to fix RES API compatibility#2770TechnoDD wants to merge 1 commit intoappwrite:mainfrom
Conversation
WalkthroughThe pull request updates the REST API documentation file to standardize field naming in query JSON examples. The change replaces the field name Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
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 | 🟠 MajorUnify query key naming across this section (
columnvsattribute)This change is only partial: the same page still uses
columnat Line 274 and in text at Line 344, while changed examples now useattribute. Please make this section internally consistent with one canonical key; otherwise readers will get conflicting request formats.Based on learnings, documentation terms in
.markdocfiles 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).
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