Record Type Field #345
Merged
Record Type Field #345
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
Client level views will now receive a `recordType` field, which indicates the name of the view model that was used to generate the output.
bencap
added
type: enhancement
jstone-dev
approved these changes
Nov 14, 2024
Merged
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.
Client level views will now receive a
recordTypefield, which indicates the name of the view model that was used to generate the output.I considered adding this to the base model, but really these should only be defined on models returned to the client. There's some boiler plate here, but if we were to reduce the boiler plate by defining this property on the Pydantic base class our API documentation would imply users need to supply a
recordTypeproperty within resources posted to our API. The additional code duplication seems well worth it to maintain our documentations' consistency.