add version api

Author: hauner

src/main/java/io/openapiprocessor/api/v2/OpenApiProcessor.java

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2023 https://github.com/openapi-processor/openapi-processor-api
+ * PDX-License-Identifier: Apache-2.0
+ */
+
+package io.openapiprocessor.api.v2;
+
+import java.util.Map;
+
+/**
+ * To make an openapi-processor available to a consumer (for example the openapi-processor-gradle
+ * plugin) it must implement this interface and have a
+ * {@code META-INF/services/io.openapiprocessor.api.v1.OpenApiProcessor} property file in the
+ * resources with the class name of the implementing class.
+ *
+ * <p>
+ * A consumer should be able to provide access to any processor that is found on the class path.
+ *
+ * The gradle plugin uses the name provided by the api to configure the processor and to provide a
+ * task to run it. This task will find and run an openapi-processor by using the
+ * {@code OpenApiProcessor} service interface. By using an interface it does not need an explicit
+ * dependency on a processor.
+ */
+public interface OpenApiProcessor {
+
+    /**
+     * The identifying name of the openapi-processor. *Should* be globally unique so a consumer of
+     * this interface can distinguish between different openapi-processors.
+     *
+     * <p>
+     * It is recommended to return here the last part of the full openapi-processor name. If the
+     * processor jar name is {@code openapi-processor-spring} the name should be {@code spring}.
+     * </p>
+     *
+     * @return the unique name of the openapi-processor
+     */
+    String getName();
+
+    /**
+     * Runs the openapi-processor with the given options. The options are key value pairs. Keys are
+     * of type {@code String} and values are of any type. A property hierarchy is possible by using
+     * {@code Map}s as value.
+     *
+     * @param options the openapi-processor configuration
+     */
+    void run(Map<String, ?> options);
+
+}

src/main/java/io/openapiprocessor/api/v2/OpenApiProcessorVersion.java

@@ -0,0 +1,31 @@
+/*
+ * Copyright 2023 https://github.com/openapi-processor/openapi-processor-api
+ * PDX-License-Identifier: Apache-2.0
+ */
+
+package io.openapiprocessor.api.v2;
+
+public interface OpenApiProcessorVersion {
+
+    /**
+     * The version of this openapi-processor.
+     *
+     * @return the version of this processor
+     */
+    String getVersion();
+
+    /**
+     * The latest available version of this openapi-processor.
+     *
+     * @return the latest version of this processor
+     */
+    Version getLatestVersion();
+
+    /**
+     * checks if there is newer version of this processor.
+     *
+     * @return true if there is a newer version, else false
+     */
+
+    boolean hasNewerVersion();
+}

src/main/java/io/openapiprocessor/api/v2/Version.java

@@ -0,0 +1,14 @@
+/*
+ * Copyright 2023 https://github.com/openapi-processor/openapi-processor-api
+ * PDX-License-Identifier: Apache-2.0
+ */
+
+package io.openapiprocessor.api.v2;
+
+import java.time.Instant;
+
+public interface Version {
+    String getName();
+    Instant getPublishedAt();
+    String getText();
+}