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

[SL-1563] [Feature] Add meta to Metric/SemanticModel #251

Closed
3 tasks done
WilliamDee opened this issue Jan 20, 2024 · 2 comments · Fixed by #250
Closed
3 tasks done

[SL-1563] [Feature] Add meta to Metric/SemanticModel #251

WilliamDee opened this issue Jan 20, 2024 · 2 comments · Fixed by #250
Assignees
Milestone

Comments

@WilliamDee
Copy link
Contributor

WilliamDee commented Jan 20, 2024

Is this your first time submitting a feature request?

  • I have read the expectations for open source contributors
  • I have searched the existing issues, and I could not find an existing issue for this feature
  • I am requesting a straightforward change to existing dbt-semantic-interfaces functionality, rather than a Big Idea better suited to a discussion

Describe the feature

There has been requests to expose the meta field that's parsed by dbt-core to our interfaces. This would allow users to annotate freely with that field and have that be exposed on our SL APIs. However, this is only supported currently for Metric/SemanticModel, the other are addressed here #195

Spec changes:

SemanticModels
No dbt-core changes needed as it already exists, just need to expose in DSI

semantic_models:
 - name: my_model
   config:
     meta

Metrics
Currently, meta exists on the top-level of Metric. @quigley.malcolm mentioned that it should be moved to be nested under config. Then we can make the necessary changes in DSI.

metrics:
 - name: my_metric
   meta: ...

to

metrics:
 - name: my_metric
   config:
     meta: ...

Describe alternatives you've considered

No response

Who will this benefit?

Any users interacting with the SL APIs who needs to annotate their metrics or semantic models via their own structure.

Are you interested in contributing this feature?

No response

Anything else?

No response

From SyncLinear.com | SL-1563

@WilliamDee WilliamDee added the enhancement New feature or request label Jan 20, 2024
@WilliamDee WilliamDee changed the title [Feature] Add meta to Metric/SemanticModel [SL-1563] [Feature] Add meta to Metric/SemanticModel Jan 20, 2024
@WilliamDee WilliamDee self-assigned this Jan 20, 2024
@WilliamDee WilliamDee added Metricflow Created by Linear-GitHub Sync Metricflow Gap Created by Linear-GitHub Sync labels Jan 22, 2024
@Jstein77
Copy link

Metrics needs to nest meta under config.

@WilliamDee WilliamDee removed Metricflow Created by Linear-GitHub Sync Metricflow Gap Created by Linear-GitHub Sync labels Feb 8, 2024
@WilliamDee WilliamDee added this to the v.14 milestone Feb 13, 2024
WilliamDee added a commit that referenced this issue Mar 11, 2024
Resolves #251 

<!---
Include the number of the issue addressed by this PR above if
applicable.
  PRs for code changes without an associated issue *will not be merged*.
  See CONTRIBUTING.md for more information.
-->

### Description
This PR exposes the `meta` field for Metric and SemanticModel which
enables it to be parsed out in the semantic manifest for use in the SL
APIs
<!---
Describe the Pull Request here. Add any references and info to help
reviewers
  understand your changes. Include any tradeoffs you considered.
-->

### Checklist

- [x] I have read [the contributing
guide](https://github.com/dbt-labs/dbt-semantic-interfaces/blob/main/CONTRIBUTING.md)
and understand what's expected of me
- [x] I have signed the
[CLA](https://docs.getdbt.com/docs/contributor-license-agreements)
- [x] This PR includes tests, or tests are not required/relevant for
this PR
- [x] I have run `changie new` to [create a changelog
entry](https://github.com/dbt-labs/dbt-semantic-interfaces/blob/main/CONTRIBUTING.md#adding-a-changelog-entry)
@WilliamDee
Copy link
Contributor Author

@jordan.stein this is merged btw!

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

Successfully merging a pull request may close this issue.

3 participants