Skip to content

Commit 9e6fe91

Browse files
committed
REORG/MEDIUM: maps: move map file upload path from runtime to map storage endpoint
Storage container (get all) returns a list of Map models for files that are managed. Also added filter for displaying unmanaged maps on the runtime endpoint and tweaked some descriptions to reference storage_name
1 parent 4dc154c commit 9e6fe91

File tree

3 files changed

+120
-110
lines changed

3 files changed

+120
-110
lines changed

build/haproxy_spec.yaml

Lines changed: 60 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -10031,8 +10031,15 @@ paths:
1003110031
- StickTable
1003210032
/services/haproxy/runtime/maps:
1003310033
get:
10034-
description: Returns all available map files.
10034+
description: Returns runtime map files.
1003510035
operationId: getAllRuntimeMapFiles
10036+
parameters:
10037+
- default: false
10038+
description: If true, also show unmanaged map files loaded in haproxy
10039+
in: query
10040+
name: includeUnmanaged
10041+
required: false
10042+
type: boolean
1003610043
responses:
1003710044
"200":
1003810045
description: Successful operation
@@ -10042,41 +10049,7 @@ paths:
1004210049
$ref: '#/responses/NotFound'
1004310050
default:
1004410051
$ref: '#/responses/DefaultError'
10045-
summary: Return all available map files
10046-
tags:
10047-
- Maps
10048-
post:
10049-
consumes:
10050-
- multipart/form-data
10051-
description: Creates runtime map file with its entries.
10052-
operationId: createRuntimeMap
10053-
parameters:
10054-
- description: The map file to upload
10055-
in: formData
10056-
name: fileUpload
10057-
type: file
10058-
x-mimetype: text/plain
10059-
- $ref: '#/parameters/force_reload'
10060-
responses:
10061-
"201":
10062-
description: Map file created with its entries
10063-
schema:
10064-
$ref: '#/definitions/map'
10065-
"202":
10066-
description: Configuration change accepted and reload requested
10067-
headers:
10068-
Reload-ID:
10069-
description: ID of the requested reload
10070-
type: string
10071-
schema:
10072-
$ref: '#/definitions/map'
10073-
"400":
10074-
$ref: '#/responses/BadRequest'
10075-
"409":
10076-
$ref: '#/responses/AlreadyExists'
10077-
default:
10078-
$ref: '#/responses/DefaultError'
10079-
summary: Creates runtime map file with its entries
10052+
summary: Return runtime map files
1008010053
tags:
1008110054
- Maps
1008210055
/services/haproxy/runtime/maps/{name}:
@@ -10134,7 +10107,7 @@ paths:
1013410107
description: Returns an array of all entries in a given runtime map file.
1013510108
operationId: showRuntimeMap
1013610109
parameters:
10137-
- description: Map file name
10110+
- description: Map storage_name
1013810111
in: query
1013910112
name: map
1014010113
required: true
@@ -10155,7 +10128,7 @@ paths:
1015510128
description: Adds an entry into the map file.
1015610129
operationId: addMapEntry
1015710130
parameters:
10158-
- description: Map file name
10131+
- description: Map storage_name
1015910132
in: query
1016010133
name: map
1016110134
required: true
@@ -10194,7 +10167,7 @@ paths:
1019410167
name: id
1019510168
required: true
1019610169
type: string
10197-
- description: Map file name
10170+
- description: Map storage_name
1019810171
in: query
1019910172
name: map
1020010173
required: true
@@ -10223,7 +10196,7 @@ paths:
1022310196
name: id
1022410197
required: true
1022510198
type: string
10226-
- description: Map file name
10199+
- description: Map storage_name
1022710200
in: query
1022810201
name: map
1022910202
required: true
@@ -10249,7 +10222,7 @@ paths:
1024910222
name: id
1025010223
required: true
1025110224
type: string
10252-
- description: Map file name
10225+
- description: Map storage_name
1025310226
in: query
1025410227
name: map
1025510228
required: true
@@ -10304,28 +10277,59 @@ paths:
1030410277
- Configuration
1030510278
/services/haproxy/storage/maps:
1030610279
get:
10307-
description: Returns all available map files on disk.
10280+
description: Returns a list of all managed map files
1030810281
operationId: getAllStorageMapFiles
1030910282
responses:
1031010283
"200":
1031110284
description: Successful operation
1031210285
schema:
10313-
items:
10314-
type: string
10315-
type: array
10286+
$ref: '#/definitions/maps'
1031610287
"404":
1031710288
$ref: '#/responses/NotFound'
1031810289
default:
1031910290
$ref: '#/responses/DefaultError'
10320-
summary: Return all available map files on disk
10291+
summary: Return a list of all managed map files
10292+
tags:
10293+
- Storage
10294+
post:
10295+
consumes:
10296+
- multipart/form-data
10297+
description: Creates a managed runtime map file with its entries.
10298+
operationId: createRuntimeMap
10299+
parameters:
10300+
- description: The map file contents
10301+
in: formData
10302+
name: fileUpload
10303+
type: file
10304+
x-mimetype: text/plain
10305+
responses:
10306+
"201":
10307+
description: Map file created with its entries
10308+
schema:
10309+
$ref: '#/definitions/map'
10310+
"202":
10311+
description: Configuration change accepted and reload requested
10312+
headers:
10313+
Reload-ID:
10314+
description: ID of the requested reload
10315+
type: string
10316+
schema:
10317+
$ref: '#/definitions/map'
10318+
"400":
10319+
$ref: '#/responses/BadRequest'
10320+
"409":
10321+
$ref: '#/responses/AlreadyExists'
10322+
default:
10323+
$ref: '#/responses/DefaultError'
10324+
summary: Creates a managed runtime map file with its entries
1032110325
tags:
1032210326
- Storage
1032310327
/services/haproxy/storage/maps/{name}:
1032410328
delete:
10325-
description: Deletes map file from disk.
10329+
description: Deletes a managed map file from disk.
1032610330
operationId: deleteStorageMap
1032710331
parameters:
10328-
- description: Map file name
10332+
- description: Map file storage_name
1032910333
in: path
1033010334
name: name
1033110335
required: true
@@ -10337,14 +10341,14 @@ paths:
1033710341
$ref: '#/responses/NotFound'
1033810342
default:
1033910343
$ref: '#/responses/DefaultError'
10340-
summary: Deletes map file from disk
10344+
summary: Deletes a managed map file from disk
1034110345
tags:
1034210346
- Storage
1034310347
get:
10344-
description: Returns one map file from disk.
10348+
description: Returns the contents of one managed map file from disk
1034510349
operationId: getOneStorageMap
1034610350
parameters:
10347-
- description: Map file name
10351+
- description: Map file storage_name
1034810352
in: path
1034910353
name: name
1035010354
required: true
@@ -10358,16 +10362,16 @@ paths:
1035810362
$ref: '#/responses/NotFound'
1035910363
default:
1036010364
$ref: '#/responses/DefaultError'
10361-
summary: Return one map file from disk
10365+
summary: Return the contents of one managed map file from disk
1036210366
tags:
1036310367
- Storage
1036410368
put:
1036510369
consumes:
1036610370
- text/plain
10367-
description: Replaces a Map file on disk.
10371+
description: Replaces the contents of a managed map file on disk
1036810372
operationId: replaceStorageMapFile
1036910373
parameters:
10370-
- description: Map file name
10374+
- description: Map file storage_name
1037110375
in: path
1037210376
name: name
1037310377
required: true
@@ -10377,6 +10381,7 @@ paths:
1037710381
required: true
1037810382
schema:
1037910383
type: string
10384+
- $ref: '#/parameters/force_reload'
1038010385
produces:
1038110386
- application/json
1038210387
responses:
@@ -10390,7 +10395,7 @@ paths:
1039010395
$ref: '#/responses/NotFound'
1039110396
default:
1039210397
$ref: '#/responses/DefaultError'
10393-
summary: Replace a Map file on disk
10398+
summary: Replace contents of a managed map file on disk
1039410399
tags:
1039510400
- Storage
1039610401

paths/runtime.yaml

Lines changed: 14 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -184,11 +184,18 @@ stick_table_entries:
184184
$ref: '#/responses/DefaultError'
185185
maps:
186186
get: # show map
187-
summary: Return all available map files
188-
description: Returns all available map files.
187+
summary: Return runtime map files
188+
description: Returns runtime map files.
189189
operationId: getAllRuntimeMapFiles
190190
tags:
191191
- Maps
192+
parameters:
193+
- name: includeUnmanaged
194+
in: query
195+
description: If true, also show unmanaged map files loaded in haproxy
196+
required: false
197+
type: boolean
198+
default: false
192199
responses:
193200
'200':
194201
description: Successful operation
@@ -198,40 +205,6 @@ maps:
198205
$ref: '#/responses/NotFound'
199206
'default':
200207
$ref: '#/responses/DefaultError'
201-
post: # (raw)
202-
summary: Creates runtime map file with its entries
203-
description: Creates runtime map file with its entries.
204-
operationId: createRuntimeMap
205-
consumes:
206-
- multipart/form-data
207-
parameters:
208-
- in: formData
209-
name: fileUpload
210-
type: file
211-
description: The map file to upload
212-
x-mimetype: text/plain
213-
- $ref: "#/parameters/force_reload"
214-
tags:
215-
- Maps
216-
responses:
217-
'201':
218-
description: Map file created with its entries
219-
schema:
220-
$ref: "#/definitions/map"
221-
'202':
222-
description: Configuration change accepted and reload requested
223-
headers:
224-
Reload-ID:
225-
description: ID of the requested reload
226-
type: string
227-
schema:
228-
$ref: '#/definitions/map'
229-
'409':
230-
$ref: '#/responses/AlreadyExists'
231-
'400':
232-
$ref: '#/responses/BadRequest'
233-
'default':
234-
$ref: '#/responses/DefaultError'
235208
maps_one:
236209
get: # one map file
237210
summary: Return one runtime map file
@@ -292,7 +265,7 @@ maps_entries:
292265
parameters:
293266
- name: map
294267
in: query
295-
description: Map file name
268+
description: Map storage_name
296269
required: true
297270
type: string
298271
responses:
@@ -311,7 +284,7 @@ maps_entries:
311284
parameters:
312285
- name: map
313286
in: query
314-
description: Map file name
287+
description: Map storage_name
315288
required: true
316289
type: string
317290
- name: forceSync
@@ -352,7 +325,7 @@ maps_entries_one:
352325
type: string
353326
- name: map
354327
in: query
355-
description: Map file name
328+
description: Map storage_name
356329
required: true
357330
type: string
358331
responses:
@@ -378,7 +351,7 @@ maps_entries_one:
378351
type: string
379352
- name: map
380353
in: query
381-
description: Map file name
354+
description: Map storage_name
382355
required: true
383356
type: string
384357
- name: forceSync
@@ -422,7 +395,7 @@ maps_entries_one:
422395
type: string
423396
- name: map
424397
in: query
425-
description: Map file name
398+
description: Map storage_name
426399
required: true
427400
type: string
428401
- name: forceSync

0 commit comments

Comments
 (0)