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

Add the concept of reference attributes to the spec #1521

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

Conversation

michaelsafyan
Copy link
Contributor

Fixes #1428

Changes

Adds the concept of "reference attributes" / "reference fields" to the specification.

Merge requirement checklist

@michaelsafyan
Copy link
Contributor Author

Given the existence of the use of ref in the VCS attributes, I will update this PR with an alternative segment.

@michaelsafyan
Copy link
Contributor Author

Here are some possible naming alternatives to ref:

  • external: given that it will be in external storage
  • ext: shorter way of using the name "external"
  • foreign: given that it is in a foreign storage location
  • remote: given that it may be in another storage location
  • ext_storage: similar mash up of the above
  • remote_storage: similar mash up of the above
  • blob_ref: another possible name

Any other thoughts? Any opinions on what is best?

@michaelsafyan
Copy link
Contributor Author

I've updated the pull request to use *.blob_ref.* instead of *.ref.* but am open to alternative naming suggestions.

@christophe-kamphaus-jemmic

I think blob_ref is a good choice.

Should there be some tooling to make sure we don't accidentally define anything blob_ref.* in the future?
Eg. could we add a policy in policies/ to flag a violation if blob_ref.* is detected?

@@ -98,6 +98,15 @@ Recommendations on using attributes vs. body fields:
* The _fields_ are unique to the named event (`event.name`) and different events
may use the same _field_ name to represent different data, due to the unique
nature of the event.
* The _fields_ SHOULD NOT use the `*.blob_ref.*` name, except when applying the
Copy link
Contributor

Choose a reason for hiding this comment

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

NIt: You can provide a policy to enforce this in the /policies directory. Would like to see this happen after this naming and feature is approved.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sounds good. I'm happy to either add this enforcement in a separate PR or to add to the existing PR. Would it be better to do that separately or in a single PR?

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

Successfully merging this pull request may close these issues.

Seeking input on proposal for "reference"-type attribute values.
3 participants