-
-
Notifications
You must be signed in to change notification settings - Fork 61
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
Added formulation support and test cases #222
Conversation
Signed-off-by: Steve Springett <steve@springett.us>
Signed-off-by: Steve Springett <steve@springett.us>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
review done.
Things that made me reject the PR are marked with a red cross ❌
general remark to the XML: most of those simple types - like string
, bool
and dateTime
- could be attributes, instead of child elements.
examples:
- https://github.com/CycloneDX/specification/pull/222/files#r1200081423
- https://github.com/CycloneDX/specification/pull/222/files#r1200087127
general remark on JSON: why not have key-value-pairs as open object?
examples:
general remark: I do not like elements which have all child-nodes/properties as optional, no required content at all.
what purpose do they have, then? Let's reconsider which child-node(s)/propertie(s) are actually defining the element, and make this one(s) mandatory.
examples:
my questions are basically caused by the fact that there are no descriptions for the enums. 💡 if some of the enum values are scoped to VCS, then they should have common prefix, like PS: i see that PPS: see #245 |
Signed-off-by: Steve Springett <steve@springett.us>
Signed-off-by: Steve Springett <steve@springett.us>
…e in thr xsd Signed-off-by: Steve Springett <steve@springett.us>
@mrutkows I need your help in answering some of these concerns. Time is running out as this issue is up for vote. |
"type": "string", | ||
"format": "date-time" | ||
}, | ||
"workspaces": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see that the definition of this object (Task) has a lot of duplication info in Formula, wouldn't it be better to create an object to encapsulate that?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes it would be. There's a lot of duplication, in part because we're still using draft-7 and the documentation tool we use doesn't work correctly when creating reusable properties and including them with anyOf or allOf. We tried multiple times, but documentation took priority over schema optimization. Once we migrate away from draft-7 and update the documentation tool, we should be able to optimize the schema.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mr-zepol I did create a reusable type, but was told it was too hard for XSD to represent/consume
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My suggestion was basically because trying to model this in Java for example would mean a lot of duplicate code as well
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mr-zepol There's no reason why the Java implementation needs to implement duplication. You can (and likely should) have some abstract classes where all the commonality is located and can be extended by concrete classes.
* remove `additionalItems` for non-array-`items` see also #230 Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
Signed-off-by: Steve Springett <steve@springett.us>
@mrutkows emphasized to revisit the inputs and outputs.
PS: |
New tickets created referencing this PR which identify potential improvement areas in v1.6 |
Implements and closes #31