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

Provide guidance about how to include JSON? #53

Open
cdmgtri opened this issue Feb 25, 2021 · 1 comment
Open

Provide guidance about how to include JSON? #53

cdmgtri opened this issue Feb 25, 2021 · 1 comment
Assignees

Comments

@cdmgtri
Copy link

cdmgtri commented Feb 25, 2021

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?

@TomCarlson-NTAC
Copy link
Contributor

I think this is something for the NIEM Message Specification Rules and Conventions, version 5.0 document.

This version, the IEPD Spec, is focused on narrowing down the MPD Spec. New or changed content is being pushed to the NMSR&C. There's no mention of JSON in the current spec, so providing any guidance at all means a lot of new content.

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

No branches or pull requests

2 participants