Skip to content

Provide guidance about how to include JSON? #53

@cdmgtri

Description

@cdmgtri

Maybe this is outside the scope of the IEPD 5.0 spec update and is queued up for the new Message Spec, but...

Does the recommended guidance on folder structures still make sense based on the updated layout for NIEM 5.0 packages? Folders like base-xsd might not be the best bet anymore. Where should JSON schemas and sample instances go if an IEPD developer converts a NIEM subset and extensions to NIEM JSON? What if the IEPD includes both the XSDs and the JSON schemas?

Possible layout for IEPD with XSDs and JSON (more detailed)

my_iepd/
    schemas/
        niem/
            xsd/
        niem-custom/
            xsd/
            json/       # Eventually the NIEM release or subset would have its own niem/json folder
        extensions/
            xsd/
            json/
    constraints/
        niem/
            xsd/
        niem-custom/
            xsd/
            json/
        extensions/
            xsd/
            json/
    iep-samples/
        xml/
        json/
    business-rules/
        xml/
        json/

Possible layout for IEPD with XSDs and JSON (maybe more typical)

my_iepd/
    schemas/
        niem/
            xsd/
        niem-custom/
            json/
        extensions/
            xsd/
            json/
    iep-samples/
        xml/
        json/
    business-rules/
        xml/
        json/

Dereferenced JSON extension schema

JSON schemas can use references to other files, but a fully de-referenced schema seems to have better support. Should guidance include a recommendation to also provide a fully-dereferenced JSON extension schema if the package includes more modular JSON schemas?

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions