Add types and links

Author: russgold

docs/domains/Domain.json

@@ -56,7 +56,7 @@
       "type": "object",
       "properties": {
         "channelName": {
-          "description": "Name of channel. default\u0027 refers to the admin server\u0027s default channel (configured via the ServerMBean\u0027s ListenPort) \u0027default-secure\u0027 refers to the admin server\u0027s default secure channel (configured via the ServerMBean\u0027s SSLMBean\u0027s ListenPort) \u0027default-admin\u0027 refers to the admin server\u0027s default administrative channel (configured via the DomainMBean\u0027s AdministrationPort) Otherwise, the name is the name of one of the admin server\u0027s network access points (configured via the ServerMBean\u0027s NetworkAccessMBeans).",
+          "description": "Name of channel.\ndefault\u0027 refers to the admin server\u0027s default channel (configured via the ServerMBean\u0027s ListenPort) \n\u0027default-secure\u0027 refers to the admin server\u0027s default secure channel (configured via the ServerMBean\u0027s SSLMBean\u0027s ListenPort) \n\u0027default-admin\u0027 refers to the admin server\u0027s default administrative channel (configured via the DomainMBean\u0027s AdministrationPort) \nOtherwise, the name is the name of one of the admin server\u0027s network access points (configured via the ServerMBean\u0027s NetworkAccessMBeans).",
           "type": "string"
         },
         "nodePort": {

docs/domains/Domain.md

@@ -977,7 +977,7 @@
       "type": "object",
       "properties": {
         "channelName": {
-          "description": "Name of channel. default\u0027 refers to the admin server\u0027s default channel (configured via the ServerMBean\u0027s ListenPort) \u0027default-secure\u0027 refers to the admin server\u0027s default secure channel (configured via the ServerMBean\u0027s SSLMBean\u0027s ListenPort) \u0027default-admin\u0027 refers to the admin server\u0027s default administrative channel (configured via the DomainMBean\u0027s AdministrationPort) Otherwise, the name is the name of one of the admin server\u0027s network access points (configured via the ServerMBean\u0027s NetworkAccessMBeans).",
+          "description": "Name of channel.\ndefault\u0027 refers to the admin server\u0027s default channel (configured via the ServerMBean\u0027s ListenPort) \n\u0027default-secure\u0027 refers to the admin server\u0027s default secure channel (configured via the ServerMBean\u0027s SSLMBean\u0027s ListenPort) \n\u0027default-admin\u0027 refers to the admin server\u0027s default administrative channel (configured via the DomainMBean\u0027s AdministrationPort) \nOtherwise, the name is the name of one of the admin server\u0027s network access points (configured via the ServerMBean\u0027s NetworkAccessMBeans).",
           "type": "string"
         },
         "nodePort": {

docs/domains/index.html

@@ -10,6 +10,7 @@
 import java.net.URL;
 import java.util.Collections;
 import java.util.List;
+import java.util.Map;
 import java.util.Optional;
 import org.apache.maven.plugin.AbstractMojo;
 import org.apache.maven.plugin.MojoExecutionException;
@@ -72,13 +73,20 @@ public void execute() throws MojoExecutionException {
 
     if (updateNeeded(new File(classUrl.getPath()), getSchemaFile())) {
       getLog().info("Changes detected -- generating schema for " + rootClass + ".");
-      main.generateSchema(rootClass, getSchemaFile());
-      if (generateMarkdown) main.generateMarkdown(getMarkdownFile());
+      generate();
     } else {
       getLog().info("Schema up-to-date. Skipping generation.");
     }
   }
 
+  private void generate() throws MojoExecutionException {
+    Map<String, Object> generatedSchema = main.generateSchema(rootClass, getSchemaFile());
+    if (generateMarkdown) {
+      getLog().info(" -- generating markdown for " + rootClass + ".");
+      main.generateMarkdown("Domain", getMarkdownFile(), generatedSchema);
+    }
+  }
+
   private void addExternalSchemas() throws MojoExecutionException {
     try {
       if (kubernetesVersion != null) main.setKubernetesVersion(kubernetesVersion);

docs/domains/k8s1.9.0.md

@@ -7,6 +7,7 @@
 import java.io.File;
 import java.io.IOException;
 import java.net.URL;
+import java.util.Map;
 import org.apache.maven.plugin.MojoExecutionException;
 
 public interface Main {
@@ -75,13 +76,17 @@ public interface Main {
    * @param outputFile the file to generate
    * @throws MojoExecutionException if an exception occurred during the schema generation
    */
-  void generateSchema(String className, File outputFile) throws MojoExecutionException;
+  Map<String, Object> generateSchema(String className, File outputFile)
+      throws MojoExecutionException;
 
   /**
    * Generates markdown for the newly-generated schema to the specified output file.
    *
+   * @param rootName
    * @param outputFile the file to generate
+   * @param schema
    * @throws MojoExecutionException if an exception occurred during the markdown generation
    */
-  void generateMarkdown(File outputFile) throws MojoExecutionException;
+  void generateMarkdown(String rootName, File outputFile, Map<String, Object> schema)
+      throws MojoExecutionException;
 }

json-schema-maven-plugin/src/main/java/oracle/kubernetes/json/mojo/JsonSchemaMojo.java

@@ -17,7 +17,7 @@
 public class MainImpl implements Main {
   private SchemaGenerator generator = new SchemaGenerator();
   private ClassLoader classLoader;
-  private Map<String, Object> schema;
+  private String kubernetesVersion;
 
   @Override
   public void setIncludeDeprecated(boolean includeDeprecated) {
@@ -46,6 +46,7 @@ public URL getResource(String name) {
 
   @Override
   public void setKubernetesVersion(String kubernetesVersion) throws IOException {
+    this.kubernetesVersion = kubernetesVersion;
     generator.useKubernetesVersion(kubernetesVersion);
   }
 
@@ -56,12 +57,14 @@ public void defineSchemaUrlAndContents(URL schemaURL, URL cacheUrl) throws IOExc
 
   @SuppressWarnings("ResultOfMethodCallIgnored")
   @Override
-  public void generateSchema(String className, File outputFile) throws MojoExecutionException {
+  public Map<String, Object> generateSchema(String className, File outputFile)
+      throws MojoExecutionException {
     outputFile.getParentFile().mkdirs();
     try (FileWriter writer = new FileWriter(outputFile)) {
       Class<?> theClass = classLoader.loadClass(className);
-      schema = generator.generate(theClass);
+      Map<String, Object> schema = generator.generate(theClass);
       writer.write(SchemaGenerator.prettyPrint(schema));
+      return schema;
     } catch (IOException e) {
       throw new MojoExecutionException("Error generating schema", e);
     } catch (ClassNotFoundException e) {
@@ -71,11 +74,24 @@ public void generateSchema(String className, File outputFile) throws MojoExecuti
 
   @SuppressWarnings("ResultOfMethodCallIgnored")
   @Override
-  public void generateMarkdown(File outputFile) throws MojoExecutionException {
+  public void generateMarkdown(String rootName, File outputFile, Map<String, Object> schema)
+      throws MojoExecutionException {
     outputFile.getParentFile().mkdirs();
 
+    YamlDocGenerator generator = new YamlDocGenerator(schema);
     try (FileWriter writer = new FileWriter(outputFile)) {
-      writer.write(new YamlDocGenerator(schema).generate("Domain", schema));
+      if (kubernetesVersion != null) generator.useKubernetesVersion(kubernetesVersion);
+      writer.write(generator.generate(rootName));
+    } catch (IOException e) {
+      throw new MojoExecutionException("Error generating markdown", e);
+    }
+
+    String kubernetesSchemaMarkdownFile = generator.getKubernetesSchemaMarkdownFile();
+    if (kubernetesSchemaMarkdownFile == null) return;
+
+    File kubernetesFile = new File(outputFile.getParent(), kubernetesSchemaMarkdownFile);
+    try (FileWriter writer = new FileWriter(kubernetesFile)) {
+      writer.write(generator.getKubernetesSchemaMarkdown());
     } catch (IOException e) {
       throw new MojoExecutionException("Error generating markdown", e);
     }

json-schema-maven-plugin/src/main/java/oracle/kubernetes/json/mojo/Main.java

@@ -11,6 +11,7 @@
 import static org.hamcrest.Matchers.*;
 import static org.objectweb.asm.Opcodes.ASM5;
 
+import com.google.common.collect.ImmutableMap;
 import com.meterware.simplestub.Memento;
 import com.meterware.simplestub.StaticStubSupport;
 import java.io.File;
@@ -302,14 +303,25 @@ public void whenGenerateMarkdownNotSpecified_dontGenerateMarkdown() throws Excep
   }
 
   @Test
-  public void whenGenerateMarkdownSpecified_denerateMarkdown() throws Exception {
+  public void whenGenerateMarkdownSpecified_generateMarkdown() throws Exception {
     setMojoParameter("generateMarkdown", true);
 
     mojo.execute();
 
     assertThat(main.getMarkdownFile(), equalTo(MARKDOWN_FILE));
   }
 
+  @Test
+  public void whenGenerateMarkdownSpecified_useGeneratedSchemaForMarkdown() throws Exception {
+    ImmutableMap<String, Object> generatedSchema = ImmutableMap.of();
+    main.setGeneratedSchema(generatedSchema);
+    setMojoParameter("generateMarkdown", true);
+
+    mojo.execute();
+
+    assertThat(main.getMarkdownSchema(), sameInstance(generatedSchema));
+  }
+
   @Test
   public void whenSchemaMoreRecentThanClassFile_dontGenerateNewSchema() throws Exception {
     fileSystem.defineFileContents(CLASS_FILE, "");

json-schema-maven-plugin/src/main/java/oracle/kubernetes/json/mojo/MainImpl.java

@@ -22,6 +22,8 @@ public class TestMain implements Main {
   private boolean includeAdditionalProperties;
   private boolean supportObjectReferences;
   private File markdownFile;
+  private Map<String, Object> schema;
+  private Map<String, Object> markdownSchema;
 
   TestMain() throws MalformedURLException {
     classpathResource = new URL("file:abc");
@@ -55,6 +57,14 @@ File getMarkdownFile() {
     return markdownFile;
   }
 
+  public Map<String, Object> getMarkdownSchema() {
+    return markdownSchema;
+  }
+
+  void setGeneratedSchema(Map<String, Object> schema) {
+    this.schema = schema;
+  }
+
   URL getCacheFor(URL schemaUrl) {
     return schemas.get(schemaUrl);
   }
@@ -108,13 +118,15 @@ public URL getResource(String name) {
   }
 
   @Override
-  public void generateSchema(String className, File outputFile) {
+  public Map<String, Object> generateSchema(String className, File outputFile) {
     this.className = className;
     this.schemaFile = outputFile;
+    return schema;
   }
 
   @Override
-  public void generateMarkdown(File markdownFile) {
+  public void generateMarkdown(String rootName, File markdownFile, Map<String, Object> schema) {
     this.markdownFile = markdownFile;
+    this.markdownSchema = schema;
   }
 }

json-schema-maven-plugin/src/test/java/oracle/kubernetes/json/mojo/JsonSchemaMojoTest.java

@@ -0,0 +1,45 @@
+// Copyright 2019 Oracle Corporation and/or its affiliates.  All rights reserved.
+// Licensed under the Universal Permissive License v 1.0 as shown at
+// http://oss.oracle.com/licenses/upl.
+
+package oracle.kubernetes.json;
+
+import java.net.MalformedURLException;
+import java.net.URL;
+
+public class KubernetesSchemaReference {
+  private static final String K8S_SCHEMA_URL =
+      "https://github.com/garethr/kubernetes-json-schema/blob/master/v%s/_definitions.json";
+  private static final String K8S_SCHEMA_CACHE = "caches/kubernetes-%s.json";
+  private static final String K8S_MARKDOWN_LINK = "k8s%s.md";
+
+  private String version;
+
+  private KubernetesSchemaReference(String version) {
+    this.version = version;
+  }
+
+  public static KubernetesSchemaReference create(String version) {
+    return new KubernetesSchemaReference(version);
+  }
+
+  URL getKubernetesSchemaUrl() throws MalformedURLException {
+    return new URL(getUrlString());
+  }
+
+  private String getUrlString() {
+    return String.format(K8S_SCHEMA_URL, version);
+  }
+
+  boolean matchesUrl(String url) {
+    return url.equals(getUrlString());
+  }
+
+  public URL getKubernetesSchemaCacheUrl() {
+    return KubernetesSchemaReference.class.getResource(String.format(K8S_SCHEMA_CACHE, version));
+  }
+
+  String getK8sMarkdownLink() {
+    return String.format(K8S_MARKDOWN_LINK, version);
+  }
+}