Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(api-client): add semantic_type to DatasetField #264

Merged
merged 1 commit into from
Nov 6, 2024

Conversation

richterb
Copy link
Contributor

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 optional semantic_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

  • Description is complete
  • Commits respect the Conventional Commits Specification
  • 2 reviewers (1 if trivial)
  • Tests coverage has improved
  • Code is ready for a release on NPM

Copy link

Coverage after merging feat/semantic-type-field-property into main will be

94.71%

Coverage Report
FileStmtsBranchesFuncsLinesUncovered Lines
src
   index.ts100%100%100%100%
src/client
   constants.ts100%100%100%100%
   error.ts100%100%100%100%
   index.ts84.14%74.03%100%95.31%102–103, 124, 13, 146, 148, 148–149, 15, 15, 151, 162, 169, 169, 17, 17, 171, 176, 179, 182, 184, 52, 82
   types.ts100%100%100%100%
src/odsql
   clauses.ts82.61%71.43%80%90.91%14, 32, 42
   index.ts92.05%83.72%95.74%94.19%111, 146, 25, 28, 56–57, 57, 57–58, 68, 78–79

Copy link

@benj-moreau benj-moreau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM ✅

Copy link
Contributor

@KevinFabre-ods KevinFabre-ods left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

@richterb richterb merged commit 6d58834 into main Nov 6, 2024
1 check passed
@richterb richterb deleted the feat/semantic-type-field-property branch November 6, 2024 08:36
@KevinFabre-ods
Copy link
Contributor

@richterb

FYI, we had a hole in our CI: linting was not run for PRs with changes in the api-client directory

Fixed here: f4c5e15

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants