Skip to content

Commit c397c5b

Browse files
jacobtreadjacobtread
committed
chore: update api docs
1 parent 150b2e6 commit c397c5b

1 file changed

Lines changed: 27 additions & 63 deletions

File tree

‎packages/docbox/docbox.json‎

Lines changed: 27 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -2994,12 +2994,8 @@
29942994
"folder_id": null,
29952995
"include_content": false,
29962996
"include_name": false,
2997-
"item_id": null,
2998-
"max_fragment_size": null,
2999-
"max_fragments": null,
30002997
"max_pages": null,
30012998
"mime": null,
3002-
"modified": null,
30032999
"neural": false,
30043000
"offset": null,
30053001
"pages_offset": null,
@@ -3072,6 +3068,7 @@
30723068
"name": {
30733069
"type": "string",
30743070
"description": "Name for the folder",
3071+
"maxLength": 255,
30753072
"minLength": 1
30763073
}
30773074
}
@@ -3093,6 +3090,7 @@
30933090
"name": {
30943091
"type": "string",
30953092
"description": "Name for the link",
3093+
"maxLength": 255,
30963094
"minLength": 1
30973095
},
30983096
"value": {
@@ -3112,6 +3110,13 @@
31123110
"mime"
31133111
],
31143112
"properties": {
3113+
"disable_mime_sniffing": {
3114+
"type": [
3115+
"boolean",
3116+
"null"
3117+
],
3118+
"description": "Whether to disable mime sniffing for the file. When false/not specified\nif a application/octet-stream mime type is provided the file name\nwill be used to attempt to determine the real mime type"
3119+
},
31153120
"folder_id": {
31163121
"type": "string",
31173122
"format": "uuid",
@@ -3124,6 +3129,7 @@
31243129
"name": {
31253130
"type": "string",
31263131
"description": "Name of the file being uploaded",
3132+
"maxLength": 255,
31273133
"minLength": 1
31283134
},
31293135
"parent_id": {
@@ -3175,17 +3181,9 @@
31753181
"type": "object",
31763182
"description": "Response to an options request",
31773183
"required": [
3178-
"allowed_mime_types",
31793184
"max_file_size"
31803185
],
31813186
"properties": {
3182-
"allowed_mime_types": {
3183-
"type": "array",
3184-
"items": {
3185-
"type": "string"
3186-
},
3187-
"description": "List of allowed mime types for uploading"
3188-
},
31893187
"max_file_size": {
31903188
"type": "integer",
31913189
"description": "Max allowed upload file size in bytes",
@@ -3785,7 +3783,7 @@
37853783
"created_at": {
37863784
"type": "string",
37873785
"format": "date-time",
3788-
"description": "When the file was created"
3786+
"description": "When the link was created"
37893787
},
37903788
"created_by": {
37913789
"oneOf": [
@@ -3794,7 +3792,7 @@
37943792
},
37953793
{
37963794
"$ref": "#/components/schemas/User",
3797-
"description": "User who created the file"
3795+
"description": "User who created the link"
37983796
}
37993797
]
38003798
},
@@ -3806,15 +3804,15 @@
38063804
"id": {
38073805
"type": "string",
38083806
"format": "uuid",
3809-
"description": "Unique identifier for the file"
3807+
"description": "Unique identifier for the link"
38103808
},
38113809
"last_modified_at": {
38123810
"type": [
38133811
"string",
38143812
"null"
38153813
],
38163814
"format": "date-time",
3817-
"description": "Last time the file was modified"
3815+
"description": "Last time the link was modified"
38183816
},
38193817
"last_modified_by": {
38203818
"oneOf": [
@@ -3823,7 +3821,7 @@
38233821
},
38243822
{
38253823
"$ref": "#/components/schemas/User",
3826-
"description": "User who last modified the file"
3824+
"description": "User who last modified the link"
38273825
}
38283826
]
38293827
},
@@ -4071,47 +4069,14 @@
40714069
"description": "Whether to include document names",
40724070
"default": false
40734071
},
4074-
"item_id": {
4075-
"type": [
4076-
"string",
4077-
"null"
4078-
],
4079-
"format": "uuid",
4080-
"description": "Enforce search to a specific file,link,folder\n\nDeprecated: use the /search endpoint on the file itself instead",
4081-
"default": null,
4082-
"deprecated": true
4083-
},
4084-
"max_fragment_size": {
4085-
"type": [
4086-
"integer",
4087-
"null"
4088-
],
4089-
"format": "int32",
4090-
"description": "Maximum size of text fragments to extract when highlighting\ncontent (only works when \"include_content\" is true)",
4091-
"default": null,
4092-
"maximum": 150,
4093-
"minimum": 0
4094-
},
4095-
"max_fragments": {
4096-
"type": [
4097-
"integer",
4098-
"null"
4099-
],
4100-
"format": "int32",
4101-
"description": "Max number of highlighted fragments to extract per page",
4102-
"default": null,
4103-
"maximum": 100,
4104-
"minimum": 0
4105-
},
41064072
"max_pages": {
41074073
"type": [
41084074
"integer",
41094075
"null"
41104076
],
41114077
"format": "int32",
4112-
"description": "Maximum number of pages too return\n\nDeprecated: use the /search endpoint on the file itself with an offset instead",
4078+
"description": "Maximum number of pages too return per file",
41134079
"default": null,
4114-
"deprecated": true,
41154080
"maximum": 100,
41164081
"minimum": 0
41174082
},
@@ -4123,18 +4088,6 @@
41234088
"description": "Search only include a specific mime type",
41244089
"default": null
41254090
},
4126-
"modified": {
4127-
"oneOf": [
4128-
{
4129-
"type": "null"
4130-
},
4131-
{
4132-
"$ref": "#/components/schemas/SearchRange",
4133-
"description": "Modified date range search"
4134-
}
4135-
],
4136-
"default": null
4137-
},
41384091
"neural": {
41394092
"type": "boolean",
41404093
"description": "Enable searching with AI",
@@ -4400,6 +4353,7 @@
44004353
"null"
44014354
],
44024355
"description": "Name for the folder",
4356+
"maxLength": 255,
44034357
"minLength": 1
44044358
}
44054359
}
@@ -4422,6 +4376,7 @@
44224376
"null"
44234377
],
44244378
"description": "Name for the folder",
4379+
"maxLength": 255,
44254380
"minLength": 1
44264381
}
44274382
}
@@ -4444,6 +4399,7 @@
44444399
"null"
44454400
],
44464401
"description": "Name for the link",
4402+
"maxLength": 255,
44474403
"minLength": 1
44484404
},
44494405
"value": {
@@ -4471,6 +4427,13 @@
44714427
],
44724428
"description": "Whether to process the file asynchronously returning a task\nresponse instead of waiting for the upload"
44734429
},
4430+
"disable_mime_sniffing": {
4431+
"type": [
4432+
"boolean",
4433+
"null"
4434+
],
4435+
"description": "Whether to disable mime sniffing for the file. When false/not specified\nif a application/octet-stream mime type is provided the file name\nwill be used to attempt to determine the real mime type"
4436+
},
44744437
"file": {
44754438
"type": "array",
44764439
"items": {
@@ -4502,6 +4465,7 @@
45024465
},
45034466
"name": {
45044467
"type": "string",
4468+
"maxLength": 255,
45054469
"minLength": 1
45064470
},
45074471
"parent_id": {

0 commit comments

Comments
 (0)