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 some documentation on using Java schema in own tooling? #10

Closed
4 tasks
flickerfly opened this issue Nov 18, 2021 · 4 comments · Fixed by #37
Closed
4 tasks

Add some documentation on using Java schema in own tooling? #10

flickerfly opened this issue Nov 18, 2021 · 4 comments · Fixed by #37
Assignees

Comments

@flickerfly
Copy link

User Story:

As a developer of OSCAL documents, I would like to be able to easily find how to re-use things like the metaschema so I can quickly create tools that output OSCAL documents.

Goals:

I have spreadsheets that represent what should be an OSCAL Catalog. I want to convert that spreadsheet into an OSCAL Catalog. I don't expect you to understand the spreadsheet, but I'd like some examples of taking some generic data into Java and then pushing it into the schema properly, then outputing an OSCAL document. A catalog seems like a good option for that example, but any would do. The objective is so I can see a complete example and use that to understand how all the parts are meant to be put together so I can re-work it for my use-case.

Dependencies:

We've been figuring it out using the current oscal Java projects, but some more clear example would support more quickly getting up-to-speed and growing the community.

Acceptance Criteria

  • Example exists of converting small generic catalog data (potentially in spreadsheet form) into OSCAL Catalog
  • All OSCAL website and readme documentation affected by the changes in this issue have been updated. Changes to the OSCAL website can be made in the docs/content directory of your branch.
  • A Pull Request (PR) is submitted that fully addresses the goals of this User Story. This issue is referenced in the PR.
  • The CI-CD build process runs without any reported errors on the PR. This can be confirmed by reviewing that all checks have passed in the PR.
@bradh
Copy link
Contributor

bradh commented Nov 19, 2021

There is an example at https://github.com/bradh/ism-oscal/blob/main/ozcal/xml2oscal/src/main/java/net/frogmouth/rnd/xml2oscal/Xml2Oscal.java

The Essential 8 part is a bit of noise, but shows another source.

@flickerfly
Copy link
Author

Ah, thanks @bradh. That looks very useful. I knew there must be pre-existing work on this!

I got a good chuckle when I realized you were dealing with Australian government source and calling it ozcal. :-)

@bradh
Copy link
Contributor

bradh commented Nov 19, 2021

I got a good chuckle when I realized you were dealing with Australian government source and calling it ozcal. :-)

No extra charge.

@david-waltermire david-waltermire transferred this issue from usnistgov/OSCAL Jan 21, 2022
david-waltermire added a commit to david-waltermire/liboscal-java that referenced this issue Jun 21, 2022
@david-waltermire david-waltermire linked a pull request Jun 21, 2022 that will close this issue
8 tasks
david-waltermire added a commit to david-waltermire/liboscal-java that referenced this issue Jun 21, 2022
Added simple example tests. Resolves usnistgov#10.
Added example to README.md
david-waltermire added a commit that referenced this issue Jun 21, 2022
Added simple example tests. Resolves #10.
Added example to README.md
@david-waltermire
Copy link
Collaborator

Resolved by #37.

david-waltermire added a commit that referenced this issue Jun 24, 2022
Added simple example tests. Resolves #10.
Added example to README.md
david-waltermire added a commit to david-waltermire/liboscal-java that referenced this issue Jun 29, 2022
Added simple example tests. Resolves usnistgov#10.
Added example to README.md
david-waltermire added a commit that referenced this issue Jun 29, 2022
Added simple example tests. Resolves #10.
Added example to README.md
@david-waltermire david-waltermire self-assigned this Oct 18, 2022
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 a pull request may close this issue.

3 participants