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

refactor(system, data-frame): change term 'Metadata' to 'Properties' #83

Open
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

richie-ni
Copy link
Collaborator

@richie-ni richie-ni commented Oct 14, 2024

🤨 Rationale

US : User Story 2861034: Update "Metadata" to "Properties" in the existing Grafana datasources - Systems and Dataframes

This Pull Request involves the change of updating the term 'MetaData' to 'Properties' as discussed in the Products & Results DataSource Requirements PR, in the Systems and DataFrame DataSource to improve clarity and consistency. This also involves renaming the SystemMetadata type to SystemProperties across various files in the asset DataSource.

👩‍💻 Implementation

  • Renamed SystemMetadata to SystemProperties in the QuerySystemsResponse interface at src/core/types.ts
  • Updated variable names and constants from metadata instead of properties in all relevant files
  • Updated imports, function parameters, and test cases to use type SystemProperties instead of SystemMetadata in all relevant files.'.

🧪 Testing

  • Test files have been updated with the term 'Properties' instead of 'MetaData' and verified manually that all tests are passing locally.

✅ Checklist

@richie-ni richie-ni changed the title feat(products): change term 'Metadata' to 'Properties' refactor(system, data-frame): change term 'Metadata' to 'Properties' Oct 15, 2024
@richie-ni richie-ni self-assigned this Oct 15, 2024
@mure
Copy link
Collaborator

mure commented Oct 16, 2024

@richie-ni Is this ready to be reviewed? I see that it's in the "Draft" state.

@richie-ni
Copy link
Collaborator Author

richie-ni commented Oct 17, 2024

@richie-ni Is this ready to be reviewed? I see that it's in the "Draft" state.

@mure We wanted to get it reviewed internally, once done i will be moving the PR from the Draft state to Ready for review.

@richie-ni richie-ni marked this pull request as ready for review October 17, 2024 09:55
@richie-ni
Copy link
Collaborator Author

@mure , @kkerezsi, @CiprianAnton , @cameronwaterman Could you please review the changes in the PR?

src/datasources/system/components/SystemQueryEditor.tsx Outdated Show resolved Hide resolved
@@ -1,7 +1,7 @@
import { DataQuery } from '@grafana/schema'

export enum SystemQueryType {
Metadata = "Metadata",
Properties = "Properties",
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is going to be a breaking change ... All widgets that are using Metadata are going to be broken.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Renaming this is not a good solution .

cc @mure for awareness

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.

4 participants