Skip to content

Commit 6790156

Browse files
zlimacatangiu
authored andcommitted
docs: update swagger path
A recent commit b6f4636 relocated swagger definition file, but missed updating links to it in documentations. Fixed it by search and replace: git grep -l -e api_server/swagger --and --not -e src/api_server/swagger \ | xargs sed -i 's:api_server/swagger:src/api_server/swagger:' Fixes: b6f4636 ("build: workspace cleanup") Signed-off-by: Zi Shen Lim <[email protected]>
1 parent 09c33b1 commit 6790156

File tree

5 files changed

+5
-5
lines changed

5 files changed

+5
-5
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ Firecracker's overall architecture is described in
8585

8686
Firecracker consists of a single micro Virtual Machine Manager process that
8787
exposes an API endpoint to the host once started. The API is
88-
[specified in OpenAPI format](api_server/swagger/firecracker.yaml). Read more
88+
[specified in OpenAPI format](src/api_server/swagger/firecracker.yaml). Read more
8989
about it in the [API docs](docs/api_requests).
9090

9191
The **API endpoint** can be used to:

SPECIFICATION.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ enough RAM, etc.), customers can rely on the following:
1818
they are logged³ by the Firecracker process.
1919
1. **API Stability:** The API socket is always available and the API conforms
2020
to the in-tree
21-
[Open API specification](api_server/swagger/firecracker.yaml). API failures
21+
[Open API specification](src/api_server/swagger/firecracker.yaml). API failures
2222
are logged in the Firecracker log.
2323
1. **Overhead:** For a Firecracker virtual machine manager running a microVM
2424
with `1 CPUs and 128 MiB of RAM`, and a guest OS with the Firecracker-tuned

docs/api_requests/actions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Firecracker microVMs can execute actions that can be triggered via `PUT`
44
requests on the `/actions` resource.
55

66
Details about the required fields can be found in the
7-
[swagger definition](../../api_server/swagger/firecracker.yaml).
7+
[swagger definition](../../src/api_server/swagger/firecracker.yaml).
88

99
## BlockDeviceRescan
1010

docs/api_requests/logger.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ curl --unix-socket /tmp/firecracker.socket -i \
2121
```
2222

2323
Details about the required and optional fields can be found in the
24-
[swagger definition](../../api_server/swagger/firecracker.yaml).
24+
[swagger definition](../../src/api_server/swagger/firecracker.yaml).
2525

2626
The `logs.fifo` file stores the human readable logs (i.e errors,
2727
warnings etc) while the `metrics.fifo` file stores the metrics

docs/api_requests/patch-network-interface.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Accept: application/json
5858
```
5959

6060
The full specification of the data structures available for this call can be
61-
found in our [OpenAPI spec](../../api_server/swagger/firecracker.yaml).
61+
found in our [OpenAPI spec](../../src/api_server/swagger/firecracker.yaml).
6262

6363
**Note**: The data provided for the update is merged with the existing data.
6464
In the above example, the RX rate limit is updated, but the TX rate limit

0 commit comments

Comments
 (0)