updated documentation#5
Merged
Merged
Conversation
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.
This pull request updates and clarifies the Fabric server documentation to reflect recent implementation changes, improve accuracy, and provide more precise descriptions of key components, interfaces, and behaviors. The changes cover API documentation, parser and validation plugin design, plan status handling, and struct definitions.
API and Behavior Documentation Updates:
docs/api.md: Expanded the description of theFabricnode and updated service documentation to clarify request/response fields and behaviors for/fabric/set_plan,/fabric/set_completion, and/fabric/get_plan_status. Added/fabric/get_plan_statusto the service table and improved descriptions of plan submission and status querying.docs/status.md: Improved the explanation of the plan status lifecycle, clarified the meaning and handling of theCANCELLEDstate, and detailed the request/response structure for/fabric/get_plan_status. Updated how rejected items are reported and how status codes are mapped. [1] [2] [3]Parser and Validation Plugin Documentation:
docs/parser_plugins.md: Refined the motivation for parser plugins, updated the interface to match the current implementation (including new methods likeload_fileandcheck_compatibility), and clarified how control flow and parallelism are handled in the defaultXMLParserPlugin. Adjusted the description of how runner parameters are extracted and converted. [1] [2] [3] [4] [5]docs/validation_plugins.md: Updated the explanation of runtime plugin selection, clarified the validation logic to match current behavior (e.g., immediate exception on unmatched interface/provider), and described how validation failures are handled by the server. [1] [2] [3]Structs and Client Documentation:
docs/structs.md: Updated struct field definitions to match the latest code (e.g., neweventenum,instance_id,plan_id,statusfields), clarified parameter and method descriptions, and fixed file path references. [1] [2] [3] [4] [5]docs/capability_client.md,docs/bond_client.md: Clarified initialization, parameter usage, and runtime behavior for theCapabilityClientandBondClientclasses, including service waiting and bond management details. [1] [2] [3]Testing and TODOs:
TODO.md: Added a note to implement integration tests for/fabric/cancel_planand/fabric/get_plan_status.These changes ensure the documentation is consistent with the current Fabric implementation and provide clearer guidance for developers and users.