metaschema-framework / oscal-server

Other
3 stars 2 forks source link

Refactor to Native Metaschema API Implementation #32

Open wandmagic opened 2 weeks ago

wandmagic commented 2 weeks ago

User Story

As a developer working with the OSCAL server,
I want to refactor the implementation to use the native metaschema-java APIs directly instead of CLI commands,
So that we can improve performance, reliability, and enable more advanced metaschema operations.

Goals

Background

Currently, the system uses CLI commands for metaschema operations, which has limitations:

Acceptance Criteria

  1. Replace CLI command executions with direct calls to metaschema-java APIs:

    • Core API
    • Databind API
    • Schemagen API
  2. Maintain existing functionality while using native APIs:

    • Schema generation
    • Data validation
    • Model transformation
  3. Remove dependencies on:

    • CLI command execution
    • Temporary file operations for CLI I/O
    • Log4j level requirements
  4. Update tests to verify equivalent functionality using native APIs

  5. Document any API-specific configuration or setup requirements

Technical Notes

Out of Scope

Implementation Phases

  1. Initial API integration for core operations
  2. Removal of CLI dependencies
  3. Performance optimization
  4. Documentation updates

Definition of Done

Dependencies

Metaschema documentation regarding best practices of schemagen and databind

Acceptance Criteria

Revisions

No response

wandmagic commented 2 weeks ago

see discussion here: https://github.com/metaschema-framework/oscal-server/pull/31