Inconsistent field names

kubernetes-sigs / wg-policy-prototypes

A place for policy work group related proposals and prototypes.

Apache License 2.0

64 stars 39 forks source link

Inconsistent field names #96

Closed mattmoor closed 1 year ago

mattmoor commented 2 years ago

I noticed in the documentation for v1alpha2 that the json field names and the names used in the comments are inconsistent here: https://github.com/kubernetes-sigs/wg-policy-prototypes/blob/d747ba319734a9252c770654bc96af9071eb9d3d/policy-report/pkg/api/wgpolicyk8s.io/v1alpha2/policyreport_types.go#L96-L105

The Go fields and comments use Subject, but the json field uses resource

k8s-triage-robot commented 2 years ago

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Mark this issue or PR as fresh with /remove-lifecycle stale
Mark this issue or PR as rotten with /lifecycle rotten
Close this issue or PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot commented 2 years ago

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Mark this issue or PR as fresh with /remove-lifecycle rotten
Close this issue or PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

JimBugwadia commented 2 years ago

/remove-lifecycle rotten

k8s-triage-robot commented 2 years ago

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Mark this issue or PR as fresh with /remove-lifecycle stale
Mark this issue or PR as rotten with /lifecycle rotten
Close this issue or PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

JimBugwadia commented 2 years ago

/remove-lifecycle stale

Rishit-dagli commented 2 years ago

/assign

k8s-triage-robot commented 1 year ago

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Mark this issue or PR as fresh with /remove-lifecycle stale
Mark this issue or PR as rotten with /lifecycle rotten
Close this issue or PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

JimBugwadia commented 1 year ago

/remove-lifecycle stale

anusha94 commented 1 year ago

/assign

anusha94 commented 1 year ago

The names changed when updating from v1alpha1 to v1alpha2.

@JimBugwadia Is the json name same for compatibility reasons? In that case, we can change the Go field names. Else, change the json field names.

JimBugwadia commented 1 year ago

@anusha94 yes, lets change the Go field name and keep the JSON name the same for compatibility.