ONC: Add IPAddressConfigType and NameServersConfigType

components/onc/docs/onc_spec.html

Index: components/onc/docs/onc_spec.html
diff --git a/components/onc/docs/onc_spec.html b/components/onc/docs/onc_spec.html
index a5e27ebf91eb18168354db28fd14bc6d0325f298..ff121873b7a82ea8c2f769545b29170b291d19b7 100644
--- a/components/onc/docs/onc_spec.html
+++ b/components/onc/docs/onc_spec.html
@@ -251,6 +251,42 @@
       string.
     </dd>
 
+    <dt class="field">IPAddressConfigType</dt>
+    <dd>
+      <span class="field_meta">
+        (optional if <span class="field">Remove</span> is
+        <span class="value">false</span>, otherwise ignored. Defaults to
+        <span class="value">DHCP</span>)
+        <span class="type">string</span>
+      </span>
+      <span class="rule">
+        <span class="rule_id"></span>
+        Allowed values are <span class="value">DHCP</span> and
+        <span class="value">Static</span>.
+      </span>
+      Determines whether the IP Address configuration is statically configured,
+      see <span class="field">StaticIPConfig</span>, or automatically configured
+      using DHCP.
+    </dd>
+
+    <dt class="field">NameServersConfigType</dt>
+    <dd>
+      <span class="field_meta">
+        (optional if <span class="field">Remove</span> is
+        <span class="value">false</span>, otherwise ignored. Defaults to
+        <span class="value">DHCP</span>)
+        <span class="type">string</span>
+      </span>
+      <span class="rule">
+        <span class="rule_id"></span>
+        Allowed values are <span class="value">DHCP</span> and
+        <span class="value">Static</span>.
+      </span>
+      Determines whether the NameServers configuration is statically configured,
+      see <span class="field">StaticIPConfig</span>, or automatically configured
+      using DHCP.
+    </dd>
+
     <dt class="field">IPConfigs</dt>
     <dd>
       <span class="field_meta">
@@ -263,12 +299,17 @@
     <dt class="field">StaticIPConfig</dt>
     <dd>
       <span class="field_meta">
-        (optional if <span class="field">Remove</span> is
-        <span class="value">false</span>, otherwise ignored)
+        (required if <span class="field">IPAddressConfigType</span> or
+        <span class="field">NameServersConfigType</span> is set to
+        <span class="value">Static</span>)
         <span class="type">IPConfig</span>
       </span>
       Each property set in this IPConfig object overrides the respective
-      parameter received over DHCP.
+      parameter received over DHCP. If either
+      <span class="field">IPAddressConfigType</span> or
+      <span class="field">NameServersConfigType</span> is set to
+      <span class="value">Static</span>, then this must be provided and any
+      non-default values in the object must be specified.

[pneubeck (no reviews), 2015/01/04 11:18:01]

The part 'any non-default values ...' is not clear to me.

Instead we should just mention which parts become required depending on
IPAddressConfigType and depending on NameServersConfigType:

If <span class="field">IPAddressConfigType</span> is set to <span
class="value">Static</span>, the fields <span..>IPAddress</span> and
<span...>Gateway</span> of this object are required.

If <span class="field">NameServersConfigType</span> is set to <span
class="value">Static</span>, the field <span..>NameServers</span> of this object
is required.


Probably this documentation would be simpler if nameservers/ipaddress(/gateway)
wouldn't be mixed into a single object?

[stevenjb, 2015/01/05 21:16:19]

Done.

     </dd>
 
     <dt class="field">SavedIPConfig</dt>
@@ -312,17 +353,6 @@
       Proxy settings for this network
     </dd>
 
-    <dt class="field">NameServers</dt>
-    <dd>
-      <span class="field_meta">
-        (optional if <span class="field">Remove</span> is
-        <span class="value">false</span>, otherwise ignored)
-        <span class="type">array of string</span>
-      </span>
-      Array of addresses to use for name servers. If not specified, DHCP values
-      will be used.
-    </dd>
-
     <dt class="field">SearchDomains</dt>
     <dd>
       <span class="field_meta">