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

Clarification on Use of @id, PURL Identifier, and Impact Statements #48

Open
nikosgalanis opened this issue Jun 24, 2024 · 2 comments
Open
Labels
question Further information is requested

Comments

@nikosgalanis
Copy link

nikosgalanis commented Jun 24, 2024

Hello,

I have a few questions and requests for clarification regarding some fields in an OpenVEX document, given the spec provided:

  • What should be the @id field in the document’s metadata? Can it mention the location where the final document will reside?
  • In the package structure, is there a point of having an @id and a purl identifier, or can we opt to go with one of them? And if yes, is it valid to just have the purl identifier in the @id field?
  • Could we have impact_statement in every status? If not, how could we add notes that clarify the status to the user?

TIA!

@cpanato cpanato added question Further information is requested labels Jun 24, 2024
@cpanato
Copy link
Member

cpanato commented Jun 24, 2024

cc @puerco

@puerco
Copy link
Member

puerco commented Jul 9, 2024

Sorry for missing this @nikosgalanis

What should be the @id field in the document’s metadata? Can it mention the location where the final document will reside?

The IRI in the @id field is used to uniquely identify the document. Ideally it should be retrievable, especially if you plan to point to it from other documents but vex statements are self-sustaining so it can also be private.

In the package structure, is there a point of having an @ id and a purl identifier, or can we opt to go with one of them? And if yes, is it valid to just have the purl identifier in the @ id field?

Yes you can just have the purl in the @ id field and be done with it. Or in the identifiers. The point of id is to make the elements identifiable from other linked documents.

Could we have impact_statement in every status? If not, how could we add notes that clarify the status to the user?

That field is defined upstream from the VEX WG, we cannot alter it as it would break the general VEX definition. For affected we have an action_statement where you can convey messages.

For which status do you need it the most? Help me understand more and I can propose it to the wider VEX community.

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

No branches or pull requests

3 participants