Address missing types

Author: russgold

docs/domains/Domain.md

@@ -19,7 +19,7 @@ DomainSpec is a description of a domain.
 | adminServer | [Admin Server](#admin-server) | Configuration for the admin server. |
 | clusters | array of [Cluster](#cluster) | Configuration for the clusters. |
 | configOverrides | string | The name of the config map for optional WebLogic configuration overrides. |
-| configOverrideSecrets | array of  | A list of names of the secrets for optional WebLogic configuration overrides. |
+| configOverrideSecrets | array of string | A list of names of the secrets for optional WebLogic configuration overrides. |
 | domainHome | string | The folder for the Weblogic Domain. Not required. Defaults to /shared/domains/domains/domainUID if domainHomeInImage is false Defaults to /u01/oracle/user_projects/domains/ if domainHomeInImage is true |
 | domainHomeInImage | boolean | True if this domain's home is defined in the docker image for the domain. Defaults to true. |
 | domainUID | string | Domain unique identifier. Must be unique across the Kubernetes cluster. Not required. Defaults to the value of metadata.name |
@@ -49,7 +49,7 @@ DomainStatus represents information about the status of a domain. Status may tra
 | reason | string | A brief CamelCase message indicating details about why the domain is in this state. |
 | replicas | number | The number of running managed servers in the WebLogic cluster if there is only one cluster in the domain and where the cluster does not explicitly configure its replicas in a cluster specification. |
 | servers | array of [Server Status](#server-status) | Status of WebLogic servers in this domain. |
-| startTime |  | RFC 3339 date and time at which the operator started the domain. This will be when the operator begins processing and will precede when the various servers or clusters are available. |
+| startTime | DateTime | RFC 3339 date and time at which the operator started the domain. This will be when the operator begins processing and will precede when the various servers or clusters are available. |
 
 ### Admin Server
 
@@ -99,12 +99,12 @@ ServerPod describes the configuration for a Kubernetes pod for a server.
 
 | Name | Type | Description |
 | --- | --- | --- |
-| annotations |  | The annotations to be attached to generated resources. |
+| annotations | Map | The annotations to be attached to generated resources. |
 | containerSecurityContext | [Security Context](k8s1.9.0.md#security-context) | Container-level security attributes. Will override any matching pod-level attributes. |
 | env | array of [Env Var](k8s1.9.0.md#env-var) | A list of environment variables to add to a server |
-| labels |  | The labels to be attached to generated resources. The label names must not start with 'weblogic.'. |
+| labels | Map | The labels to be attached to generated resources. The label names must not start with 'weblogic.'. |
 | livenessProbe | [Probe Tuning](#probe-tuning) | Settings for the liveness probe associated with a server. |
-| nodeSelector |  | Selector which must match a node's labels for the pod to be scheduled on that node. |
+| nodeSelector | Map | Selector which must match a node's labels for the pod to be scheduled on that node. |
 | podSecurityContext | [Pod Security Context](k8s1.9.0.md#pod-security-context) | Pod-level security attributes. |
 | readinessProbe | [Probe Tuning](#probe-tuning) | Settings for the readiness probe associated with a server. |
 | resources | [Resource Requirements](k8s1.9.0.md#resource-requirements) | Memory and cpu minimum requirements and limits for the server. |
@@ -115,15 +115,15 @@ ServerPod describes the configuration for a Kubernetes pod for a server.
 
 | Name | Type | Description |
 | --- | --- | --- |
-| annotations |  | The annotations to be attached to generated resources. |
-| labels |  | The labels to be attached to generated resources. The label names must not start with 'weblogic.'. |
+| annotations | Map | The annotations to be attached to generated resources. |
+| labels | Map | The labels to be attached to generated resources. The label names must not start with 'weblogic.'. |
 
 ### Domain Condition
 
 | Name | Type | Description |
 | --- | --- | --- |
-| lastProbeTime |  | Last time we probed the condition. |
-| lastTransitionTime |  | Last time the condition transitioned from one status to another. |
+| lastProbeTime | DateTime | Last time we probed the condition. |
+| lastTransitionTime | DateTime | Last time the condition transitioned from one status to another. |
 | message | string | Human-readable message indicating details about last transition. |
 | reason | string | Unique, one-word, CamelCase reason for the condition's last transition. |
 | status | string | Status is the status of the condition. Can be True, False, Unknown. Required |
@@ -139,22 +139,12 @@ ServerPod describes the configuration for a Kubernetes pod for a server.
 | serverName | string | WebLogic server name. Required |
 | state | string | Current state of this WebLogic server. Required |
 
-### Date Time
-
-| Name | Type | Description |
-| --- | --- | --- |
-
 ### Admin Service
 
 | Name | Type | Description |
 | --- | --- | --- |
 | channels | array of [Channel](#channel) | Specifies which of the admin server's WebLogic channels should be exposed outside the Kubernetes cluster via a node port service, along with the node port for each channel. If not specified, the admin server's node port service will not be created. |
 
-### Map
-
-| Name | Type | Description |
-| --- | --- | --- |
-
 ### Probe Tuning
 
 | Name | Type | Description |
@@ -167,7 +157,7 @@ ServerPod describes the configuration for a Kubernetes pod for a server.
 
 | Name | Type | Description |
 | --- | --- | --- |
-| activationTime |  | RFC 3339 date and time at which the server started. |
+| activationTime | DateTime | RFC 3339 date and time at which the server started. |
 | overallHealth | string | Server health of this WebLogic server. |
 | subsystems | array of [Subsystem Health](#subsystem-health) | Status of unhealthy subsystems, if any. |
 
@@ -186,4 +176,4 @@ Describes a single channel used by the admin server.
 | --- | --- | --- |
 | health | string | Server health of this WebLogic server. Required |
 | subsystemName | string | Name of subsystem providing symptom information. Required |
-| symptoms | array of  | Symptoms provided by the reporting subsystem. |
+| symptoms | array of string | Symptoms provided by the reporting subsystem. |

docs/domains/k8s1.9.0.md

@@ -14,7 +14,7 @@ ObjectMeta is metadata that all persisted resources must have, which includes al
 | creationTimestamp | [Time](#time) | CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.<br/><br/>Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
 | deletionGracePeriodSeconds |  | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. |
 | deletionTimestamp | [Time](#time) | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.<br/><br/>Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
-| finalizers | array of  | Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. |
+| finalizers | array of string | Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. |
 | generateName | string | GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.<br/><br/>If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).<br/><br/>Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
 | generation |  | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. |
 | initializers | [Initializers](#initializers) | An initializer is a controller which enforces some system invariant at object creation time. This field is a list of initializers that have not yet acted on this object. If nil or empty, this object has been completely initialized. Otherwise, the object is considered uninitialized and is hidden (in list/watch and get calls) from clients that haven't explicitly asked to observe uninitialized objects.<br/><br/>When an object is created, the system will populate this list with the current set of initializers. Only privileged users may set or modify this list. Once it is empty, it may not be modified further by any user. |

json-schema/src/main/java/oracle/kubernetes/json/YamlDocGenerator.java

@@ -7,6 +7,7 @@
 import java.io.IOException;
 import java.net.URL;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.List;
@@ -146,16 +147,20 @@ String getString() {
         case "string":
           return specifiedType;
         case "array":
-          return "array of " + getReference();
+          Type subType = getItems();
+          return "array of " + subType.getString();
         default:
           return getReference();
       }
     }
 
+    private Type getItems() {
+      return new Type((Map<String, Object>) fieldMap.get("items"));
+    }
+
     private String getReference() {
       Reference reference = createReference(getReferenceString());
-      if (!reference.shouldGenerateReference()) return "";
-      return String.format("[%s](%s)", reference.getStructureName(), reference.getLink());
+      return reference.getString();
     }
 
     private String getReferenceString() {
@@ -186,6 +191,10 @@ private Reference(String typeName) {
       this.typeName = typeName;
     }
 
+    String getString() {
+      return String.format("[%s](%s)", getStructureName(), getLink());
+    }
+
     String getTypeName() {
       return typeName;
     }
@@ -199,8 +208,6 @@ private String getStructureName() {
       return toStructureName(typeName);
     }
 
-    abstract boolean shouldGenerateReference();
-
     abstract boolean isLocal();
   }
 
@@ -215,8 +222,8 @@ boolean isLocal() {
     }
 
     @Override
-    boolean shouldGenerateReference() {
-      return false;
+    String getString() {
+      return "";
     }
   }
 
@@ -225,11 +232,13 @@ private static String toLocalTypeName(String ref) {
     return typeName.substring(typeName.lastIndexOf(".") + 1);
   }
 
+  private static List NON_REFERENCE_TYPES = Arrays.asList("Map", "DateTime");
+
   private class LocalReference extends Reference {
 
     LocalReference(String ref) {
       super(toLocalTypeName(ref));
-      addReferenceIfNeeded(getTypeName());
+      if (isReferenceType()) addReferenceIfNeeded(getTypeName());
     }
 
     @Override
@@ -238,8 +247,13 @@ boolean isLocal() {
     }
 
     @Override
-    boolean shouldGenerateReference() {
-      return !(getTypeName().equals("DateTime")) && !(getTypeName().equals("Map"));
+    String getString() {
+      if (isReferenceType()) return super.getString();
+      else return getTypeName();
+    }
+
+    private boolean isReferenceType() {
+      return !NON_REFERENCE_TYPES.contains(getTypeName());
     }
   }
 
@@ -261,11 +275,6 @@ boolean isLocal() {
       return false;
     }
 
-    @Override
-    boolean shouldGenerateReference() {
-      return true;
-    }
-
     @Override
     String getLink() {
       return getKubernetesSchemaLink() + super.getLink();

json-schema/src/test/java/oracle/kubernetes/json/YamlDocGeneratorTest.java

@@ -12,6 +12,7 @@
 import java.io.IOException;
 import java.lang.reflect.Field;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 import org.joda.time.DateTime;
 import org.junit.Test;
@@ -50,7 +51,7 @@ private Map<String, Object> generateSchemaForField(Field field) {
   @Test
   public void whenPropertyTypeIsDateTime_doNotGenerateReference() throws NoSuchFieldException {
     String markdown = generateForProperty(getClass().getDeclaredField("dateTime"));
-    assertThat(markdown, containsString(tableEntry("dateTime", "")));
+    assertThat(markdown, containsString(tableEntry("dateTime", "DateTime", "")));
   }
 
   @SuppressWarnings("unused")
@@ -59,12 +60,21 @@ public void whenPropertyTypeIsDateTime_doNotGenerateReference() throws NoSuchFie
   @Test
   public void whenPropertyTypeIsMap_doNotGenerateReference() throws NoSuchFieldException {
     String markdown = generateForProperty(getClass().getDeclaredField("notes"));
-    assertThat(markdown, containsString(tableEntry("notes", "")));
+    assertThat(markdown, containsString(tableEntry("notes", "Map", "")));
   }
 
   @SuppressWarnings("unused")
   private Map<String, String> notes;
 
+  @Test
+  public void whenPropertyTypeIsArrayOfStrings_generateType() throws NoSuchFieldException {
+    String markdown = generateForProperty(getClass().getDeclaredField("myList"));
+    assertThat(markdown, containsString(tableEntry("myList", "array of string", "")));
+  }
+
+  @SuppressWarnings("unused")
+  private List<String> myList;
+
   @Test
   public void whenPropertyTypeIsReferenceWithDescription_includeBoth() throws NoSuchFieldException {
     String markdown = generateForProperty(getClass().getDeclaredField("simpleUsage"));
@@ -283,6 +293,4 @@ public void whenExternalSchemaSpecified_generateMarkdownForItsDependencies() thr
         generator.getKubernetesSchemaMarkdown(),
         containsString(String.join("\n", "### Env Var Source")));
   }
-
-  // todo description for objects
 }