laantungir/blossom
1
0
Fork 0
mirror of https://github.com/hzrd149/blossom.git synced 2025-12-08 22:58:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix typeo

Browse Source 
format BUD-06
This commit is contained in:
hzrd149
2024-09-19 14:40:32 -05:00
parent 2d392c1f58
commit f27cd777f2
1 changed files with 11 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
buds/06.md
View File

@@ -1,8 +1,6 @@
BUD-06 # BUD-06
======
Upload requirements ## Upload requirements
---------------
`draft` `optional` `draft` `optional`
@@ -16,14 +14,14 @@ The `HEAD /upload` endpoint `MUST` use the `X-SHA-256`, `X-Content-Type` and `X-
- `X-SHA-256`: A string that represents the blob's SHA-256 hash. - `X-SHA-256`: A string that represents the blob's SHA-256 hash.
- `X-Content-Length`: An integer that represents the blob size in bytes. - `X-Content-Length`: An integer that represents the blob size in bytes.
- `X-Content-Type`: A string that specifies the fblobile's MIME type, like `application/pdf` or `image/png`. - `X-Content-Type`: A string that specifies the blob's MIME type, like `application/pdf` or `image/png`.
- `X-Upload-Message`: A human readable message that explains the reason why the upload cannot proceed. - `X-Upload-Message`: A human readable message that explains the reason why the upload cannot proceed.
### Upload Authorization ### Upload Authorization
The `HEAD /upload` endpoint MAY accept an `upload` authorization event using the `Authorization` header similar to what is used in the [`PUT /upload`](./02.md#upload-authorization-required) endpoint The `HEAD /upload` endpoint MAY accept an `upload` authorization event using the `Authorization` header similar to what is used in the [`PUT /upload`](./02.md#upload-authorization-required) endpoint
If the server requires authorization to upload it may respond with the `401` status code, or if authorization was provided and is invalid or not permitted it may respond with `403` status code If the server requires authorization to upload it may respond with the `401` status code, or if authorization was provided and is invalid or not permitted it may respond with `403` status code
### Examples ### Examples
@@ -41,8 +39,7 @@ Example response from the server if the upload can be done:
HTTP/1.1 200 OK HTTP/1.1 200 OK
``` ```
If the upload cannot proceed, the server `MUST` return an appropriate `4xx` HTTP status code and a custom header `X-Upload-Message` with a human readable error message. If the upload cannot proceed, the server `MUST` return an appropriate `4xx` HTTP status code and a custom header `X-Upload-Message` with a human readable error message.
Some examples of error messages: Some examples of error messages:
@@ -52,17 +49,17 @@ X-Upload-Message: Invalid X-SHA-256 header format. Expected a string.
``` ```
```http ```http
HTTP/1.1 401 Unauthorized HTTP/1.1 401 Unauthorized
X-Upload-Message: Authorization required for uploading video files. X-Upload-Message: Authorization required for uploading video files.
``` ```
```http ```http
HTTP/1.1 403 Forbidden HTTP/1.1 403 Forbidden
X-Upload-Message: SHA-256 hash banned. X-Upload-Message: SHA-256 hash banned.
``` ```
```http ```http
HTTP/1.1 411 Length Required HTTP/1.1 411 Length Required
X-Upload-Message: Missing X-Content-Length header. X-Upload-Message: Missing X-Content-Length header.
``` ```
@@ -74,4 +71,4 @@ X-Upload-Message: File too large. Max allowed size is 100MB.
```http ```http
HTTP/1.1 415 Unsupported Media Type HTTP/1.1 415 Unsupported Media Type
X-Upload-Message: Unsupported file type. X-Upload-Message: Unsupported file type.
``` ```