Generic implementation for include and fileds API params #3423
Conversation
This file contains 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
- Includes and fields are very similar. In fact fields is a special case of include as we are only returning certain fields of the included resource - When parsing include and fields params we are combining them to a single set of include resource rules - There is a central include rule resolver component that fetches all the included resources and selects a subset of their fields if needed - Relationships are handled by a new relationships repository that looks into the resources relationships in order to fetch their related resources by guid. This repository delegates all heavy lifting to the existing repositories - In order to be able to work with collections of resources a new Resource interface is introduced that for now can merely fetch a resource's relationships. This interface needs to be implemented by all repository records for which we want to be able to resolve dependencies - Currently this is possible only for service_offering and service_broker type resources, but it is going to be easy to add new resouce types
danail-branekov
approved these changes
Aug 14, 2024
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.
Is there a related GitHub Issue?
No
What is this change about?
Generic implementation for include and fileds API params
of include as we are only returning certain fields of the included
resource
single set of include resource rules
the included resources and selects a subset of their fields if needed
into the resources relationships in order to fetch their related
resources by guid. This repository delegates all heavy lifting to the
existing repositories
Resource interface is introduced that for now can merely fetch a
resource's relationships. This interface needs to be implemented by
all repository records for which we want to be able to resolve
dependencies
service_broker type resources, but it is going to be easy to add new
resouce types
Does this PR introduce a breaking change?
No
Tag your pair, your PM, and/or team
@danail-branekov