ucentral-schema: uc-example->example

Signed-off-by: John Crispin <[email protected]>
blogic · May 3, 2021 · 21c6ebe · 21c6ebe
1 parent 66b6f34
commit 21c6ebe
Show file tree

Hide file tree

Showing 15 changed files with 92 additions and 53 deletions.
diff --git a/new/globals.yml b/new/globals.yml
@@ -8,10 +8,12 @@ properties:
       Define the IPv4 range that is delegatable to the downstream interfaces
       This is described as a CIDR block. (192.168.0.0/16, 172.16.128/17)
     type: string
-    uc-example: 192.168.0.0/16
+    example:
+    - 192.168.0.0/16
   ipv6-network:
     description:
       Define the IPv6 range that is delegatable to the downstream interfaces
       This is described as a CIDR block. (fdca:1234:4567::/48)
     type: string
-    uc-example: fdca:1234:4567::/48
+    example:
+    - fdca:1234:4567::/48
diff --git a/new/interface.bridge.yml b/new/interface.bridge.yml
@@ -8,14 +8,16 @@ properties:
     type: number
     maximum: 65535
     minimum: 256
-    uc-example: 1500
+    example:
+    - 1500
   tx-queue-len:
     description:
       The Transmit Queue Length is a TCP/IP stack network interface value that
       sets the number of packets allowed per kernel transmit queue of a network
       interface device.
     type: number
-    uc-example: 5000
+    example:
+    - 5000
   isolate-ports:
     description:
       Isolates the bridge ports from each other.

diff --git a/new/interface.ethernet.yml b/new/interface.ethernet.yml
@@ -12,9 +12,9 @@ properties:
     type: array
     items:
       type: string
-    uc-example:
-      - LAN1
-      - LAN2*
+    example:
+    - LAN1
+    - LAN2*
   multicast:
     description:
       Enable multicast support.
@@ -38,7 +38,8 @@ properties:
     type: string
     maxLength: 17
     minLength: 17
-    uc-example: true
+    example:
+    - true
   reverse-path-filter:
     description:
       Reverse Path filtering is a method used by the Linux Kernel to help

diff --git a/new/interface.ipv4.dhcp-lease.yml b/new/interface.ipv4.dhcp-lease.yml
@@ -8,13 +8,15 @@ properties:
     type: string
     maxLength: 17
     minLength: 17
-    uc-example: 00:11:22:33:44:55
+    example:
+    - 00:11:22:33:44:55
   static-lease-offset:
     description:
       The offset of the IP that shall be used in relation to the first IP
       in the available range.
     type: number
-    uc-example: 10
+    example:
+    - 10
   lease-time:
     description:
       How long the lease is valid before a RENEW muss ne issued.

diff --git a/new/interface.ipv4.yml b/new/interface.ipv4.yml
@@ -10,35 +10,39 @@ properties:
     enum:
       - dynamic
       - static
-    uc-example: static
+    example:
+    - static
   subnet:
     description:
       This option defines the static IPv4 of the logical interface in CIDR notation.
       auto/24 can be used, causing the configuration layer to automatically use
       and address range from globals.ipv4-network.
     type: string
-    uc-example: auto/24
+    example:
+    - auto/24
   gateway:
     description:
       This option defines the static IPv4 gateway of the logical interface.
     type: string
-    uc-example: 192.168.1.1
+    example:
+    - 192.168.1.1
   send-hostname:
     description:
       include the devices hostname inside DHCP requests
     type: boolean
     default: true
-    uc-example: true
+    example:
+    - true
   use-dns:
     description:
       Define which DNS servers shall be used. This can either be a list of
       static IPv4 addresse or dhcp (use the server provided by the DHCP lease)
     type: array
     items:
       type: string
-    uc-example:
-      - 8.8.8.8
-      - 4.4.4.4
+    example:
+    - 8.8.8.8
+    - 4.4.4.4
   dhcp-leases:
     type: array
     items:

diff --git a/new/interface.ssid.captive.yml b/new/interface.ssid.captive.yml
@@ -16,24 +16,29 @@ properties:
     description:
       The maximum number of clients that shall be accept.
     type: number
-    uc-example: 32
+    example:
+    - 32
   upload-rate:
     description:
       The maximum upload rate for a specific client.
     type: number
-    uc-example: 10000
+    example:
+    - 10000
   download-rate:
     description:
       The maximum download rate for a specific client.
     type: number
-    uc-example: 10000
+    example:
+    - 10000
   upload-quota:
     description:
       The maximum upload quota for a specific client.
     type: number
-    uc-example: 10000
+    example:
+    - 10000
   download-quota:
     description:
       The maximum download quota for a specific client.
     type: number
-    uc-example: 10000
+    example:
+    - 10000
diff --git a/new/interface.ssid.encryption.yml b/new/interface.ssid.encryption.yml
@@ -19,19 +19,22 @@ properties:
     - sae-mixed
     - wpa3
     - wpa3-mixed
-    uc-example: psk2
+    example:
+    - psk2
   key:
     description:
       The Pre Shared Key (PSK) that is used for encryption on the BSS when
       using any of the WPA-PSK modes.
     type: string
     maxLength: 63
     minLength: 8
-    uc-example: aaaaaaaa
-  80211w:
+    example:
+    - aaaaaaaa
+  ieee80211w:
     description:
       Enable 802.11w Management Frame Protection (MFP) for this BSS.
     type: number
     maximum: 2
     minimum: 0
-    uc-example: 2
+    example:
+    - 2
diff --git a/new/interface.ssid.radius.local-user.yml b/new/interface.ssid.radius.local-user.yml
@@ -6,13 +6,16 @@ properties:
     type: string
     maxLength: 17
     minLength: 17
-    uc-example: 00:11:22:33:44:55
+    example:
+    - 00:11:22:33:44:55
   key:
     type: string
     maxLength: 63
     minLength: 8
-    uc-example: aaaaaaaa
+    example:
+    - aaaaaaaa
   vid:
     type: number
     maximum: 4096
-    uc-example: 100
+    example:
+    - 100
diff --git a/new/interface.ssid.radius.server.yml b/new/interface.ssid.radius.server.yml
@@ -6,27 +6,30 @@ properties:
     description:
        The URI of our Radius server.
     type: string
-    uc-example: 192.168.1.10
+    example:
+    - 192.168.1.10
   port:
     description:
        The network of our Radius server.
     type: number
     maximum: 65535
     minimum: 1024
-    uc-example: 1812
+    example:
+    - 1812
   secret:
     description:
       The shared Radius authentication secret.
     type: string
-    uc-example: secret
+    example:
+    - secret
   request-attribute:
     description:
       The additional Access-Request attributes that gets sent to the server.
     type: array
     items:
       type: string
-    uc-example:
-      - 126:s:Operator
+    example:
+    - 126:s:Operator
   request-cui:
     description:
       This will enable support for Chargeable-User-Identity (RFC 4372).

diff --git a/new/interface.ssid.roaming.yml b/new/interface.ssid.roaming.yml
@@ -10,15 +10,18 @@ properties:
     enum:
     - air
     - ds
-    uc-example: ds
+    example:
+    - ds
   generate-psk:
     description:
       Whether to generate FT response locally for PSK networks. This avoids
       use of PMK-R1 push/pull from other APs with FT-PSK networks.
     type: boolean
-    uc-example: true
+    example:
+    - true
   domain-identifier:
     description:
       Mobility Domain identifier (dot11FTMobilityDomainID, MDID).
     type: string
-    uc-example: abcd
+    example:
+    - abcd
diff --git a/new/interface.yml b/new/interface.yml
@@ -9,39 +9,43 @@ properties:
       This is a free text field, stating the administrative name of the
       interface. It may contain spaces and special characters.
     type: string
-    uc-example: LAN
+    example:
+    - LAN
   role:
     description:
       The role defines if the interface is upstream or downstream facing.
     type: string
     enum:
       - upstream
       - downstream
-    uc-example: downstream
+    example:
+    - downstream
   isolate-hosts:
     description:
       This option makes sure that any traffic leaving this interface is isolated
       and all local IP ranges are blocked. It essentially enforces "guest network"
       firewall settings.
     type: boolean
-    uc-example: false
+    example:
+    - false
   metric:
     description:
       The routing metric of this logical interface. Lower values have higher
       priority.
     type: boolean
     default: 10
-    uc-example: 10
+    example:
+    - 10
   services:
     description:
       The services that shall be offered on this logical interface. These are
       just strings such as "ssh", "lldp", "mdns"
     type: array
     items:
       type: string
-    uc-example:
-      - ssh
-      - lldp
+    example:
+    - ssh
+    - lldp
   vlan:
     $ref: "https://ucentral.io/schema/v1/interface/vlan/"
   bridge:

diff --git a/new/service.log.yml b/new/service.log.yml
@@ -7,14 +7,16 @@ properties:
       IP address of a syslog server to which the log messages should be
       sent in addition to the local destination.
     type: string
-    uc-example: 192.168.1.10
+    example:
+    - 192.168.1.10
   port:
     description:
       Port number of the remote syslog server specified with log_ip.
     type: number
     maximum: 65535
     minimum: 100
-    uc-example: 2000
+    example:
+    - 2000
   proto:
     description:
       Sets the protocol to use for the connection, either tcp or udp.

diff --git a/new/service.ntp.yml b/new/service.ntp.yml
@@ -9,5 +9,5 @@ properties:
     type: array
     items:
       type: string
-    uc-example:
-      - 0.openwrt.pool.ntp.org
+    example:
+    - 0.openwrt.pool.ntp.org
diff --git a/new/service.rtty.yml b/new/service.rtty.yml
@@ -6,7 +6,8 @@ properties:
     description:
       The server that the AP shal to connect to.
     type: string
-    uc-example: 192.168.1.10
+    example:
+    - 192.168.1.10
   port:
     description:
       This option defines the port that we connect to.
@@ -19,4 +20,5 @@ properties:
     type: string
     maxLength: 17
     minLength: 17
-    uc-example: 01234567890123456789012345678901
+    example:
+    - 01234567890123456789012345678901
diff --git a/new/service.wifi-steering.yml b/new/service.wifi-steering.yml
@@ -9,15 +9,18 @@ mode:
     enum:
       - local
       - cloud
-    uc-example: local
+    example:
+    - local
 network:
     description:
       The network that shall be used to communicate with the other peers.
     type: string
-    uc-example: upstream
+    example:
+    - upstream
 key:
     description:
       The pre-shared crypto key that units in the cluster use to secure the
       communication
     type: string
-    uc-example: secret
+    example:
+    - secret