Skip to content

Commit

Permalink
feat: parametrise chunked uploads endpoint urls (#444)
Browse files Browse the repository at this point in the history
  • Loading branch information
@box-apimgmt
box-apimgmt authored Aug 7, 2024
1 parent 4d8b4a6 commit 7955f30
Showing 1 changed file with 58 additions and 23 deletions.
81 changes: 58 additions & 23 deletions openapi.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"url": "http://www.apache.org/licenses/LICENSE-2.0"
},
"version": "2.0.0",
"x-box-commit-hash": "8b7b5fdf2f"
"x-box-commit-hash": "c9d15e3555"
},
"servers": [
{
Expand Down Expand Up @@ -1639,12 +1639,19 @@
"tags": [
"Uploads (Chunked)"
],
"description": "Return information about an upload session.",
"description": "Return information about an upload session.\n\nThe actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions) endpoint.",
"x-box-tag": "chunked_uploads",
"x-box-enable-explorer": false,
"servers": [
{
"url": "https://upload.box.com/api/2.0",
"description": "Server for file uploads"
"url": "https://{box-upload-server}/api/2.0",
"description": "Server for file uploads",
"variables": {
"box-upload-server": {
"description": "The server for the upload session.",
"default": "upload.box.com"
}
}
}
],
"parameters": [
Expand Down Expand Up @@ -1689,11 +1696,18 @@
"Uploads (Chunked)"
],
"x-box-tag": "chunked_uploads",
"description": "Updates a chunk of an upload session for a file.",
"x-box-enable-explorer": false,
"description": "Uploads a chunk of a file for an upload session.\n\nThe actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions)\nand [`Get upload session`](e://get-files-upload-sessions-id) endpoints.",
"servers": [
{
"url": "https://upload.box.com/api/2.0",
"description": "Server for file uploads"
"url": "https://{box-upload-server}/api/2.0",
"description": "Server for file uploads",
"variables": {
"box-upload-server": {
"description": "The server for the upload session.",
"default": "upload.box.com"
}
}
}
],
"parameters": [
Expand Down Expand Up @@ -1798,14 +1812,21 @@
"tags": [
"Uploads (Chunked)"
],
"description": "Abort an upload session and discard all data uploaded.\n\nThis cannot be reversed.",
"description": "Abort an upload session and discard all data uploaded.\n\nThis cannot be reversed.\n\nThe actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions)\nand [`Get upload session`](e://get-files-upload-sessions-id) endpoints.",
"servers": [
{
"url": "https://upload.box.com/api/2.0",
"description": "Server for file uploads"
"url": "https://{box-upload-server}/api/2.0",
"description": "Server for file uploads",
"variables": {
"box-upload-server": {
"description": "The server for the upload session.",
"default": "upload.box.com"
}
}
}
],
"x-box-tag": "chunked_uploads",
"x-box-enable-explorer": false,
"parameters": [
{
"name": "upload_session_id",
Expand Down Expand Up @@ -1843,13 +1864,20 @@
"Uploads (Chunked)"
],
"x-box-tag": "chunked_uploads",
"x-box-enable-explorer": false,
"servers": [
{
"url": "https://upload.box.com/api/2.0",
"description": "Server for file uploads"
"url": "https://{box-upload-server}/api/2.0",
"description": "Server for file uploads",
"variables": {
"box-upload-server": {
"description": "The server for the upload session.",
"default": "upload.box.com"
}
}
}
],
"description": "Return a list of the chunks uploaded to the upload\nsession so far.",
"description": "Return a list of the chunks uploaded to the upload session so far.\n\nThe actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions)\nand [`Get upload session`](e://get-files-upload-sessions-id) endpoints.",
"parameters": [
{
"name": "upload_session_id",
Expand Down Expand Up @@ -1918,13 +1946,20 @@
"Uploads (Chunked)"
],
"x-box-tag": "chunked_uploads",
"x-box-enable-explorer": false,
"servers": [
{
"url": "https://upload.box.com/api/2.0",
"description": "Server for file uploads"
"url": "https://{box-upload-server}/api/2.0",
"description": "Server for file uploads",
"variables": {
"box-upload-server": {
"description": "The server for the upload session.",
"default": "upload.box.com"
}
}
}
],
"description": "Close an upload session and create a file from the\nuploaded chunks.",
"description": "Close an upload session and create a file from the uploaded chunks.\n\nThe actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions)\nand [`Get upload session`](e://get-files-upload-sessions-id) endpoints.",
"parameters": [
{
"name": "upload_session_id",
Expand Down Expand Up @@ -23967,7 +24002,7 @@
"description": "The ISO language code to return the agent config for.\nIf the language is not supported the default agent config is returned.",
"in": "query",
"required": false,
"example": "ja-JP",
"example": "ja",
"schema": {
"type": "string"
}
Expand Down Expand Up @@ -35208,32 +35243,32 @@
"upload_part": {
"type": "string",
"description": "The URL to upload parts to",
"example": "https://upload.box.com/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD"
"example": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD"
},
"commit": {
"type": "string",
"description": "The URL used to commit the file",
"example": "https://upload.box.com/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/commit"
"example": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/commit"
},
"abort": {
"type": "string",
"description": "The URL for used to abort the session.",
"example": "https://upload.box.com/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD"
"example": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD"
},
"list_parts": {
"type": "string",
"description": "The URL users to list all parts.",
"example": "https://upload.box.com/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/parts"
"example": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/parts"
},
"status": {
"type": "string",
"description": "The URL used to get the status of the upload.",
"example": "https://upload.box.com/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD"
"example": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD"
},
"log_event": {
"type": "string",
"description": "The URL used to get the upload log from.",
"example": "https://upload.box.com/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/log"
"example": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/log"
}
}
},
Expand Down

0 comments on commit 7955f30

Please sign in to comment.