Skip to content

Comments

deprecate: mark ListAllowedValuesCommand as deprecated#245

Open
david-waltermire wants to merge 1 commit intometaschema-framework:developfrom
david-waltermire:feature/deprecate-list-allowed-values
Open

deprecate: mark ListAllowedValuesCommand as deprecated#245
david-waltermire wants to merge 1 commit intometaschema-framework:developfrom
david-waltermire:feature/deprecate-list-allowed-values

Conversation

@david-waltermire
Copy link
Contributor

@david-waltermire david-waltermire commented Feb 18, 2026

Summary

  • Adds @Deprecated(since = "3.0.0") annotation to ListAllowedValuesCommand
  • Adds @deprecated Javadoc tag directing users to metaschema-cli list-allowed-values
  • Updates command description to include deprecation notice

Context

The list-allowed-values command has been migrated to metaschema-cli, making it available without requiring OSCAL-specific dependencies. The oscal-cli version is deprecated but retained for backward compatibility.

The import will be updated from dev.metaschema.oscal.lib.model.util to dev.metaschema.core.metapath.item.node in a follow-up once the metaschema-java dependency version is bumped.

Depends on: metaschema-framework/metaschema-java#666

Test plan

  • Full CI build passes (mvn clean install -PCI -Prelease)
  • Deprecation annotation renders correctly in Javadoc
  • Command description shows deprecation notice

Summary by CodeRabbit

  • Chores
    • Deprecated the "list-allowed-values" command as of version 3.0.0. Users should migrate to using the metaschema-cli tool for this functionality going forward.

The list-allowed-values functionality has been migrated to
metaschema-cli. This deprecates the oscal-cli version with a notice
directing users to the new command location.

The import will be updated from liboscal-java to metaschema-java core
in a follow-up once the metaschema-java dependency is updated.
@coderabbitai
Copy link

coderabbitai bot commented Feb 18, 2026

No actionable comments were generated in the recent review. 🎉


📝 Walkthrough

Walkthrough

The ListAllowedValuesCommand class is marked as deprecated with the @Deprecated(since = "3.0.0") annotation. Javadoc documentation is updated to indicate deprecation status with guidance to use metaschema-cli instead. The getDescription() method text is prefixed with a deprecation notice. No functional logic changes are introduced.

Changes

Cohort / File(s) Summary
Deprecation Annotation
src/main/java/dev/metaschema/oscal/tools/cli/core/commands/ListAllowedValuesCommand.java
Added @Deprecated(since = "3.0.0") annotation to the class, updated Javadoc comment to indicate deprecation with guidance to use metaschema-cli, and prefixed the description text with deprecation notice.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 A gentle hop into the past,
This command's glory shall not last,
Yet marked with care, deprecated fine,
It shows the way to paths new-shined.

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: marking ListAllowedValuesCommand as deprecated with clear, concise language.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Comment @coderabbitai help to get the list of available commands and usage tips.

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

Successfully merging this pull request may close these issues.

1 participant