docs(product): sync organization feature name to dir_sync (SDK ref + OpenAPI) - #938
Merged
Merged
Conversation
…ample The updateOrganizationSettings examples used directory_sync, which the API does not recognize. The backend feature identifier is dir_sync (db/environment_setting.go: FeatureDirectorySync = "dir_sync"). Aligns the Node SDK reference with the corrected proto/OpenAPI contract from scalekit#2489.
Contributor
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (7)
WalkthroughThe organization feature identifier changes from ChangesOrganization feature identifier
Estimated code review effort: 1 (Trivial) | ~5 minutes Suggested reviewers: ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
The organization settings schema examples and the OrganizationSettingsFeature name description in the landed OpenAPI spec still taught directory_sync, which the API does not recognize. The backend feature identifier is dir_sync (db/environment_setting.go: FeatureDirectorySync = "dir_sync"). Syncs the docs OpenAPI root and its generated public/api/*.scalar.* outputs with the corrected proto/OpenAPI contract from scalekit#2489.
saif-at-scalekit
changed the title
✅ Deploy Preview for scalekit-starlight ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for scalekit-starlight ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
AkshayParihar33
approved these changes
Aug 14, 2026
saif-at-scalekit
marked this pull request as ready for review
August 14, 2026 10:19
saif-at-scalekit
requested review from
amitash1912 and
ravibits
as code owners
August 14, 2026 10:19
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why: Shipped change in
scalekit-inc/scalekit@b194c6bb(PR #2489, merged tomain) corrected the organization feature identifier fromdirectory_synctodir_syncin the proto/OpenAPI contract. developer-docs still taughtdirectory_sync— a value the API does not recognize (a copy-paste sets an unrecognized/no-op feature) — across both the Node SDK reference and the landed OpenAPI spec.What: Surgical
directory_sync→dir_syncsync, no other changes:updateOrganizationSettings):src/content/docs/saaskit/sdks/node/organizations.mdx,src/components/sdk-reference/saaskit/node/Organizations.mdxopenapi/scalekit.yaml: org-settings schema examples + theOrganizationSettingsFeature.namedescription enum (4 occurrences)public/api/scalekit.scalar.{json,yaml},public/api/saaskit.scalar.{json,yaml}Skills: docs-engineering, scalekit-code-doctor, api-reference, docs-writing-style.
Evidence: Backend source of truth
db/environment_setting.go—FeatureDirectorySync = "dir_sync"(@c368c6f0). Contract correction:scalekit#2489 proto diff (proto/scalekit/v1/organizations/organizations.proto) and its generated OpenAPI (third_party/OpenAPI/scalekit.scalar.*). OpenAPI/proto compared: yes. Verified there is no legitimateorganization.directory_syncevent-name usage in these spec files, so the token swap is safe; repo-wide search now returns zerodirectory_sync.Check:
grep -rn directory_sync openapi/ public/api/ src/returns no matches; bothpublic/api/*.scalar.jsonre-parse as valid JSON. Preview:https://deploy-preview-{PR_NUMBER}--scalekit-starlight.netlify.app/saaskit/sdks/node/organizations/. verification: values verified against BE constant + proto/OpenAPI diff at SHA. Generatedpublic/api/*.scalar.*were synced by the identical deterministic token replacement rather than a full rebuild — a maintainer should re-runpnpm run bundle:apis && pnpm run validate-api-splitto confirm no other spec drift (redocly is not installed in this environment). verification: needs-human for the bundle re-run.Summary by CodeRabbit
dir_syncidentifier.