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.

Sign up for GitHub

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

Jump to bottom

artifactLocation.artifactIndex => index; artifact.artifactLocation => location; attachment.artifactLocation => location #368

Closed
ghost opened this issue Apr 11, 2019 · 2 comments
Closed

artifactLocation.artifactIndex => index; artifact.artifactLocation => location; attachment.artifactLocation => location #368

ghost opened this issue Apr 11, 2019 · 2 comments
Labels
2.1.0-CSD.1 Will be fixed in SARIF v2.1.0 CSD.1. bug impact-breaks-consumers impact-breaks-producers merged Changes merged into provisional draft. resolved-fixed

Comments

@ghost
Copy link

ghost commented Apr 11, 2019 •
edited by ghost
Loading

We missed these in our name-cleanup scrub.
@ghost ghost added bug 2.1.0-CSD.1 Will be fixed in SARIF v2.1.0 CSD.1. change-draft-superfluous The change is a simple rename; no change draft needed. labels Apr 11, 2019
@ghost ghost self-assigned this Apr 11, 2019
@ghost ghost added resolved-by-design and removed change-draft-superfluous The change is a simple rename; no change draft needed. labels Apr 11, 2019
@ghost
Copy link
Author

ghost commented Apr 11, 2019 •
edited by ghost
Loading

artifactIndex is correct as it is. We abbreviate to index only when it represents the index of the containing object in an array. In this case, the property is not the index of the containing artifactLocation object, it's the index of the associated artifact object in run.artifacts. Hence, artifactIndex.

@ghost ghost closed this as completed Apr 11, 2019
@ghost ghost reopened this Apr 12, 2019
@ghost ghost removed the resolved-by-design label Apr 12, 2019
@ghost
Copy link
Author

ghost commented Apr 12, 2019 •
edited by ghost
Loading

Re-opening at @michaelcfanning's request, to use a shorter name, and to avoid breaking the SDK, which in fact used "index" for this property. My principled defense of "artifactIndex" (above) is valid, but as a practical matter, the difference is small, and we're trying not to unnecessarily inflate an already verbose format.

@ghost ghost changed the title artifactLocation.artifactIndex => index artifactLocation.artifactIndex => index; artifact.artifactLocation => location Apr 13, 2019
ghost pushed a commit that referenced this issue Apr 13, 2019
Change draft + merge for issues #366, #367, #368, #369, and #370.
5c92483
@ghost ghost closed this as completed Apr 13, 2019
@ghost ghost changed the title artifactLocation.artifactIndex => index; artifact.artifactLocation => location artifactLocation.artifactIndex => index; artifact.artifactLocation => location; attachment.artifactLocation => location Apr 13, 2019
ghost pushed a commit that referenced this issue Apr 13, 2019
Change draft + merge for remaining changes for #368
5013bcb
@ghost ghost mentioned this issue Apr 16, 2019
Closed
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
2.1.0-CSD.1 Will be fixed in SARIF v2.1.0 CSD.1. bug impact-breaks-consumers impact-breaks-producers merged Changes merged into provisional draft. resolved-fixed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
0 participants