mirror/Gokapi
1
0
Fork 0
mirror of https://github.com/Forceu/Gokapi.git synced 2026-01-31 21:48:32 -06:00
Code Issues Packages Projects Releases Wiki Activity

Change api name

Browse Source
This commit is contained in:
Marc Ole Bulling
2026-01-15 00:06:02 +01:00
parent 4d66e5c02a
commit 867dbd606a
4 changed files with 112 additions and 112 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
internal/webserver/api/routing.go
View File

@@ -16,7 +16,7 @@ import (
type apiRoute struct {
Url string // The API endpoint
HasWildcard bool // True if the endpoint contains the ID as a sub-URL
IsFileRequestApi bool //True if the endpoint is used for public uploads
IsFileRequestApi bool // True if the endpoint is used for public uploads
AdminOnly bool // True if the endpoint requires admin/superadmin permissions
ApiPerm models.ApiPermission // Required permission to access the endpoint
RequestParser requestParser // Parser for the supplied parameters
@@ -88,21 +88,6 @@ var routes = []apiRoute{
execution: apiChunkComplete,
RequestParser: &paramChunkComplete{},
},
{
Url: "/chunk/uploadRequestAdd",
ApiPerm: models.ApiPermNone,
execution: apiChunkUploadRequestAdd,
IsFileRequestApi: true,
RequestParser: &paramChunkUploadRequestAdd{},
},
{
//TODO only add chunks that are authorised
Url: "/chunk/uploadRequestComplete",
ApiPerm: models.ApiPermNone,
IsFileRequestApi: true,
execution: apiChunkUploadRequestComplete,
RequestParser: &paramChunkUploadRequestComplete{},
},
{
Url: "/files/add",
ApiPerm: models.ApiPermUpload,
@@ -218,6 +203,21 @@ var routes = []apiRoute{
execution: apiURequestDelete,
RequestParser: &paramURequestDelete{},
},
{
Url: "/uploadrequest/chunk/add",
ApiPerm: models.ApiPermNone,
execution: apiChunkUploadRequestAdd,
IsFileRequestApi: true,
RequestParser: &paramChunkUploadRequestAdd{},
},
{
//TODO only add chunks that are authorised
Url: "/uploadrequest/chunk/commplete",
ApiPerm: models.ApiPermNone,
IsFileRequestApi: true,
execution: apiChunkUploadRequestComplete,
RequestParser: &paramChunkUploadRequestComplete{},
},
{
Url: "/logs/delete",
ApiPerm: models.ApiPermManageLogs,

94
internal/webserver/web/static/apidocumentation/openapi.json
View File

@@ -529,10 +529,55 @@
}
}
},
"/chunk/uploadRequestComplete": {
"/uploadrequest/chunk/add": {
"post": {
"tags": [
"chunk"
"uploadrequest"
],
"summary": "Uploads a new chunk for a file request",
"description": "Uploads a file in chunks. Parallel uploading is supported. Must call /uploadrequest/chunk/commplete after all chunks have been uploaded. WARNING: Does not support end-to-end encryption! If server is setup to utilise end-to-end encryption, file will be stored in plain-text! Requires API key associated with the file request",
"operationId": "chunkaddur",
"security": [
{
"apikey": [
"FileRequest"
]
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/chunkingUr"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Operation successful",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/chunkUploadResult"
}
}
}
},
"400": {
"description": "Invalid input"
},
"401": {
"description": "Invalid API key provided for authentication or API key does not have the required permission"
}
}
}
},
"/uploadrequest/chunk/commplete": {
"post": {
"tags": [
"uploadrequest"
],
"summary": "Finalises uploaded chunks",
"description": "Needs to be called after all chunks have been uploaded. Adds the uploaded file to Gokapi. Requires API permission UPLOAD",
@@ -650,51 +695,6 @@
}
}
},
"/chunk/uploadRequestAdd": {
"post": {
"tags": [
"chunk"
],
"summary": "Uploads a new chunk for a file request",
"description": "Uploads a file in chunks. Parallel uploading is supported. Must call /chunk/uploadRequestComplete after all chunks have been uploaded. WARNING: Does not support end-to-end encryption! If server is setup to utilise end-to-end encryption, file will be stored in plain-text! Requires API key associated with the file request",
"operationId": "chunkaddur",
"security": [
{
"apikey": [
"FileRequest"
]
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/chunkingUr"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Operation successful",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/chunkUploadResult"
}
}
}
},
"400": {
"description": "Invalid input"
},
"401": {
"description": "Invalid API key provided for authentication or API key does not have the required permission"
}
}
}
},
"/files/add": {
"post": {
"tags": [

4
internal/webserver/web/templates/html_public_upload.tmpl
View File

@@ -171,8 +171,8 @@ fileInput.addEventListener('change', () => {
<script>
const CHUNK_SIZE = {{ .ChunkSize }} * 1024 * 1024;
const UPLOAD_URL = "./api/chunk/uploadRequestAdd";
const COMPLETE_URL = "./api/chunk/uploadRequestComplete";
const UPLOAD_URL = "./api/uploadrequest/chunk/add";
const COMPLETE_URL = "./api/uploadrequest/chunk/commplete";
const FILE_REQUEST_ID = "{{ .FileRequest.Id }}";
const API_KEY = "{{ .FileRequest.ApiKey }}";

94
openapi.json
View File

@@ -529,10 +529,55 @@
}
}
},
"/chunk/uploadRequestComplete": {
"/uploadrequest/chunk/add": {
"post": {
"tags": [
"chunk"
"uploadrequest"
],
"summary": "Uploads a new chunk for a file request",
"description": "Uploads a file in chunks. Parallel uploading is supported. Must call /uploadrequest/chunk/commplete after all chunks have been uploaded. WARNING: Does not support end-to-end encryption! If server is setup to utilise end-to-end encryption, file will be stored in plain-text! Requires API key associated with the file request",
"operationId": "chunkaddur",
"security": [
{
"apikey": [
"FileRequest"
]
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/chunkingUr"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Operation successful",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/chunkUploadResult"
}
}
}
},
"400": {
"description": "Invalid input"
},
"401": {
"description": "Invalid API key provided for authentication or API key does not have the required permission"
}
}
}
},
"/uploadrequest/chunk/commplete": {
"post": {
"tags": [
"uploadrequest"
],
"summary": "Finalises uploaded chunks",
"description": "Needs to be called after all chunks have been uploaded. Adds the uploaded file to Gokapi. Requires API permission UPLOAD",
@@ -650,51 +695,6 @@
}
}
},
"/chunk/uploadRequestAdd": {
"post": {
"tags": [
"chunk"
],
"summary": "Uploads a new chunk for a file request",
"description": "Uploads a file in chunks. Parallel uploading is supported. Must call /chunk/uploadRequestComplete after all chunks have been uploaded. WARNING: Does not support end-to-end encryption! If server is setup to utilise end-to-end encryption, file will be stored in plain-text! Requires API key associated with the file request",
"operationId": "chunkaddur",
"security": [
{
"apikey": [
"FileRequest"
]
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/chunkingUr"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Operation successful",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/chunkUploadResult"
}
}
}
},
"400": {
"description": "Invalid input"
},
"401": {
"description": "Invalid API key provided for authentication or API key does not have the required permission"
}
}
}
},
"/files/add": {
"post": {
"tags": [