Correcting the response format for ingest simulate #3640
+267
−5
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
|
Following you can find the validation results for the API you have changed.
You can validate this API yourself by using the |
|
Following you can find the validation results for the API you have changed.
You can validate this API yourself by using the |
l-trotta
reviewed
Jan 31, 2025
|
|
||
| export class Response { | ||
| body: { docs: SimulateDocumentResult[] } | ||
| } | ||
|
|
||
| export class SimulateDocumentResult { |
There was a problem hiding this comment.
we try to avoid duplicate names since it can break certain clients, could we rename this to something else? like SimulateIngestDocumentResult
l-trotta
reviewed
Jan 31, 2025
| * | ||
| * @behavior_meta AdditionalProperties fieldname=metadata description="Additional metadata" | ||
| */ | ||
| export class DocumentSimulation |
There was a problem hiding this comment.
same here, coule be IngestDocumentSimulation?
l-trotta
reviewed
Jan 31, 2025
| /** | ||
| * | ||
| */ | ||
| _version?: Stringified<VersionNumber> |
There was a problem hiding this comment.
is _version actually nullable? checking the server code it seems like it's always added.
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 is an update to #3400. The simulate ingest response is fairly different from the simulate pipeline response, so I've pulled it into its own object.
Specifically, simulate ingest has an
executed_pipelinesarray, and it does not have several fields that the simulate pipeline response has.