Skip to content

Fix issues in generated specs#11654

Merged
ChiragAgg5k merged 1 commit into1.9.xfrom
fix-specs
Mar 27, 2026
Merged

Fix issues in generated specs#11654
ChiragAgg5k merged 1 commit into1.9.xfrom
fix-specs

Conversation

@adityaoberai
Copy link
Copy Markdown
Contributor

@adityaoberai adityaoberai commented Mar 26, 2026

What does this PR do?

  • Fixes examples in MFAType model

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. Screenshots may also be helpful.)

Related PRs and Issues

Checklist

  • Have you read the Contributing Guidelines on issues?
  • If the PR includes a change to an API's metadata (desc, label, params, etc.), does it also include updated API specs and example docs?

@adityaoberai adityaoberai changed the title Fx issues with models Fx issues in generated specs Mar 26, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 26, 2026 •
edited
Loading

📝 Walkthrough

Walkthrough

The change updates the MFAType model's validation rule metadata by replacing boolean true example values with concrete example strings for the secret and uri fields. This modification affects only the example data provided in the model's rule definitions without altering field types, defaults, or validation logic.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 1 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
Title check ❓ Inconclusive The title 'Fix issues in generated specs' is vague and overly broad. While the PR does address issues in specs, the title lacks specificity about what was actually fixed (updating MFAType example values from booleans to strings). The generic phrasing does not clearly convey the primary change to a teammate scanning history. Consider a more specific title like 'Update MFAType example values in specs' or 'Fix MFAType secret and uri example values' to better describe the actual change.
✅ Passed checks (1 passed)
Check name Status Explanation
Description check ✅ Passed The description is related to the changeset and explicitly mentions fixing examples in the MFAType model, which matches the actual changes made in the pull request.

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

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix-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.

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps bot commented Mar 26, 2026

Greptile Summary

This PR corrects two invalid example values in MFAType.php. Both the secret and uri fields are declared as TYPE_STRING, but their examples were set to the boolean true — this PR replaces them with proper string examples.\n\n- secret field: example updated from true to a descriptive placeholder string\n- uri field: example updated from true to a well-formed otpauth:// URI following the standard authenticator key URI format\n- The change improves SDK documentation generation and API response examples.

Confidence Score: 5/5

Safe to merge — the change is a straightforward fix of incorrect example types with no logic impact.

The diff is minimal and correct: two boolean true values are replaced with proper string examples for string-typed fields. The TOTP URI format is valid. No logic, API contract, or runtime behavior is changed.

No files require special attention.

Important Files Changed

Filename Overview
src/Appwrite/Utopia/Response/Model/MFAType.php Fixes incorrect boolean true example values for secret and uri fields (both typed as TYPE_STRING) to proper string examples; uri example follows the standard TOTP otpauth:// URI format.

Reviews (1): Last reviewed commit: "Fix examples in MFAType model" | Re-trigger Greptile

@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 26, 2026 •
edited
Loading

🔄 PHP-Retry Summary

Flaky tests detected across commits:

Commit babb019 - 2 flaky tests
Test Retries Total Time Details
UsageTest::testVectorsDBStats 1 10.11s Logs
WebhooksCustomServerTest::testUpdateDeployment 1 5.39s Logs

@adityaoberai adityaoberai changed the title Fx issues in generated specs Fix issues in generated specs Mar 26, 2026
@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 26, 2026

✨ Benchmark results

  • Requests per second: 1,661
  • Requests with 200 status code: 299,019
  • P99 latency: 0.107126406

⚡ Benchmark Comparison

Metric This PR Latest version
RPS 1,661 1,216
200 299,019 218,942
P99 0.107126406 0.187006504

@ChiragAgg5k ChiragAgg5k merged commit f2c8500 into 1.9.x Mar 27, 2026
78 of 80 checks passed
@ChiragAgg5k ChiragAgg5k deleted the fix-specs branch March 27, 2026 07:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ChiragAgg5k ChiragAgg5k ChiragAgg5k approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@adityaoberai @ChiragAgg5k