Fix _id
and _score
in records APIs
#334
Merged
+36
−11
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.
Problem
Code generation from OpenAPI specs has some quirks, one of which is trying to get rid of leading underscores in objects and classes in some languages. We currently use
_id
and_score
in our records API to denote reserved keys. We previously needed to add some logic during codegen in python to prevent this same issue.Currently:
upsertRecords
with records containing_id
.searchRecords
the resulting object has the keys mapped from_id
->id
and_score
->score
.Solution
IntegratedRecord
type which resolves the problem withupsertRecords
build-oas.sh
script that handles massaging theHit.ts
file fields to maintain the shape of the API.Type of Change
Test Plan
CI Unit + Integration