docs: Add deprecated docstrings to all legacy FGA methods#1546
Conversation
Greptile SummaryThis PR adds method-level
Confidence Score: 5/5Safe to merge — this is a documentation-only change with no logic modifications. All 12 FGA methods are correctly annotated with @deprecated and no methods were missed. The sole observation is a P2 style suggestion about the @see reference being potentially insufficient for the 6 methods with no Authorization equivalent. P2 findings do not block merge. No files require special attention. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Developer calls FGA method] --> B{Direct equivalent in\nAuthorization module?}
B -- Yes --> C["check / createResource / getResource\nlistResources / updateResource / deleteResource"]
B -- No --> D["checkBatch / writeWarrant / batchWriteWarrants\nlistWarrants / query / batchWriteResources"]
C --> E[Migrate to Authorization module\nsrc/authorization/authorization.ts]
D --> F[No direct equivalent —\nmigration guide needed]
Reviews (1): Last reviewed commit: "Add deprecated docstrings to all legacy ..." | Re-trigger Greptile |
| * @deprecated The FGA module is deprecated. Use the Authorization module instead. | ||
| * @see src/authorization/authorization.ts | ||
| */ |
There was a problem hiding this comment.
@see reference may be insufficient for some FGA methods
The @see src/authorization/authorization.ts annotation is applied uniformly to all 12 methods, but 6 of them — checkBatch, writeWarrant, batchWriteWarrants, listWarrants, query, and batchWriteResources — have no direct equivalent in the Authorization module. Developers trying to migrate those calls will find no corresponding method to switch to.
Consider supplementing the @see tag with a link to an external migration guide or changelog entry that covers every FGA method, not only those that map cleanly into Authorization.
No description provided.