Skip to content

Commit d988dbd

Browse files
kalyazinJackThomson2
authored andcommitted
fix(swagger): document 204 response for free page hinting start/stop
The PATCH /balloon/hinting/start and PATCH /balloon/hinting/stop endpoints return 204 No Content on success (their VmmAction handlers map to VmmData::Empty, which the API server converts to StatusCode::NoContent), but the OpenAPI spec declared 200. Signed-off-by: Nikita Kalyazin <nikita.kalyazin@e2b.dev>
1 parent 2079045 commit d988dbd

2 files changed

Lines changed: 6 additions & 2 deletions

File tree

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,10 @@ and this project adheres to
9090
- [#5818](https://github.com/firecracker-microvm/firecracker/pull/5818): Reject
9191
device status writes that clear previously set bits in the MMIO transport,
9292
except for reset.
93+
- [#5884](https://github.com/firecracker-microvm/firecracker/pull/5884):
94+
Corrected the OpenAPI spec for `PATCH /balloon/hinting/start` and
95+
`PATCH /balloon/hinting/stop` to declare `204 No Content` instead of `200`,
96+
matching the actual runtime response.
9397

9498
## [1.15.0]
9599

src/firecracker/swagger/firecracker.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ paths:
181181
schema:
182182
$ref: "#/definitions/BalloonStartCmd"
183183
responses:
184-
200:
184+
204:
185185
description: Free page hinting run started.
186186
400:
187187
description: The balloon free hinting was not enabled when the device was configured.
@@ -215,7 +215,7 @@ paths:
215215
summary: Stops a free page hinting run only if enabled pre-boot.
216216
operationId: stopBalloonHinting
217217
responses:
218-
200:
218+
204:
219219
description: Free page hinting run stopped.
220220
400:
221221
description: The balloon free hinting was not enabled when the device was configured.

0 commit comments

Comments
 (0)