Repository navigation
feat: annotate every API method with its required scope - #738
Merged
Merged
Conversation
Every method whose JSDoc links an API operation now carries a `@requiredScope` block tag: `<scope>:read`, `<scope>:write`, or `none` for endpoints any token may call. Values come from the public API spec for both Crowdin and Crowdin Enterprise; for the project webhooks and Clear TM operations the Enterprise docs omit the line, so the Crowdin value is used (the API enforces the same scope in both editions). The tag is visible in IDE hover and on the typedoc site (declared in tsdoc.json) and readable by tooling through the TypeScript compiler API from the published .d.ts files. A test guards that every operation-linked method keeps exactly one well-formed tag. Also corrects the @see link of deleteReportSettingsTemplate, which pointed at a non-existent operation. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #738 +/- ##
=======================================
Coverage 88.92% 88.92%
=======================================
Files 47 47
Lines 2563 2563
Branches 350 350
=======================================
Hits 2279 2279
Misses 85 85
Partials 199 199 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
andrii-bodnar
approved these changes
Oct 22, 2026
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
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.
Every method whose JSDoc links an API operation now carries a
@requiredScopeblock tag:<scope>:read,<scope>:write, ornonefor endpoints any token may call. Values come from the public API spec for both Crowdin and Crowdin Enterprise; for the project webhooks and Clear TM operations the Enterprise docs omit the line, so the Crowdin value is used (the API enforces the same scope in both editions).The tag is visible in IDE hover and on the typedoc site (declared in tsdoc.json) and readable by tooling through the TypeScript compiler API from the published .d.ts files. A test guards that every operation-linked method keeps exactly one well-formed tag.
Also corrects the @see link of deleteReportSettingsTemplate, which pointed at a non-existent operation.