parameter *input-openapi* instead of *input-yaml* (the latter is kept for backward compatibility)

Author: fugerit79

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- parameter *input-openapi* instead of *input-yaml* (the latter is kept for backward compatibility)
+
 ## [2.0.0] - 2025-07-27
 
 ### Fixed

src/main/java/org/fugerit/java/openapi/doc/OpenAPIDocCheckModel.java

@@ -99,12 +99,13 @@ private static void check(CheckContext context, String path, Class<?> typeModel,
     @SuppressWarnings("unchecked")
     public static int handleModelCheck(Properties props) throws ConfigException {
         SimpleValue<Integer> res = new SimpleValue<>(Result.RESULT_CODE_OK);
-        String inputYaml = props.getProperty(OpenAPIDocMain.ARG_INPUT_YAML);
+        String inputOpenapi = props.getProperty(OpenAPIDocMain.ARG_INPUT_OPENAPI,
+                props.getProperty(OpenAPIDocMain.ARG_INPUT_YAML));
         String checkType = props.getProperty(ARG_CHECK_TYPE);
         String checkSchema = props.getProperty(ARG_CHECK_SCHEMA);
         String outputFile = props.getProperty(OpenAPIDocMain.ARG_OUTPUT_FILE);
-        if (StringUtils.isEmpty(inputYaml)) {
-            throw new ConfigException(MISSING_REQUIRED + OpenAPIDocMain.ARG_INPUT_YAML);
+        if (StringUtils.isEmpty(inputOpenapi)) {
+            throw new ConfigException(MISSING_REQUIRED + OpenAPIDocMain.ARG_INPUT_OPENAPI);
         }
         if (StringUtils.isEmpty(checkType)) {
             throw new ConfigException(MISSING_REQUIRED + ARG_CHECK_TYPE);
@@ -113,7 +114,7 @@ public static int handleModelCheck(Properties props) throws ConfigException {
             throw new ConfigException(MISSING_REQUIRED + ARG_CHECK_SCHEMA);
         }
         ConfigException.apply(() -> {
-            try (Reader reader = new FileReader(new File(inputYaml));
+            try (Reader reader = new FileReader(new File(inputOpenapi));
                     StringWriter buffer = new StringWriter();
                     PrintWriter report = new PrintWriter(buffer)) {
                 report.println("# comparison ");

src/main/java/org/fugerit/java/openapi/doc/OpenAPIDocMain.java

@@ -33,7 +33,9 @@ private OpenAPIDocMain() {
 
     public static final String ARG_EXCLUDE_SCHEMAS = "exclude-schemas";
 
-    public static final String ARG_INPUT_YAML = "input-yaml";
+    public static final String ARG_INPUT_OPENAPI = "input-openapi";
+
+    public static final String ARG_INPUT_YAML = "input-yaml"; // alias to 'input-openapi' for backward compatibility
 
     public static final String ARG_OUTPUT_FILE = "output-file";
 
@@ -92,12 +94,12 @@ private static void setup(OpenAPIDocConfig config, Properties props) throws IOEx
 
     private static void handleSingleMode(Properties props) throws ConfigException {
         ConfigException.apply(() -> {
-            String inputYaml = props.getProperty(ARG_INPUT_YAML);
+            String inputOpenapi = props.getProperty(ARG_INPUT_OPENAPI, props.getProperty(ARG_INPUT_YAML));
             String outputPath = props.getProperty(ARG_OUTPUT_FILE);
-            if (StringUtils.isEmpty(inputYaml) || StringUtils.isEmpty(outputPath)) {
-                throw new ConfigException("Required params : " + ARG_INPUT_YAML + ", " + ARG_OUTPUT_FILE);
+            if (StringUtils.isEmpty(inputOpenapi) || StringUtils.isEmpty(outputPath)) {
+                throw new ConfigException("Required params : " + ARG_INPUT_OPENAPI + ", " + ARG_OUTPUT_FILE);
             } else {
-                File inputFile = new File(inputYaml);
+                File inputFile = new File(inputOpenapi);
                 File outputFile = new File(outputPath);
                 String fileName = outputFile.getName();
                 String outputFormat = fileName.substring(fileName.lastIndexOf('.') + 1);

src/test/java/org/fugerit/java/openapi/doc/TestOpenAPIDocCheckModel.java

@@ -18,7 +18,7 @@ public class TestOpenAPIDocCheckModel {
     @Test
     public void testOk() throws ConfigException {
         Properties params = new Properties();
-        params.setProperty(OpenAPIDocMain.ARG_INPUT_YAML, "src/test/resources/sample/sample.yaml");
+        params.setProperty(OpenAPIDocMain.ARG_INPUT_OPENAPI, "src/test/resources/sample/sample.yaml");
         params.setProperty(OpenAPIDocCheckModel.ARG_CHECK_SCHEMA, SampleResult.class.getSimpleName());
         params.setProperty(OpenAPIDocCheckModel.ARG_CHECK_TYPE, SampleResult.class.getName());
         params.setProperty(OpenAPIDocMain.ARG_OUTPUT_FILE, "target/report.md");
@@ -29,7 +29,7 @@ public void testOk() throws ConfigException {
     @Test
     public void testKo() throws ConfigException {
         Properties params = new Properties();
-        params.setProperty(OpenAPIDocMain.ARG_INPUT_YAML, "src/test/resources/sample/sample_check1.yaml");
+        params.setProperty(OpenAPIDocMain.ARG_INPUT_OPENAPI, "src/test/resources/sample/sample_check1.yaml");
         params.setProperty(OpenAPIDocCheckModel.ARG_CHECK_SCHEMA, SampleResult.class.getSimpleName());
         params.setProperty(OpenAPIDocCheckModel.ARG_CHECK_TYPE, SampleResult.class.getName());
         params.setProperty(OpenAPIDocCheckModel.ARG_CHECK_ONCE, BooleanUtils.BOOLEAN_TRUE);
@@ -41,7 +41,7 @@ public void testKo() throws ConfigException {
     @Test
     public void testKo2() throws ConfigException {
         Properties params = new Properties();
-        params.setProperty(OpenAPIDocMain.ARG_INPUT_YAML, "src/test/resources/sample/sample_check2.yaml");
+        params.setProperty(OpenAPIDocMain.ARG_INPUT_OPENAPI, "src/test/resources/sample/sample_check2.yaml");
         params.setProperty(OpenAPIDocCheckModel.ARG_CHECK_SCHEMA, SampleResult.class.getSimpleName());
         params.setProperty(OpenAPIDocCheckModel.ARG_CHECK_TYPE, SampleResult.class.getName());
         params.setProperty(OpenAPIDocCheckModel.ARG_CHECK_ONCE, BooleanUtils.BOOLEAN_TRUE);
@@ -69,7 +69,7 @@ public void testNoParam() {
     public void testMain() {
         String[] args = {
                 ArgUtils.getArgString(OpenAPIDocMain.ARG_MODE), OpenAPIDocMain.ARG_MODE_CHECK_MODEL,
-                ArgUtils.getArgString(OpenAPIDocMain.ARG_INPUT_YAML), "src/test/resources/sample/sample.yaml",
+                ArgUtils.getArgString(OpenAPIDocMain.ARG_INPUT_OPENAPI), "src/test/resources/sample/sample.yaml",
                 ArgUtils.getArgString(OpenAPIDocCheckModel.ARG_CHECK_SCHEMA), SampleResult.class.getSimpleName(),
                 ArgUtils.getArgString(OpenAPIDocCheckModel.ARG_CHECK_TYPE), SampleResult.class.getName(),
         };