feat(api-client): add semantic_type to DatasetField #264
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.
Summary
The goal for this PR is to add a new optional
semantic_type
property to dataset fields, to mirror this new feature in the API.Changes
This new property is optional (the API only mentions it if it exists, otherwise it doesn't appear in the schema at all).
I added the two current values existing in the platform's backend.
Breaking Changes
None
Changelog
In the API Client: The
DatasetField
type now includes the optionalsemantic_type
which can be returned by the API for fields that are using a semantic type such as "IP Address". A semantic type is a higher-level type with specific behaviors.Review checklist