docs: audit, deploymentconfig, files, parameters (#5506)

* docs: audit, deploymentconfig, files, parameters * Fix: mark as binary * Fix: show format in docs * Fix: use .swaggo * Fix: swagger notice * Swagger notice
2026-09-24 15:04:27 +08:00 · 2023-01-03 19:21:10 +01:00
parent 829cfee29d
commit e67d131514
26 changed files with 6118 additions and 94 deletions
@@ -0,0 +1,75 @@
+# Files
+
+> This page is incomplete, stay tuned.
+
+## Upload file
+
+### Code samples
+
+```shell
+# Example request using curl
+curl -X POST http://coder-server:8080/api/v2/files \
+  -H 'Accept: application/json' \
+  -H 'Content-Type: application/x-tar' \
+  -H 'Coder-Session-Token: API_KEY'
+```
+
+`POST /files`
+
+> Body parameter
+
+```yaml
+file: string
+```
+
+### Parameters
+
+| Name           | In     | Type   | Required | Description                              |
+| -------------- | ------ | ------ | -------- | ---------------------------------------- |
+| `Content-Type` | header | string | true     | Content-Type must be `application/x-tar` |
+| `body`         | body   | object | true     |                                          |
+| `» file`       | body   | binary | true     | File to be uploaded                      |
+
+### Example responses
+
+> 201 Response
+
+```json
+{
+  "hash": "19686d84-b10d-4f90-b18e-84fd3fa038fd"
+}
+```
+
+### Responses
+
+| Status | Meaning                                                      | Description | Schema                                                       |
+| ------ | ------------------------------------------------------------ | ----------- | ------------------------------------------------------------ |
+| 201    | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created     | [codersdk.UploadResponse](schemas.md#codersdkuploadresponse) |
+
+To perform this operation, you must be authenticated by means of one of the following methods: **CoderSessionToken**.
+
+## Get file by ID
+
+### Code samples
+
+```shell
+# Example request using curl
+curl -X GET http://coder-server:8080/api/v2/files/{fileID} \
+  -H 'Coder-Session-Token: API_KEY'
+```
+
+`GET /files/{fileID}`
+
+### Parameters
+
+| Name     | In   | Type         | Required | Description |
+| -------- | ---- | ------------ | -------- | ----------- |
+| `fileID` | path | string(uuid) | true     | File ID     |
+
+### Responses
+
+| Status | Meaning                                                 | Description | Schema |
+| ------ | ------------------------------------------------------- | ----------- | ------ |
+| 200    | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK          |        |
+
+To perform this operation, you must be authenticated by means of one of the following methods: **CoderSessionToken**.