Skip to content

Latest commit

 

History

History
109 lines (82 loc) · 6.69 KB

README.md

File metadata and controls

109 lines (82 loc) · 6.69 KB

README

Work Product ReadMe Logo

oasis-avatar An OASIS Work Product Repository oasis-avatar

Members of the OASIS Open Command and Control (OpenC2) Technical Committee use this GitHub repository as part of the TC's chartered work. Contributors must be Members of the TC. Work is governed by the OASIS policies and is not done under typical open source licensing. For more details, see the Contributions and Licensing sections below.

📘 Information Modeling with JADN 📘

The JSON Abstract Data Notation (JADN) specification defines an information modeling (IM) language by specifying a vocabulary to describe the meaning of structured data, to provide hints for user interfaces working with structured data, and to make assertions about what a valid instance must look like. This respository hosts a companion OASIS Committee Note that provides context and explanatory material to assist with applying JADN in practice.

The Published branch of this repository contains the OASIS-published CN01 version of this document and associated files. Markdown, HTML, and PDF versions are provided and are identical to the versions available from OASIS.

🔀 Repository Organization 🔀

branches

OpenC2 work product repositories are organized a bit differently than typical open source software project repositories:

  • The Published (default) branch represents the current, stable, approved version of the work product. If the product hasn't progressed past an OASIS Committee Specification Draft (CSD), this branch is essentially empty.
  • The Working branch is where all work-in-progress content is captured, and is the place to go for the current working version of this work product.

More information about the TC's repository organizing conventions and branching strategy can be found in our Documentation Norms.

🗨️ Description 🗨️

Information models (IMs) are used to define and generate physical data models, validate information instances, and enable lossless translation across data formats. JSON Abstract Data Notation (JADN) is a UML-based information modeling language that defines data structure independently of data format. This Committee Note describes the use of IMs, explains how to construct IMs using JADN, and contrasts IMs with other modeling approaches, such as Entity-Relationship models for databases, and knowledge models / ontologies.

✍️ Contributions ✍️

As stated in this repository's CONTRIBUTING file, contributors to this repository are expected to be Members of the OASIS OpenC2 TC, for any substantive change requests. Anyone wishing to contribute to this GitHub project and participate in the TC's technical activity is invited to join as an OASIS TC Member. Public feedback is also accepted, subject to the terms of the OASIS Feedback License.

📜 Licensing 📜

Please see the LICENSE file for description of the license terms and OASIS policies applicable to the TC's work in this GitHub project. Content in this repository is intended to be part of the OpenC2 TC's permanent record of activity, visible and freely available for all to use, subject to applicable OASIS policies, as presented in the repository LICENSE file.

🗨️ Further Description of this Repository 🗨️

This repository is designed to support TC members' work on a formal specification that describes Information Modeling With JADN. This GitHub repository supports development of the content and change tracking for the Information Modeling With JADN as new working draft level revisions are created and the associated CSDs mature.

Members of the OASIS Open Command and Control (OpenC2) TC create and manage technical content in this TC GitHub repository ( https://github.com/oasis-tcs/openc2-jadn-im ) as part of the TC's chartered work (i.e., the program of work and deliverables described in its charter).

OASIS TC GitHub repositories, as described in GitHub Repositories for OASIS TC Members' Chartered Work, are governed by the OASIS TC Process, IPR Policy, and other policies, similar to TC Wikis, TC JIRA issues tracking instances, TC SVN/Subversion repositories, etc. While they make use of public GitHub repositories, these TC GitHub repositories are distinct from OASIS Open Repositories, which are used for development of open source licensed content.

📩 Contact 📩

Please send questions or comments about OASIS TC GitHub repositories to the OASIS TC Administrator. For questions about content in this repository, please contact the TC Chair or Co-Chairs as listed on the the OpenC2 TC's home page.