Versions Compared

Version Old Version 1 New Version 2
Changes made by

Jim Wilson

Jim Wilson

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Beginning with OAGIS 10.7, OAGi began maintaining OAGIS with Score. OAGi ceased to advertise availability of any XML Schema expressions of OAGIS while quietly making the Platform and Standalone-

Status
colourRed
titlepattern
editions available to members on request.

Miscellaneous

JSON schema patters

What XML Schema design patterns are possible with JSON schema?

...

“Canonical” meaning

OAGi has historically referred to OAGIS as an “enterprise canonical”. Canonical in this context refers to a format that an enterprise uses to map other formats to/from.

Use cases

Note regarding naming specific organizations

In the spirit of meeting needs across the OAGi community, we avoid indicating in writing organization names. Satisfying any set of use cases is for the benefit of the community, not just one member of it.

Use case 0

XML schema content organized like 10.6.

Use case 1

JSON schema of entire model in one file.

...

XML schema of each component tagged noun in one file each with the set of files zipped.

Use case 5

XML schema file of entire model.

Use case 6

Entire model expressed as Hugo-formatted documentation.

Use case 7

Component expressed as Mermaid script for a UML class diagram

  • Only the component and its children

    • BCCs as properties

    • ACCs as classes associated by shared aggregation (open diamond symbol)

API design

API parameters

  1. Model subset: What part of the model needs to be expressed?

    1. All

    2. A root component (e.g., BOM)

    3. A set of root components (e.g., BOM, ProcessPurchaseOrder, NotifyShipment)

    4. All components with a specified tag (e.g., noun)

  2. Expression type: What is the expression type? (Is there a better name for this other than “expression type”?)

    1. XML Schema

    2. JSON Schema

    3. OAS? (Jim doesn’t think this makes sense)

    4. XMI

    5. Documentation

    6. OWL?

    7. RDF Schema?

  3. Pattern: For some expression types, what is the pattern (e.g., Garden of Eden)

  4. File system structure: For some expression types, what is the file/folder naming conventions and structure

  5. Internal file organization: For some expression types, how content is organized within files. (e.g., Within XML schemas list element declarations first in alphabetical order followed by type definitions in alphabetical order)