MINOR: spec: improve command example

haproxytech · Jan 11, 2023 · 6832951 · 6832951
1 parent 2acc069
commit 6832951
Show file tree

Hide file tree

Showing 15 changed files with 34 additions and 77 deletions.
diff --git a/models/bind.go b/models/bind.go
diff --git a/models/bind_params.go b/models/bind_params.go
diff --git a/models/fcgi_app.go b/models/fcgi_app.go
diff --git a/models/http_error_rule.go b/models/http_error_rule.go
diff --git a/models/program.go b/models/program.go
diff --git a/models/server.go b/models/server.go
diff --git a/models/site.go b/models/site.go
diff --git a/specification/build/haproxy_spec.yaml b/specification/build/haproxy_spec.yaml
@@ -31,7 +31,6 @@ definitions:
               type: string
           name:
               pattern: ^[A-Za-z0-9-_.:]+$
-              readOnly: true
               type: string
               x-nullable: false
           start-on-reload:
@@ -92,7 +91,6 @@ definitions:
           name:
               description: Declares a FastCGI application
               pattern: ^[^\s]+$
-              readOnly: true
               type: string
               x-nullable: false
           pass_headers:
@@ -214,10 +212,6 @@ definitions:
       type: object
   bind_params:
       additionalProperties: false
-      example:
-          address: 127.0.0.1
-          name: http
-          port: 80
       properties:
           accept_netscaler_cip:
               type: integer
@@ -322,8 +316,10 @@ definitions:
                   - user
                   - operator
                   - admin
+              example: user
               type: string
           maxconn:
+              example: 1234
               type: integer
           mode:
               type: string
@@ -334,8 +330,10 @@ definitions:
               type: string
               x-nullable: false
           namespace:
+              example: app
               type: string
           nice:
+              example: 1
               type: integer
           no_ca_names:
               type: boolean
@@ -387,6 +385,7 @@ definitions:
                   - none
                   - number
                   - string
+              example: none
               type: string
               x-display-name: Format
           ssl:
@@ -447,6 +446,7 @@ definitions:
                   - none
                   - optional
                   - required
+              example: none
               type: string
               x-dependency:
                   ssl:
@@ -867,22 +867,13 @@ definitions:
                   - address: 127.0.1.1
                     name: www_server
                     port: 4567
-                    weight: 30
                   - address: 127.0.1.2
                     name: www_server_new
                     port: 4567
-                    weight: 70
                 use_as: default
           name: test_site
           service:
               http_connection_mode: httpclose
-              listeners:
-                  - address: 127.0.0.1
-                    name: test_listener
-                    port: 80
-                  - address: 127.0.0.1
-                    name: test_listener_2
-                    port: 8080
               maxconn: 2000
               mode: http
       properties:
@@ -3304,19 +3295,23 @@ definitions:
     items:
       $ref: "#/definitions/http_errors_section"
   bind:
+      additionalProperties: false
       allOf:
           - $ref: '#/definitions/bind_params'
       description: HAProxy frontend bind configuration
       properties:
           address:
+              example: 127.0.0.1
               pattern: ^[^\s]+$
               type: string
           port:
+              example: 80
               maximum: 65535
               minimum: 1
               type: integer
               x-nullable: true
           port-range-end:
+              example: 81
               maximum: 65535
               minimum: 1
               type: integer
@@ -3336,10 +3331,8 @@ definitions:
       description: HAProxy backend server configuration
       example:
           address: 10.1.1.1
-          check: enabled
           name: www
           port: 8080
-          weight: 80
       properties:
           address:
               pattern: ^[^\s]+$
@@ -4797,8 +4790,6 @@ definitions:
       additionalProperties: false
       description: HAProxy HTTP error rule configuration (corresponds to http-error directives)
       example:
-          hdr_format: '%T'
-          hdr_name: X-Haproxy-Current-Date
           index: 0
           status: 425
           type: status

diff --git a/specification/models/configuration/bind.yaml b/specification/models/configuration/bind.yaml
@@ -7,18 +7,22 @@ bind:
     address:
       type: string
       pattern: '^[^\s]+$'
+      example: 127.0.0.1
     port:
       maximum: 65535
       minimum: 1
       type: integer
       x-nullable: true
+      example: 80
     port-range-end:
       maximum: 65535
       minimum: 1
       type: integer
       x-nullable: true
+      example: 81
   allOf:
     - $ref: '#/definitions/bind_params'
+  additionalProperties: false
 default_bind:
   title: Default Bind
   description: HAProxy default bind configuration

diff --git a/specification/models/configuration/bind_params.yaml b/specification/models/configuration/bind_params.yaml
@@ -107,12 +107,15 @@ bind_params:
     level:
       type: string
       enum: [user, operator, admin]
+      example: user
     severity_output:
       type: string
       x-display-name: Format
       enum: [none, number, string]
+      example: none
     maxconn:
       type: integer
+      example: 1234
     mode:
       type: string
     mss:
@@ -123,8 +126,10 @@ bind_params:
       x-nullable: false
     namespace:
       type: string
+      example: app
     nice:
       type: integer
+      example: 1
     no_ca_names:
       type: boolean
       x-dependency:
@@ -219,8 +224,5 @@ bind_params:
       x-dependency:
         ssl:
           value: enabled
+      example: none
   additionalProperties: false
-  example:
-    name: http
-    address: 127.0.0.1
-    port: 80
diff --git a/specification/models/configuration/fcgi.yaml b/specification/models/configuration/fcgi.yaml
@@ -12,7 +12,6 @@ app:
       pattern: '^[^\s]+$'
       x-nullable: false
       description: Declares a FastCGI application
-      readOnly: true
     docroot:
       type: string
       description: Defines the document root on the remote host. The parameter serves to build the default value of FastCGI parameters SCRIPT_FILENAME and PATH_TRANSLATED. It is a mandatory setting.

diff --git a/specification/models/configuration/http/error.yaml b/specification/models/configuration/http/error.yaml
@@ -57,5 +57,3 @@ http_error_rule:
     index: 0
     type: status
     status: 425
-    hdr_name: X-Haproxy-Current-Date
-    hdr_format: "%T"
diff --git a/specification/models/configuration/program.yaml b/specification/models/configuration/program.yaml
@@ -11,7 +11,6 @@ program:
       type: string
       pattern: '^[A-Za-z0-9-_.:]+$'
       x-nullable: false
-      readOnly: true
     command:
       type: string
       description: The command to be run, with flags and options.
@@ -30,4 +29,4 @@ program:
     command: spoa-mirror --runtime 0 --mirror-url http://test.local
     user: myusername
     group: mygroupname
-    start-on-reload: enabled
+    start-on-reload: enabled
diff --git a/specification/models/configuration/server.yaml b/specification/models/configuration/server.yaml
@@ -30,8 +30,6 @@ server:
     name: www
     address: 10.1.1.1
     port: 8080
-    check: enabled
-    weight: 80
 server_template:
   title: Server template
   description: Set a template to initialize servers with shared parameters.