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

Update JADN Type Definition Description (Sect 3.1 & subs) #58

Merged
merged 23 commits into from
Oct 9, 2024

Conversation

dlemire60
Copy link
Contributor

@dlemire60 dlemire60 commented Oct 3, 2024

  1. Update figure 3-2 to correct minor errors (this may need to be redrawn for a clearer image)
  2. Add an overview of a JADN schema doc in section 3.1
  3. Miscellaneous wording tweaks in section 3.1 and subsections
  4. Describe use of minv / maxv for Binary, Integer, String types
  5. Describe use of minf / maxf for Number types
  6. Explain the constraints imposed by ipv4/6-net on Array types
  7. Add new figure 3-3 with top-level structure of schema doc and renumber subsequent figures
  8. Added CDDL reference info for f16/f32/f64 CBOR serialization types
  9. Added PRs Minor updates to Music Library Database example #53-58 to the change record in Appendix C to capture recent work

@dlemire60 dlemire60 changed the base branch from published to working October 3, 2024 17:44
@dlemire60 dlemire60 requested a review from davaya October 3, 2024 19:18
Copy link
Contributor

@davaya davaya left a comment

Choose a reason for hiding this comment

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

I approve of the changes to the CN and info/types PNG.

The structure overlay will have to be changed later:

  • Choice/Enumerated are union types, and Choice is either tagged (the kind we know and love with no options) or the new untagged (if oneOf, anyOf, and allOf options are included).
  • UML collection options in table 7-1 are {sequence, set, orderedSet, bag} - sequence is new, orderedSet replaces unique and bag replaces unordered to align with UML. JIDL will still use "unique" for Array and "ordered" for Map/Record with the orderedSet type option.
  • New inheritance options are {extends, restricts, and abstract} - currently undocumented and unimplemented, but they will go in JADN 1.1 along with untagged unions

I'm not sure the structure figure is helpful, but it can be included in this PR knowing that it will either be significantly updated or deleted. If it's helpful to some readers we should keep it.

In the software library I changed the "exports" info field name to "roots" to match what it is used for. "exports" is allowed as a synonym but is deprecated; new schemas should use roots, assuming the TC accepts the update to the CN and CS. I've started adding inheritance to the library but it isn't in a release yet.

@dlemire60 dlemire60 marked this pull request as ready for review October 8, 2024 13:43
@dlemire60
Copy link
Contributor Author

I've added this PR to the 9 October working meeting agenda.

@dlemire60
Copy link
Contributor Author

Approved for merging at 9 October working meeting

@dlemire60 dlemire60 merged commit fcec1f8 into oasis-tcs:working Oct 9, 2024
@dlemire60 dlemire60 deleted the type-def-updates branch October 9, 2024 19:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants