MEDIUM: remove defaults and rename named_defaults

haproxytech · Feb 16, 2024 · 63319b0 · 63319b0
1 parent fe640f8
commit 63319b0
Show file tree

Hide file tree

Showing 9 changed files with 117 additions and 425 deletions.
diff --git a/specification/build/haproxy_spec.yaml b/specification/build/haproxy_spec.yaml
@@ -11228,60 +11228,6 @@ paths:
           tags:
               - Global
   /services/haproxy/configuration/defaults:
-      get:
-          deprecated: true
-          description: Returns defaults part of configuration, this has been deprecated, use named_defaults instead.
-          operationId: getDefaults
-          parameters:
-              - $ref: '#/parameters/transaction_id'
-          responses:
-              "200":
-                  description: Successful operation
-                  headers:
-                      Configuration-Version:
-                          description: Configuration file version
-                          type: string
-                  schema:
-                      $ref: '#/definitions/defaults'
-              default:
-                  $ref: '#/responses/DefaultError'
-          summary: Return defaults part of configuration
-          tags:
-              - Defaults
-      put:
-          deprecated: true
-          description: Replace defaults part of config, this has been deprecated, use named_defaults instead.
-          operationId: replaceDefaults
-          parameters:
-              - in: body
-                name: data
-                required: true
-                schema:
-                  $ref: '#/definitions/defaults'
-              - $ref: '#/parameters/transaction_id'
-              - $ref: '#/parameters/version'
-              - $ref: '#/parameters/force_reload'
-          responses:
-              "200":
-                  description: Defaults replaced
-                  schema:
-                      $ref: '#/definitions/defaults'
-              "202":
-                  description: Configuration change accepted and reload requested
-                  headers:
-                      Reload-ID:
-                          description: ID of the requested reload
-                          type: string
-                  schema:
-                      $ref: '#/definitions/defaults'
-              "400":
-                  $ref: '#/responses/BadRequest'
-              default:
-                  $ref: '#/responses/DefaultError'
-          summary: Replace defaults
-          tags:
-              - Defaults
-  /services/haproxy/configuration/named_defaults:
       get:
           description: Returns an array of all configured defaults.
           operationId: getDefaultsSections
@@ -11301,7 +11247,7 @@ paths:
           summary: Return an array of defaults
           tags:
               - Defaults
-      post:
+      put:
           description: Adds a new defaults section to the configuration file.
           operationId: createDefaultsSection
           parameters:
@@ -11335,7 +11281,7 @@ paths:
           summary: Add a defaults section
           tags:
               - Defaults
-  /services/haproxy/configuration/named_defaults/{name}:
+  /services/haproxy/configuration/defaults/{name}:
       delete:
           description: Deletes a defaults section from the configuration by it's name.
           operationId: deleteDefaultsSection

diff --git a/specification/haproxy-spec.yaml b/specification/haproxy-spec.yaml
@@ -788,10 +788,8 @@ paths:
     $ref: "paths/configuration/global.yaml#/global"
   /services/haproxy/configuration/defaults:
     $ref: "paths/configuration/defaults.yaml#/defaults"
-  /services/haproxy/configuration/named_defaults:
-    $ref: "paths/configuration/named_defaults.yaml#/defaults"
-  /services/haproxy/configuration/named_defaults/{name}:
-    $ref: "paths/configuration/named_defaults.yaml#/defaults_one"
+  /services/haproxy/configuration/defaults/{name}:
+    $ref: "paths/configuration/defaults.yaml#/defaults_one"
   /services/haproxy/configuration/frontends:
     $ref: "paths/configuration/frontend.yaml#/frontends"
   /services/haproxy/configuration/frontends/{name}:

diff --git a/specification/paths/configuration/defaults.yaml b/specification/paths/configuration/defaults.yaml
@@ -1,10 +1,9 @@
 ---
 defaults:
   get:
-    deprecated: true
-    summary: Return defaults part of configuration
-    description: Returns defaults part of configuration, this has been deprecated, use named_defaults instead.
-    operationId: getDefaults
+    summary: Return an array of defaults
+    description: Returns an array of all configured defaults.
+    operationId: getDefaultsSections
     parameters:
       - $ref: "#/parameters/transaction_id"
     tags:
@@ -17,14 +16,13 @@ defaults:
             description: Configuration file version
             type: string
         schema:
-          $ref: "#/definitions/defaults"
+          $ref: "#/definitions/defaults_sections"
       'default':
         $ref: '#/responses/DefaultError'
   put:
-    deprecated: true
-    summary: Replace defaults
-    description: Replace defaults part of config, this has been deprecated, use named_defaults instead.
-    operationId: replaceDefaults
+    summary: Add a defaults section
+    description: Adds a new defaults section to the configuration file.
+    operationId: createDefaultsSection
     parameters:
       - name: data
         required: true
@@ -36,6 +34,72 @@ defaults:
       - $ref: "#/parameters/force_reload"
     tags:
       - Defaults
+    responses:
+      '202':
+        description: Configuration change accepted and reload requested
+        headers:
+          Reload-ID:
+            description: ID of the requested reload
+            type: string
+        schema:
+          $ref: "#/definitions/defaults"
+      '201':
+        description: Defaults created
+        schema:
+          $ref: "#/definitions/defaults"
+      '409':
+        $ref: '#/responses/AlreadyExists'
+      '400':
+        $ref: '#/responses/BadRequest'
+      'default':
+        $ref: '#/responses/DefaultError'
+defaults_one:
+  get:
+    summary: Return a defaults section
+    description: Returns one defaults section configuration by it's name.
+    operationId: getDefaultsSection
+    tags:
+      - Defaults
+    parameters:
+      - name: name
+        in: path
+        description: Defaults name
+        required: true
+        type: string
+      - $ref: "#/parameters/transaction_id"
+    responses:
+      '200':
+        description: Successful operation
+        headers:
+          Configuration-Version:
+            description: Configuration file version
+            type: string
+        schema:
+          $ref: "#/definitions/defaults"
+      '404':
+        $ref: '#/responses/NotFound'
+      'default':
+        $ref: '#/responses/DefaultError'
+  put:
+    summary: Replace a defatults section
+    description: Replaces a defatults section configuration by it's name.
+    operationId: replaceDefaultsSection
+    tags:
+      - Defaults
+    parameters:
+      - name: name
+        in: path
+        description: Defaults name
+        required: true
+        type: string
+      - name: data
+        required: true
+        in: body
+        schema:
+          $ref: "#/definitions/defaults"
+      - $ref: "#/parameters/transaction_id"
+      - $ref: "#/parameters/version"
+      - $ref: "#/parameters/force_reload"
     responses:
       '202':
         description: Configuration change accepted and reload requested
@@ -46,10 +110,40 @@ defaults:
         schema:
           $ref: "#/definitions/defaults"
       '200':
-        description: Defaults replaced
+        description: Defaults section replaced
         schema:
           $ref: "#/definitions/defaults"
       '400':
         $ref: '#/responses/BadRequest'
+      '404':
+        $ref: '#/responses/NotFound'
+      'default':
+        $ref: '#/responses/DefaultError'
+  delete:
+    summary: Delete a defaults section
+    description: Deletes a defaults section from the configuration by it's name.
+    operationId: deleteDefaultsSection
+    tags:
+      - Defaults
+    parameters:
+      - name: name
+        in: path
+        description: Defaults name
+        required: true
+        type: string
+      - $ref: "#/parameters/transaction_id"
+      - $ref: "#/parameters/version"
+      - $ref: "#/parameters/force_reload"
+    responses:
+      '202':
+        description: Configuration change accepted and reload requested
+        headers:
+          Reload-ID:
+            description: ID of the requested reload
+            type: string
+      '204':
+        description: Defaults section deleted
+      '404':
+        $ref: '#/responses/NotFound'
       'default':
         $ref: '#/responses/DefaultError'
diff --git a/specification/paths/configuration/named_defaults.yaml b/specification/paths/configuration/named_defaults.yaml