Skip to content

Commit 0360181

Browse files
committed
BUG/MINOR: add force-reload parameter to storage map replace (PUT)
Also remove force-reload parameter from map create (POST), tweak HTTP return codes. Fix querystring parameters to use underscores and clarify descriptions.
1 parent 44e3169 commit 0360181

File tree

3 files changed

+28
-32
lines changed

3 files changed

+28
-32
lines changed

build/haproxy_spec.yaml

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10039,7 +10039,7 @@ paths:
1003910039
- default: false
1004010040
description: If true, also show unmanaged map files loaded in haproxy
1004110041
in: query
10042-
name: includeUnmanaged
10042+
name: include_unmanaged
1004310043
required: false
1004410044
type: boolean
1004510045
responses:
@@ -10109,7 +10109,7 @@ paths:
1010910109
description: Returns an array of all entries in a given runtime map file.
1011010110
operationId: showRuntimeMap
1011110111
parameters:
10112-
- description: Map storage_name
10112+
- description: Mapfile attribute storage_name
1011310113
in: query
1011410114
name: map
1011510115
required: true
@@ -10130,7 +10130,7 @@ paths:
1013010130
description: Adds an entry into the map file.
1013110131
operationId: addMapEntry
1013210132
parameters:
10133-
- description: Map storage_name
10133+
- description: Mapfile attribute storage_name
1013410134
in: query
1013510135
name: map
1013610136
required: true
@@ -10169,7 +10169,7 @@ paths:
1016910169
name: id
1017010170
required: true
1017110171
type: string
10172-
- description: Map storage_name
10172+
- description: Mapfile attribute storage_name
1017310173
in: query
1017410174
name: map
1017510175
required: true
@@ -10198,7 +10198,7 @@ paths:
1019810198
name: id
1019910199
required: true
1020010200
type: string
10201-
- description: Map storage_name
10201+
- description: Mapfile attribute storage_name
1020210202
in: query
1020310203
name: map
1020410204
required: true
@@ -10224,7 +10224,7 @@ paths:
1022410224
name: id
1022510225
required: true
1022610226
type: string
10227-
- description: Map storage_name
10227+
- description: Mapfile attribute storage_name
1022810228
in: query
1022910229
name: map
1023010230
required: true
@@ -10301,22 +10301,14 @@ paths:
1030110301
parameters:
1030210302
- description: The map file contents
1030310303
in: formData
10304-
name: fileUpload
10304+
name: file_upload
1030510305
type: file
1030610306
x-mimetype: text/plain
1030710307
responses:
1030810308
"201":
1030910309
description: Map file created with its entries
1031010310
schema:
1031110311
$ref: '#/definitions/map'
10312-
"202":
10313-
description: Configuration change accepted and reload requested
10314-
headers:
10315-
Reload-ID:
10316-
description: ID of the requested reload
10317-
type: string
10318-
schema:
10319-
$ref: '#/definitions/map'
1032010312
"400":
1032110313
$ref: '#/responses/BadRequest'
1032210314
"409":
@@ -10389,7 +10381,13 @@ paths:
1038910381
produces:
1039010382
- application/json
1039110383
responses:
10392-
"200":
10384+
"202":
10385+
description: Configuration change accepted and reload requested
10386+
headers:
10387+
Reload-ID:
10388+
description: ID of the requested reload
10389+
type: string
10390+
"204":
1039310391
description: Map file replaced
1039410392
"400":
1039510393
$ref: '#/responses/BadRequest'

paths/runtime.yaml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ maps:
190190
tags:
191191
- Maps
192192
parameters:
193-
- name: includeUnmanaged
193+
- name: include_unmanaged
194194
in: query
195195
description: If true, also show unmanaged map files loaded in haproxy
196196
required: false
@@ -265,7 +265,7 @@ maps_entries:
265265
parameters:
266266
- name: map
267267
in: query
268-
description: Map storage_name
268+
description: Mapfile attribute storage_name
269269
required: true
270270
type: string
271271
responses:
@@ -284,7 +284,7 @@ maps_entries:
284284
parameters:
285285
- name: map
286286
in: query
287-
description: Map storage_name
287+
description: Mapfile attribute storage_name
288288
required: true
289289
type: string
290290
- name: forceSync
@@ -325,7 +325,7 @@ maps_entries_one:
325325
type: string
326326
- name: map
327327
in: query
328-
description: Map storage_name
328+
description: Mapfile attribute storage_name
329329
required: true
330330
type: string
331331
responses:
@@ -351,7 +351,7 @@ maps_entries_one:
351351
type: string
352352
- name: map
353353
in: query
354-
description: Map storage_name
354+
description: Mapfile attribute storage_name
355355
required: true
356356
type: string
357357
- name: forceSync
@@ -395,7 +395,7 @@ maps_entries_one:
395395
type: string
396396
- name: map
397397
in: query
398-
description: Map storage_name
398+
description: Mapfile attribute storage_name
399399
required: true
400400
type: string
401401
- name: forceSync

paths/storage.yaml

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ maps:
2323
- multipart/form-data
2424
parameters:
2525
- in: formData
26-
name: fileUpload
26+
name: file_upload
2727
type: file
2828
description: The map file contents
2929
x-mimetype: text/plain
@@ -34,14 +34,6 @@ maps:
3434
description: Map file created with its entries
3535
schema:
3636
$ref: "#/definitions/map"
37-
'202':
38-
description: Configuration change accepted and reload requested
39-
headers:
40-
Reload-ID:
41-
description: ID of the requested reload
42-
type: string
43-
schema:
44-
$ref: '#/definitions/map'
4537
'409':
4638
$ref: '#/responses/AlreadyExists'
4739
'400':
@@ -114,7 +106,13 @@ maps_one:
114106
type: string
115107
- $ref: "#/parameters/force_reload"
116108
responses:
117-
'200':
109+
"202":
110+
description: Configuration change accepted and reload requested
111+
headers:
112+
Reload-ID:
113+
description: ID of the requested reload
114+
type: string
115+
'204':
118116
description: Map file replaced
119117
'400':
120118
$ref: '#/responses/BadRequest'

0 commit comments

Comments
 (0)