Extract pipeline for documentation set #3485
Merged
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
With this change, I have extracted the parsing of each API set into a sub-pipeline. This means that we can now parse multiple sets of API Documentation instead of just the first. However, it doesn't work quite yet. As the files are still added onto the ProjectDescriptor. This change merely changes the process, but shouldn't affect the application as long as the guard that only 1 API Set may be present is in place. In a subsequent change, we will be modifying the parsing logic itself to work more with the Documentation Set descriptors instead of the ProjectDescriptor
|
I still need to update tests and what comes out of static analysis |
…r-documentation-set
While reviewing, I noticed that a) I had added a method to the ApiSetDescriptor that I really do not need anymore, and b) the Parser Payload is no longer really used. I have now replaced the Parser Payload with its parent (the normal Payload) and found that the stage to transform the regular Payload to the Parser payload was unnecessary; so I cut it out to simplify the process.
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.
With this change, I have extracted the parsing of each API set into a
sub-pipeline. This means that we can now parse multiple sets of API
Documentation instead of just the first.
However, it doesn't work quite yet. As the files are still added onto
the ProjectDescriptor. This change merely changes the process, but
shouldn't affect the application as long as the guard that only 1 API
Set may be present is in place.
In a subsequent change, we will be modifying the parsing logic itself to
work more with the Documentation Set descriptors instead of the
ProjectDescriptor.
With this, I updated the pipeline documentation to reflect the new
situation and I was able to drop the Parser Payload as it had been
replaced by the ApiSetPayload. I also found that Guides type-hinted
the parser payload but didn't really use it, so I have simplified that
part of the code and subsequently was able to remove the Parser
Payload, including the pipeline stage that maps it, entirely.