[PR #265] Add Resource Group specs draft#2096
Closed
orivaris wants to merge 9 commits into
Closed
Conversation
- Removed references to the old symlink in the proposal and task list. - Updated documentation to reflect the new structure and requirements for the Resource Group module. Signed-off-by: Roland From <rfedorov@linkentools.com>
- Corrected relative paths in the Resource Group module documentation to ensure accurate linking. - Clarified the impact section of the proposal to reflect the introduction of the new `resource-group` spec and updated database requirements. Signed-off-by: Roland From <rfedorov@linkentools.com>
…tails - Updated the requirement section to clarify that the References Plugin is optional and provides an API for linking resource groups to external resources. - Added scenarios for both connected and not connected states of the References Plugin, detailing the behavior of the system in each case. - Specified REST API endpoints related to resource group references, conditional on the References Plugin being enabled. Signed-off-by: Roland From <rfedorov@linkentools.com>
…traints - Added detailed specifications for hierarchy query operations, including configurable constraints for `max_depth` and `max_width`. - Defined behavior for read and write operations in relation to these constraints, including scenarios for default and custom configurations. - Specified requirements for data migration when constraints are reduced, ensuring existing data compliance without truncation. Signed-off-by: Roland From <rfedorov@linkentools.com>
…up Module - Introduced a new document for Architecture Decision Records (ADR) detailing the decision to use the Closure Table pattern for hierarchical storage in the Resource Group module. - Added a comprehensive feature design document outlining the context, actor flows, algorithms, and requirements for managing resource groups, including type management and entity operations. - Specified API endpoints and security considerations related to the Resource Group module. Signed-off-by: Roland From <rfedorov@linkentools.com>
- Updated the documentation to clarify that the References functionality is integral rather than optional, removing references to a separate plugin. - Streamlined the requirements and scenarios for managing resource group references, ensuring clarity on the system's behavior regarding linking and deleting references. - Adjusted API endpoint specifications to reflect the removal of the plugin condition, enhancing the overall coherence of the resource group management documentation. Signed-off-by: Roland From <rfedorov@linkentools.com>
- Introduced new documents detailing the business context and overall design for the Resource Group module, outlining its purpose, target users, and key problems it addresses. - Specified architectural vision, requirements, and principles guiding the design, emphasizing efficient hierarchy management and read performance. - Added feature design documentation, including actor flows, algorithms, and testing scenarios for resource group management. Signed-off-by: Roland From <rfedorov@linkentools.com>
…ation - Updated the documentation to clarify the ownership model for resource group types, replacing application-based ownership with owner-based ownership. - Adjusted feature descriptions and specifications to reflect the new owner information requirements, including changes to type management and access control. - Enhanced security and error handling sections to align with the updated ownership model, ensuring consistency across the documentation. Signed-off-by: Roland From <rfedorov@linkentools.com>
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
2 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.
Summary by CodeRabbit
New Features
Documentation
✏️ Tip: You can customize this high-level summary in your review settings.