Skip to content

Conversation

@Zaimwa9
Copy link
Contributor

@Zaimwa9 Zaimwa9 commented Jan 28, 2026

Thanks for submitting a PR! Please check the boxes below:

  • I have read the Contributing Guide.
  • I have added information to docs/ if required so people know about the feature.
  • I have filled in the "Changes" section below.
  • I have filled in the "How did you test this code" section below.

Changes

Claude analysis before / after

Full Schema Comparison Summary

  File Size
  ┌────────────────────────────────────────────┬───────────┐
  │                   Schema                   │   Lines   │
  ├────────────────────────────────────────────┼───────────┤
  │ Old (without setting)                      │ 24,077    │
  ├────────────────────────────────────────────┼───────────┤
  │ New (with COMPONENT_NO_READ_ONLY_REQUIRED) │ 23,599    │
  ├────────────────────────────────────────────┼───────────┤
  │ Removed                                    │ 478 lines │
  └────────────────────────────────────────────┴───────────┘
  Most Frequently Removed Fields from required Arrays
  ┌─────────────────────┬─────────────────────┐
  │        Field        │ Occurrences Removed │
  ├─────────────────────┼─────────────────────┤
  │ id                  │ 114                 │
  ├─────────────────────┼─────────────────────┤
  │ uuid                │ 32                  │
  ├─────────────────────┼─────────────────────┤
  │ created_at          │ 25                  │
  ├─────────────────────┼─────────────────────┤
  │ updated_at          │ 20                  │
  ├─────────────────────┼─────────────────────┤
  │ deleted_at          │ 13                  │
  ├─────────────────────┼─────────────────────┤
  │ environment         │ 11                  │
  ├─────────────────────┼─────────────────────┤
  │ project             │ 9                   │
  ├─────────────────────┼─────────────────────┤
  │ created_date        │ 8                   │
  ├─────────────────────┼─────────────────────┤
  │ committed_by        │ 7                   │
  ├─────────────────────┼─────────────────────┤
  │ committed_at        │ 7                   │
  ├─────────────────────┼─────────────────────┤
  │ user                │ 6                   │
  ├─────────────────────┼─────────────────────┤
  │ feature_state_value │ 6                   │
  ├─────────────────────┼─────────────────────┤
  │ created_by          │ 5                   │
  ├─────────────────────┼─────────────────────┤
  │ owners              │ 4                   │
  ├─────────────────────┼─────────────────────┤
  │ group_owners        │ 4                   │
  ├─────────────────────┼─────────────────────┤
  │ feature             │ 4                   │
  ├─────────────────────┼─────────────────────┤
  │ live_from           │ 4                   │
  └─────────────────────┴─────────────────────┘
  Impact

  The setting removes readOnly fields from all required arrays across the entire API schema (not just MCP endpoints). This is the
  correct behaviour since:
  - These fields are server-generated
  - Clients should not (and cannot) provide them in requests
  - Having them as "required" breaks client code generation

How did you test this code?

Please describe.

@Zaimwa9 Zaimwa9 requested a review from a team as a code owner January 28, 2026 16:20
@Zaimwa9 Zaimwa9 requested review from emyller and removed request for a team January 28, 2026 16:20
@vercel
Copy link

vercel bot commented Jan 28, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

3 Skipped Deployments
Project Deployment Review Updated (UTC)
docs Ignored Ignored Preview Jan 28, 2026 4:51pm
flagsmith-frontend-preview Ignored Ignored Preview Jan 28, 2026 4:51pm
flagsmith-frontend-staging Ignored Ignored Preview Jan 28, 2026 4:51pm

Request Review

@github-actions github-actions bot added the api Issue related to the REST API label Jan 28, 2026
@Zaimwa9 Zaimwa9 requested review from khvn26 and removed request for emyller January 28, 2026 16:21
@github-actions github-actions bot added the docs Documentation updates label Jan 28, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Jan 28, 2026

Docker builds report

Image Build Status Security report
ghcr.io/flagsmith/flagsmith-e2e:pr-6608 Finished ✅ Skipped
ghcr.io/flagsmith/flagsmith-api-test:pr-6608 Finished ✅ Skipped
ghcr.io/flagsmith/flagsmith-frontend:pr-6608 Finished ✅ Results
ghcr.io/flagsmith/flagsmith-api:pr-6608 Finished ✅ Results
ghcr.io/flagsmith/flagsmith:pr-6608 Finished ✅ Results
ghcr.io/flagsmith/flagsmith-private-cloud:pr-6608 Finished ✅ Results

@codecov
Copy link

codecov bot commented Jan 28, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.18%. Comparing base (3e6345b) to head (f5bd18d).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #6608   +/-   ##
=======================================
  Coverage   98.18%   98.18%           
=======================================
  Files        1295     1295           
  Lines       46920    46920           
=======================================
  Hits        46067    46067           
  Misses        853      853           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-actions github-actions bot added docs Documentation updates and removed docs Documentation updates labels Jan 28, 2026
@khvn26 khvn26 changed the title docs: use-no-readonl-required-setting feat(api-docs): Avoid readOnly properties with required Jan 28, 2026
@khvn26 khvn26 changed the title feat(api-docs): Avoid readOnly properties with required fix(api-docs): Avoid readOnly properties with required Jan 28, 2026
@github-actions github-actions bot removed the docs Documentation updates label Jan 28, 2026
@github-actions github-actions bot added the fix label Jan 28, 2026
@khvn26 khvn26 merged commit 31ee000 into main Jan 28, 2026
30 checks passed
@khvn26 khvn26 deleted the docs/use-COMPONENT_NO_READ_ONLY_REQUIRED-setting branch January 28, 2026 16:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api Issue related to the REST API fix

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants