docs: add API reference with full type and method documentation#30
Merged
AWaterColorPen merged 1 commit intomainfrom Apr 22, 2026
Merged
docs: add API reference with full type and method documentation#30AWaterColorPen merged 1 commit intomainfrom
AWaterColorPen merged 1 commit intomainfrom
Conversation
Phase 2 task: API documentation covering: - All core types (User, Domain, Role, Object, ObjectData, Policy, UserRolePair, Directory, DirectoryRequest, DirectoryResponse) - All four service interfaces (IBaseService, IFeatureService, IDirectoryService, ICurrentService) with parameters, return values, and usage notes for each method - Constructor (New) and Options fields - Utility functions (Check, Filter, ID, IDMap) - Error reference table - Update README docs table to link to api-reference.md
Open
5 tasks
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
1 participant
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.
Summary
Phase 2 second task: API Reference — comprehensive documentation for every public type and method.
Changes
docs/api-reference.md— 700+ line API reference covering:User,Domain,Role,Object,ObjectData,Policy,UserRolePair,Directory,DirectoryRequest,DirectoryResponseRead,Write,Manageactions;ObjectTypeRole;DirectorySearchAll/TopIBaseService,IFeatureService,IDirectoryService,ICurrentService) with parameters, return values, permission requirements, and usage notes for each methodNewandOptionsfields with defaultsCheck,Filter,ID,IDMapwith examplesREADME.md— docs table now links toapi-reference.mdinstead of the emptyapi.mdPart of
Phase 2 documentation buildout (2026-03-10 modernization plan).