From 04c6908ffec4713dd402cbb89bbacfbcdb10ff87 Mon Sep 17 00:00:00 2001 From: box-apimgmt Date: Wed, 21 Jan 2026 09:51:59 -0800 Subject: [PATCH] fix: add missing tag to API resources --- openapi.json | 86 +++++++++++++++++++++--------------- openapi/openapi-v2025.0.json | 3 +- openapi/openapi.json | 86 +++++++++++++++++++++--------------- 3 files changed, 102 insertions(+), 73 deletions(-) diff --git a/openapi.json b/openapi.json index d54a4caa..b1847892 100644 --- a/openapi.json +++ b/openapi.json @@ -14,7 +14,7 @@ "url": "https://www.apache.org/licenses/LICENSE-2.0" }, "version": "2024.0", - "x-box-commit-hash": "abcd941c15" + "x-box-commit-hash": "17ccd50336" }, "servers": [ { @@ -126,7 +126,7 @@ "post": { "operationId": "post_oauth2_token", "summary": "Request access token", - "description": "Request an Access Token using either a client-side obtained OAuth 2.0\nauthorization code or a server-side JWT assertion.\n\nAn Access Token is a string that enables Box to verify that a\nrequest belongs to an authorized session. In the normal order of\noperations you will begin by requesting authentication from the\n[authorize](#get-authorize) endpoint and Box will send you an\nauthorization code.\n\nYou will then send this code to this endpoint to exchange it for\nan Access Token. The returned Access Token can then be used to to make\nBox API calls.", + "description": "Request an Access Token using either a client-side obtained OAuth 2.0\nauthorization code or a server-side JWT assertion.\n\nAn Access Token is a string that enables Box to verify that a\nrequest belongs to an authorized session. In the normal order of\noperations you will begin by requesting authentication from the\n[authorize](https://developer.box.com/reference/get-authorize) endpoint and Box will send you an\nauthorization code.\n\nYou will then send this code to this endpoint to exchange it for\nan Access Token. The returned Access Token can then be used to to make\nBox API calls.", "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -361,7 +361,7 @@ ], "responses": { "200": { - "description": "Returns a file object.\n\nNot all available fields are returned by default. Use the\n[fields](#param-fields) query parameter to explicitly request\nany specific fields.", + "description": "Returns a file object.\n\nNot all available fields are returned by default. Use the\n[fields](#parameter-fields) query parameter to explicitly request\nany specific fields.", "content": { "application/json": { "schema": { @@ -780,7 +780,7 @@ }, "responses": { "200": { - "description": "Returns a file object.\n\nNot all available fields are returned by default. Use the\n[fields](#param-fields) query parameter to explicitly request\nany specific fields.", + "description": "Returns a file object.\n\nNot all available fields are returned by default. Use the\n[fields](#parameter-fields) query parameter to explicitly request\nany specific fields.", "content": { "application/json": { "schema": { @@ -2248,7 +2248,7 @@ }, "responses": { "201": { - "description": "Returns a new file object representing the copied file.\n\nNot all available fields are returned by default. Use the\n[fields](#param-fields) query parameter to explicitly request\nany specific fields.", + "description": "Returns a new file object representing the copied file.\n\nNot all available fields are returned by default. Use the\n[fields](#parameter-fields) query parameter to explicitly request\nany specific fields.", "content": { "application/json": { "schema": { @@ -2992,7 +2992,7 @@ ], "responses": { "200": { - "description": "Returns a specific version of a file.\n\nNot all available fields are returned by default. Use the\n[fields](#param-fields) query parameter to explicitly request\nany specific fields.", + "description": "Returns a specific version of a file.\n\nNot all available fields are returned by default. Use the\n[fields](#parameter-fields) query parameter to explicitly request\nany specific fields.", "content": { "application/json": { "schema": { @@ -5028,7 +5028,7 @@ ], "responses": { "200": { - "description": "Returns a folder, including the first 100 entries in the folder.\nIf you used query parameters like\n`sort`, `direction`, `offset`, or `limit`\nthe *folder items list* will be affected accordingly.\n\nTo fetch more items within the folder, use the\n[Get items in a folder](https://developer.box.com/reference/get-folders-id-items)) endpoint.\n\nNot all available fields are returned by default. Use the\n[fields](#param-fields) query parameter to explicitly request\nany specific fields.", + "description": "Returns a folder, including the first 100 entries in the folder.\nIf you used query parameters like\n`sort`, `direction`, `offset`, or `limit`\nthe *folder items list* will be affected accordingly.\n\nTo fetch more items within the folder, use the\n[Get items in a folder](https://developer.box.com/reference/get-folders-id-items)) endpoint.\n\nNot all available fields are returned by default. Use the\n[fields](#parameter-fields) query parameter to explicitly request\nany specific fields.", "content": { "application/json": { "schema": { @@ -5440,7 +5440,7 @@ }, "responses": { "200": { - "description": "Returns a folder object for the updated folder\n\nNot all available fields are returned by default. Use the\n[fields](#param-fields) query parameter to explicitly request\nany specific fields.\n\nIf the user is moving folders with a large number of items in all of\ntheir descendants, the call will be run asynchronously. If the\noperation is not completed within 10 minutes, the user will receive\na 200 OK response, and the operation will continue running.", + "description": "Returns a folder object for the updated folder\n\nNot all available fields are returned by default. Use the\n[fields](#parameter-fields) query parameter to explicitly request\nany specific fields.\n\nIf the user is moving folders with a large number of items in all of\ntheir descendants, the call will be run asynchronously. If the\noperation is not completed within 10 minutes, the user will receive\na 200 OK response, and the operation will continue running.", "content": { "application/json": { "schema": { @@ -5736,7 +5736,7 @@ "get": { "operationId": "get_folders_id_items", "summary": "List items in folder", - "description": "Retrieves a page of items in a folder. These items can be files,\nfolders, and web links.\n\nTo request more information about the folder itself, like its size,\nuse the [Get a folder](#get-folders-id) endpoint instead.", + "description": "Retrieves a page of items in a folder. These items can be files,\nfolders, and web links.\n\nTo request more information about the folder itself, like its size,\nuse the [Get a folder](https://developer.box.com/reference/get-folders-id) endpoint instead.", "parameters": [ { "name": "folder_id", @@ -5942,7 +5942,7 @@ "type": "object", "properties": { "name": { - "description": "The name for the new folder.\n\nThe following restrictions to folder names apply: names containing\nnon-printable ASCII characters, forward and backward slashes\n(`/`, `\\`), names with trailing spaces, and names `.` and `..` are\nnot allowed.\n\nFolder names must be unique within their parent folder. The name check is case-insensitive, \nso a folder named `New Folder` cannot be created in a parent folder that already contains \na folder named `new folder`.", + "description": "The name for the new folder.\n\nThe following restrictions to folder names apply: names containing\nnon-printable ASCII characters, forward and backward slashes\n(`/`, `\\`), names with trailing spaces, and names `.` and `..` are\nnot allowed.\n\nFolder names must be unique within their parent folder. The name check is case-insensitive,\nso a folder named `New Folder` cannot be created in a parent folder that already contains\na folder named `new folder`.", "type": "string", "example": "New Folder", "maxLength": 255, @@ -6008,7 +6008,7 @@ }, "responses": { "201": { - "description": "Returns a folder object.\n\nNot all available fields are returned by default. Use the\n[fields](#param-fields) query parameter to explicitly request\nany specific fields.", + "description": "Returns a folder object.\n\nNot all available fields are returned by default. Use the\n[fields](#parameter-fields) query parameter to explicitly request\nany specific fields.", "content": { "application/json": { "schema": { @@ -6148,7 +6148,7 @@ }, "responses": { "201": { - "description": "Returns a new folder object representing the copied folder.\n\nNot all available fields are returned by default. Use the\n[fields](#param-fields) query parameter to explicitly request\nany specific fields.", + "description": "Returns a new folder object representing the copied folder.\n\nNot all available fields are returned by default. Use the\n[fields](#parameter-fields) query parameter to explicitly request\nany specific fields.", "content": { "application/json": { "schema": { @@ -9883,7 +9883,7 @@ }, "responses": { "201": { - "description": "Returns the newly created comment object.\n\nNot all available fields are returned by default. Use the\n[fields](#param-fields) query parameter to explicitly request\nany specific fields.", + "description": "Returns the newly created comment object.\n\nNot all available fields are returned by default. Use the\n[fields](#parameter-fields) query parameter to explicitly request\nany specific fields.", "content": { "application/json": { "schema": { @@ -14470,7 +14470,7 @@ ] }, "language": { - "description": "The language of the user, formatted in modified version of the\n[ISO 639-1](/guides/api-calls/language-codes) format.", + "description": "The language of the user, formatted in modified version of the\n[ISO 639-1](https://developer.box.com/guides/api-calls/language-codes) format.", "type": "string", "example": "en" }, @@ -14808,7 +14808,7 @@ ], "responses": { "200": { - "description": "Returns a single user object.\n\nNot all available fields are returned by default. Use the\n[fields](#param-fields) query parameter to explicitly request\nany specific fields using the [fields](#get-users-id--request--fields)\nparameter.", + "description": "Returns a single user object.\n\nNot all available fields are returned by default. Use the\n[fields](#parameter-fields) query parameter to explicitly request\nany specific fields using the [fields](#parameter-fields)\nparameter.", "content": { "application/json": { "schema": { @@ -14905,7 +14905,7 @@ ] }, "language": { - "description": "The language of the user, formatted in modified version of the\n[ISO 639-1](/guides/api-calls/language-codes) format.", + "description": "The language of the user, formatted in modified version of the\n[ISO 639-1](https://developer.box.com/guides/api-calls/language-codes) format.", "type": "string", "example": "en" }, @@ -17522,7 +17522,7 @@ "Events" ], "x-box-tag": "events", - "description": "Returns a list of real-time servers that can be used for long-polling updates\nto the [event stream](#get-events).\n\nLong polling is the concept where a HTTP request is kept open until the\nserver sends a response, then repeating the process over and over to receive\nupdated responses.\n\nLong polling the event stream can only be used for user events, not for\nenterprise events.\n\nTo use long polling, first use this endpoint to retrieve a list of long poll\nURLs. Next, make a long poll request to any of the provided URLs.\n\nWhen an event occurs in monitored account a response with the value\n`new_change` will be sent. The response contains no other details as\nit only serves as a prompt to take further action such as sending a\nrequest to the [events endpoint](#get-events) with the last known\n`stream_position`.\n\nAfter the server sends this response it closes the connection. You must now\nrepeat the long poll process to begin listening for events again.\n\nIf no events occur for a while and the connection times out you will\nreceive a response with the value `reconnect`. When you receive this response\nyou’ll make another call to this endpoint to restart the process.\n\nIf you receive no events in `retry_timeout` seconds then you will need to\nmake another request to the real-time server (one of the URLs in the response\nfor this endpoint). This might be necessary due to network errors.\n\nFinally, if you receive a `max_retries` error when making a request to the\nreal-time server, you should start over by making a call to this endpoint\nfirst.", + "description": "Returns a list of real-time servers that can be used for long-polling updates\nto the [event stream](https://developer.box.com/reference/get-events).\n\nLong polling is the concept where a HTTP request is kept open until the\nserver sends a response, then repeating the process over and over to receive\nupdated responses.\n\nLong polling the event stream can only be used for user events, not for\nenterprise events.\n\nTo use long polling, first use this endpoint to retrieve a list of long poll\nURLs. Next, make a long poll request to any of the provided URLs.\n\nWhen an event occurs in monitored account a response with the value\n`new_change` will be sent. The response contains no other details as\nit only serves as a prompt to take further action such as sending a\nrequest to the [events endpoint](https://developer.box.com/reference/get-events) with the last known\n`stream_position`.\n\nAfter the server sends this response it closes the connection. You must now\nrepeat the long poll process to begin listening for events again.\n\nIf no events occur for a while and the connection times out you will\nreceive a response with the value `reconnect`. When you receive this response\nyou’ll make another call to this endpoint to restart the process.\n\nIf you receive no events in `retry_timeout` seconds then you will need to\nmake another request to the real-time server (one of the URLs in the response\nfor this endpoint). This might be necessary due to network errors.\n\nFinally, if you receive a `max_retries` error when making a request to the\nreal-time server, you should start over by making a call to this endpoint\nfirst.", "responses": { "200": { "description": "Returns a paginated array of servers that can be used\ninstead of the regular endpoints for long-polling events.", @@ -29894,6 +29894,7 @@ ], "title": "Comment", "x-box-resource-id": "comment", + "x-box-tag": "comments", "x-box-variant": "standard" }, "Comment--Base": { @@ -29943,6 +29944,7 @@ ], "title": "Comment (Full)", "x-box-resource-id": "comment--full", + "x-box-tag": "comments", "x-box-variant": "full" }, "Comments": { @@ -30957,6 +30959,7 @@ ], "title": "File", "x-box-resource-id": "file", + "x-box-tag": "files", "x-box-variant": "standard" }, "File--Base": { @@ -31579,6 +31582,7 @@ ], "title": "File (Full)", "x-box-resource-id": "file--full", + "x-box-tag": "files", "x-box-variant": "full" }, "File--Mini": { @@ -31631,6 +31635,7 @@ "nullable": true, "title": "File (Mini)", "x-box-resource-id": "file--mini", + "x-box-tag": "files", "x-box-variant": "mini" }, "FileConflict": { @@ -32822,6 +32827,7 @@ ], "title": "Folder", "x-box-resource-id": "folder", + "x-box-tag": "folders", "x-box-variant": "standard" }, "Folder--Base": { @@ -33196,6 +33202,7 @@ ], "title": "Folder (Full)", "x-box-resource-id": "folder--full", + "x-box-tag": "folders", "x-box-variant": "full" }, "Folder--Mini": { @@ -33231,6 +33238,7 @@ ], "title": "Folder (Mini)", "x-box-resource-id": "folder--mini", + "x-box-tag": "folders", "x-box-variant": "mini" }, "FolderLock": { @@ -33397,6 +33405,7 @@ ], "title": "Group", "x-box-resource-id": "group", + "x-box-tag": "groups", "x-box-variant": "standard" }, "Group--Base": { @@ -33501,6 +33510,7 @@ ], "title": "Group (Full)", "x-box-resource-id": "group--full", + "x-box-tag": "groups", "x-box-variant": "full" }, "Group--Mini": { @@ -33531,6 +33541,7 @@ ], "title": "Group (Mini)", "x-box-resource-id": "group--mini", + "x-box-tag": "groups", "x-box-variant": "mini" }, "GroupMembership": { @@ -34704,6 +34715,7 @@ ], "title": "Legal hold policy", "x-box-resource-id": "legal_hold_policy", + "x-box-tag": "legal_hold_policies", "x-box-variant": "standard" }, "LegalHoldPolicy--Mini": { @@ -34971,7 +34983,7 @@ "example": "Aaron Levie" }, { - "description": "A value for each of the fields that are present\non the metadata template.\nFor the `global.properties` template this can be\na list of zero or more fields,\nas this template allows for any generic key-value pairs \nto be stored stored in the template." + "description": "A value for each of the fields that are present\non the metadata template.\nFor the `global.properties` template this can be\na list of zero or more fields,\nas this template allows for any generic key-value pairs\nto be stored stored in the template." } ], "x-box-example-key": "name" @@ -34980,6 +34992,7 @@ ], "title": "Metadata instance (Full)", "x-box-resource-id": "metadata--full", + "x-box-tag": "file_metadata", "x-box-variant": "full" }, "MetadataCascadePolicies": { @@ -36172,7 +36185,7 @@ "example": "10" }, "max_retries": { - "description": "The maximum number of retries this server will\nallow before a new long poll should be started by\ngetting a [new list of server](#options-events).", + "description": "The maximum number of retries this server will\nallow before a new long poll should be started by\ngetting a [new list of server](https://developer.box.com/reference/options-events).", "type": "string", "example": "10" }, @@ -36576,6 +36589,7 @@ ], "title": "Retention policy (Mini)", "x-box-resource-id": "retention_policy--mini", + "x-box-tag": "retention_policies", "x-box-variant": "mini" }, "RetentionPolicyAssignment": { @@ -37877,7 +37891,7 @@ "$ref": "#/components/schemas/Folder--Mini" }, { - "description": "The destination folder to place final, signed document and signing\nlog.\n\nWhen this value was not passed in when the signature request was \ncreated, then we will use a default folder which is either the parent\nfolder of the first source file in the payload if we have the permission\nto upload to that folder or a folder called \"My Sign Requests\"." + "description": "The destination folder to place final, signed document and signing\nlog.\n\nWhen this value was not passed in when the signature request was\ncreated, then we will use a default folder which is either the parent\nfolder of the first source file in the payload if we have the permission\nto upload to that folder or a folder called \"My Sign Requests\"." } ], "nullable": false @@ -37925,12 +37939,7 @@ ], "title": "Box Sign request", "x-box-resource-id": "sign_request", - "x-box-tag": "sign_requests", - "x-box-variant": "standard", - "x-box-variants": [ - "standard", - "base" - ] + "x-box-tag": "sign_requests" }, "SignRequest--Base": { "description": "A standard representation of a signature request object.", @@ -38016,13 +38025,7 @@ } }, "title": "Box Sign request (Base)", - "x-box-resource-id": "sign_request--base", - "x-box-tag": "sign_requests", - "x-box-variant": "base", - "x-box-variants": [ - "standard", - "base" - ] + "x-box-tag": "sign_requests" }, "SignRequestCreateRequest": { "description": "Creates a Box Sign request object.", @@ -38076,7 +38079,8 @@ "required": [ "signers" ], - "title": "Create a Box Sign request" + "title": "Create a Box Sign request", + "x-box-resource-id": "sign_request_create_request" }, "SignRequestCreateSigner": { "description": "The schema for a Signer object used in\nfor creating a Box Sign request object.", @@ -39183,6 +39187,7 @@ ], "title": "Storage policy", "x-box-resource-id": "storage_policy", + "x-box-tag": "storage_policies", "x-box-variant": "standard" }, "StoragePolicy--Mini": { @@ -39849,6 +39854,7 @@ ], "title": "Terms of service", "x-box-resource-id": "terms_of_service", + "x-box-tag": "terms_of_services", "x-box-variant": "standard" }, "TermsOfService--Base": { @@ -41699,6 +41705,7 @@ ], "title": "Upload part", "x-box-resource-id": "upload_part", + "x-box-tag": "chunked_uploads", "x-box-variant": "standard" }, "UploadPart--Mini": { @@ -41943,7 +41950,7 @@ "example": "2012-12-12T10:53:43-08:00" }, "language": { - "description": "The language of the user, formatted in modified version of the\n[ISO 639-1](/guides/api-calls/language-codes) format.", + "description": "The language of the user, formatted in modified version of the\n[ISO 639-1](https://developer.box.com/guides/api-calls/language-codes) format.", "type": "string", "example": "en" }, @@ -42027,6 +42034,7 @@ ], "title": "User", "x-box-resource-id": "user", + "x-box-tag": "users", "x-box-variant": "standard" }, "User--Base": { @@ -42095,7 +42103,8 @@ } ], "title": "User (Collaborations)", - "x-box-resource-id": "user_collaborations" + "x-box-resource-id": "user_collaborations", + "x-box-tag": "users" }, "User--Full": { "description": "A full representation of a user, as can be returned from any\nuser API endpoint.", @@ -42210,6 +42219,7 @@ ], "title": "User (Full)", "x-box-resource-id": "user--full", + "x-box-tag": "users", "x-box-variant": "full" }, "User--Mini": { @@ -42240,6 +42250,7 @@ ], "title": "User (Mini)", "x-box-resource-id": "user--mini", + "x-box-tag": "users", "x-box-variant": "mini" }, "UserAvatar": { @@ -42693,6 +42704,7 @@ ], "title": "Web link", "x-box-resource-id": "web_link", + "x-box-tag": "web_links", "x-box-variant": "standard" }, "WebLink--Base": { @@ -42769,6 +42781,7 @@ ], "title": "Web link (Mini)", "x-box-resource-id": "web_link--mini", + "x-box-tag": "web_links", "x-box-variant": "mini" }, "Webhook": { @@ -43218,6 +43231,7 @@ ], "title": "Workflow", "x-box-resource-id": "workflow", + "x-box-tag": "workflows", "x-box-variant": "standard" }, "Workflow--Mini": { diff --git a/openapi/openapi-v2025.0.json b/openapi/openapi-v2025.0.json index 69a2e02d..129f6409 100644 --- a/openapi/openapi-v2025.0.json +++ b/openapi/openapi-v2025.0.json @@ -14,7 +14,7 @@ "url": "https://www.apache.org/licenses/LICENSE-2.0" }, "version": "2025.0", - "x-box-commit-hash": "abcd941c15" + "x-box-commit-hash": "17ccd50336" }, "servers": [ { @@ -5500,6 +5500,7 @@ ], "title": "Box Hub", "x-box-resource-id": "hub_v2025.0", + "x-box-tag": "hubs", "x-box-variant": "standard" }, "Hub--Base": { diff --git a/openapi/openapi.json b/openapi/openapi.json index d54a4caa..b1847892 100644 --- a/openapi/openapi.json +++ b/openapi/openapi.json @@ -14,7 +14,7 @@ "url": "https://www.apache.org/licenses/LICENSE-2.0" }, "version": "2024.0", - "x-box-commit-hash": "abcd941c15" + "x-box-commit-hash": "17ccd50336" }, "servers": [ { @@ -126,7 +126,7 @@ "post": { "operationId": "post_oauth2_token", "summary": "Request access token", - "description": "Request an Access Token using either a client-side obtained OAuth 2.0\nauthorization code or a server-side JWT assertion.\n\nAn Access Token is a string that enables Box to verify that a\nrequest belongs to an authorized session. In the normal order of\noperations you will begin by requesting authentication from the\n[authorize](#get-authorize) endpoint and Box will send you an\nauthorization code.\n\nYou will then send this code to this endpoint to exchange it for\nan Access Token. The returned Access Token can then be used to to make\nBox API calls.", + "description": "Request an Access Token using either a client-side obtained OAuth 2.0\nauthorization code or a server-side JWT assertion.\n\nAn Access Token is a string that enables Box to verify that a\nrequest belongs to an authorized session. In the normal order of\noperations you will begin by requesting authentication from the\n[authorize](https://developer.box.com/reference/get-authorize) endpoint and Box will send you an\nauthorization code.\n\nYou will then send this code to this endpoint to exchange it for\nan Access Token. The returned Access Token can then be used to to make\nBox API calls.", "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -361,7 +361,7 @@ ], "responses": { "200": { - "description": "Returns a file object.\n\nNot all available fields are returned by default. Use the\n[fields](#param-fields) query parameter to explicitly request\nany specific fields.", + "description": "Returns a file object.\n\nNot all available fields are returned by default. Use the\n[fields](#parameter-fields) query parameter to explicitly request\nany specific fields.", "content": { "application/json": { "schema": { @@ -780,7 +780,7 @@ }, "responses": { "200": { - "description": "Returns a file object.\n\nNot all available fields are returned by default. Use the\n[fields](#param-fields) query parameter to explicitly request\nany specific fields.", + "description": "Returns a file object.\n\nNot all available fields are returned by default. Use the\n[fields](#parameter-fields) query parameter to explicitly request\nany specific fields.", "content": { "application/json": { "schema": { @@ -2248,7 +2248,7 @@ }, "responses": { "201": { - "description": "Returns a new file object representing the copied file.\n\nNot all available fields are returned by default. Use the\n[fields](#param-fields) query parameter to explicitly request\nany specific fields.", + "description": "Returns a new file object representing the copied file.\n\nNot all available fields are returned by default. Use the\n[fields](#parameter-fields) query parameter to explicitly request\nany specific fields.", "content": { "application/json": { "schema": { @@ -2992,7 +2992,7 @@ ], "responses": { "200": { - "description": "Returns a specific version of a file.\n\nNot all available fields are returned by default. Use the\n[fields](#param-fields) query parameter to explicitly request\nany specific fields.", + "description": "Returns a specific version of a file.\n\nNot all available fields are returned by default. Use the\n[fields](#parameter-fields) query parameter to explicitly request\nany specific fields.", "content": { "application/json": { "schema": { @@ -5028,7 +5028,7 @@ ], "responses": { "200": { - "description": "Returns a folder, including the first 100 entries in the folder.\nIf you used query parameters like\n`sort`, `direction`, `offset`, or `limit`\nthe *folder items list* will be affected accordingly.\n\nTo fetch more items within the folder, use the\n[Get items in a folder](https://developer.box.com/reference/get-folders-id-items)) endpoint.\n\nNot all available fields are returned by default. Use the\n[fields](#param-fields) query parameter to explicitly request\nany specific fields.", + "description": "Returns a folder, including the first 100 entries in the folder.\nIf you used query parameters like\n`sort`, `direction`, `offset`, or `limit`\nthe *folder items list* will be affected accordingly.\n\nTo fetch more items within the folder, use the\n[Get items in a folder](https://developer.box.com/reference/get-folders-id-items)) endpoint.\n\nNot all available fields are returned by default. Use the\n[fields](#parameter-fields) query parameter to explicitly request\nany specific fields.", "content": { "application/json": { "schema": { @@ -5440,7 +5440,7 @@ }, "responses": { "200": { - "description": "Returns a folder object for the updated folder\n\nNot all available fields are returned by default. Use the\n[fields](#param-fields) query parameter to explicitly request\nany specific fields.\n\nIf the user is moving folders with a large number of items in all of\ntheir descendants, the call will be run asynchronously. If the\noperation is not completed within 10 minutes, the user will receive\na 200 OK response, and the operation will continue running.", + "description": "Returns a folder object for the updated folder\n\nNot all available fields are returned by default. Use the\n[fields](#parameter-fields) query parameter to explicitly request\nany specific fields.\n\nIf the user is moving folders with a large number of items in all of\ntheir descendants, the call will be run asynchronously. If the\noperation is not completed within 10 minutes, the user will receive\na 200 OK response, and the operation will continue running.", "content": { "application/json": { "schema": { @@ -5736,7 +5736,7 @@ "get": { "operationId": "get_folders_id_items", "summary": "List items in folder", - "description": "Retrieves a page of items in a folder. These items can be files,\nfolders, and web links.\n\nTo request more information about the folder itself, like its size,\nuse the [Get a folder](#get-folders-id) endpoint instead.", + "description": "Retrieves a page of items in a folder. These items can be files,\nfolders, and web links.\n\nTo request more information about the folder itself, like its size,\nuse the [Get a folder](https://developer.box.com/reference/get-folders-id) endpoint instead.", "parameters": [ { "name": "folder_id", @@ -5942,7 +5942,7 @@ "type": "object", "properties": { "name": { - "description": "The name for the new folder.\n\nThe following restrictions to folder names apply: names containing\nnon-printable ASCII characters, forward and backward slashes\n(`/`, `\\`), names with trailing spaces, and names `.` and `..` are\nnot allowed.\n\nFolder names must be unique within their parent folder. The name check is case-insensitive, \nso a folder named `New Folder` cannot be created in a parent folder that already contains \na folder named `new folder`.", + "description": "The name for the new folder.\n\nThe following restrictions to folder names apply: names containing\nnon-printable ASCII characters, forward and backward slashes\n(`/`, `\\`), names with trailing spaces, and names `.` and `..` are\nnot allowed.\n\nFolder names must be unique within their parent folder. The name check is case-insensitive,\nso a folder named `New Folder` cannot be created in a parent folder that already contains\na folder named `new folder`.", "type": "string", "example": "New Folder", "maxLength": 255, @@ -6008,7 +6008,7 @@ }, "responses": { "201": { - "description": "Returns a folder object.\n\nNot all available fields are returned by default. Use the\n[fields](#param-fields) query parameter to explicitly request\nany specific fields.", + "description": "Returns a folder object.\n\nNot all available fields are returned by default. Use the\n[fields](#parameter-fields) query parameter to explicitly request\nany specific fields.", "content": { "application/json": { "schema": { @@ -6148,7 +6148,7 @@ }, "responses": { "201": { - "description": "Returns a new folder object representing the copied folder.\n\nNot all available fields are returned by default. Use the\n[fields](#param-fields) query parameter to explicitly request\nany specific fields.", + "description": "Returns a new folder object representing the copied folder.\n\nNot all available fields are returned by default. Use the\n[fields](#parameter-fields) query parameter to explicitly request\nany specific fields.", "content": { "application/json": { "schema": { @@ -9883,7 +9883,7 @@ }, "responses": { "201": { - "description": "Returns the newly created comment object.\n\nNot all available fields are returned by default. Use the\n[fields](#param-fields) query parameter to explicitly request\nany specific fields.", + "description": "Returns the newly created comment object.\n\nNot all available fields are returned by default. Use the\n[fields](#parameter-fields) query parameter to explicitly request\nany specific fields.", "content": { "application/json": { "schema": { @@ -14470,7 +14470,7 @@ ] }, "language": { - "description": "The language of the user, formatted in modified version of the\n[ISO 639-1](/guides/api-calls/language-codes) format.", + "description": "The language of the user, formatted in modified version of the\n[ISO 639-1](https://developer.box.com/guides/api-calls/language-codes) format.", "type": "string", "example": "en" }, @@ -14808,7 +14808,7 @@ ], "responses": { "200": { - "description": "Returns a single user object.\n\nNot all available fields are returned by default. Use the\n[fields](#param-fields) query parameter to explicitly request\nany specific fields using the [fields](#get-users-id--request--fields)\nparameter.", + "description": "Returns a single user object.\n\nNot all available fields are returned by default. Use the\n[fields](#parameter-fields) query parameter to explicitly request\nany specific fields using the [fields](#parameter-fields)\nparameter.", "content": { "application/json": { "schema": { @@ -14905,7 +14905,7 @@ ] }, "language": { - "description": "The language of the user, formatted in modified version of the\n[ISO 639-1](/guides/api-calls/language-codes) format.", + "description": "The language of the user, formatted in modified version of the\n[ISO 639-1](https://developer.box.com/guides/api-calls/language-codes) format.", "type": "string", "example": "en" }, @@ -17522,7 +17522,7 @@ "Events" ], "x-box-tag": "events", - "description": "Returns a list of real-time servers that can be used for long-polling updates\nto the [event stream](#get-events).\n\nLong polling is the concept where a HTTP request is kept open until the\nserver sends a response, then repeating the process over and over to receive\nupdated responses.\n\nLong polling the event stream can only be used for user events, not for\nenterprise events.\n\nTo use long polling, first use this endpoint to retrieve a list of long poll\nURLs. Next, make a long poll request to any of the provided URLs.\n\nWhen an event occurs in monitored account a response with the value\n`new_change` will be sent. The response contains no other details as\nit only serves as a prompt to take further action such as sending a\nrequest to the [events endpoint](#get-events) with the last known\n`stream_position`.\n\nAfter the server sends this response it closes the connection. You must now\nrepeat the long poll process to begin listening for events again.\n\nIf no events occur for a while and the connection times out you will\nreceive a response with the value `reconnect`. When you receive this response\nyou’ll make another call to this endpoint to restart the process.\n\nIf you receive no events in `retry_timeout` seconds then you will need to\nmake another request to the real-time server (one of the URLs in the response\nfor this endpoint). This might be necessary due to network errors.\n\nFinally, if you receive a `max_retries` error when making a request to the\nreal-time server, you should start over by making a call to this endpoint\nfirst.", + "description": "Returns a list of real-time servers that can be used for long-polling updates\nto the [event stream](https://developer.box.com/reference/get-events).\n\nLong polling is the concept where a HTTP request is kept open until the\nserver sends a response, then repeating the process over and over to receive\nupdated responses.\n\nLong polling the event stream can only be used for user events, not for\nenterprise events.\n\nTo use long polling, first use this endpoint to retrieve a list of long poll\nURLs. Next, make a long poll request to any of the provided URLs.\n\nWhen an event occurs in monitored account a response with the value\n`new_change` will be sent. The response contains no other details as\nit only serves as a prompt to take further action such as sending a\nrequest to the [events endpoint](https://developer.box.com/reference/get-events) with the last known\n`stream_position`.\n\nAfter the server sends this response it closes the connection. You must now\nrepeat the long poll process to begin listening for events again.\n\nIf no events occur for a while and the connection times out you will\nreceive a response with the value `reconnect`. When you receive this response\nyou’ll make another call to this endpoint to restart the process.\n\nIf you receive no events in `retry_timeout` seconds then you will need to\nmake another request to the real-time server (one of the URLs in the response\nfor this endpoint). This might be necessary due to network errors.\n\nFinally, if you receive a `max_retries` error when making a request to the\nreal-time server, you should start over by making a call to this endpoint\nfirst.", "responses": { "200": { "description": "Returns a paginated array of servers that can be used\ninstead of the regular endpoints for long-polling events.", @@ -29894,6 +29894,7 @@ ], "title": "Comment", "x-box-resource-id": "comment", + "x-box-tag": "comments", "x-box-variant": "standard" }, "Comment--Base": { @@ -29943,6 +29944,7 @@ ], "title": "Comment (Full)", "x-box-resource-id": "comment--full", + "x-box-tag": "comments", "x-box-variant": "full" }, "Comments": { @@ -30957,6 +30959,7 @@ ], "title": "File", "x-box-resource-id": "file", + "x-box-tag": "files", "x-box-variant": "standard" }, "File--Base": { @@ -31579,6 +31582,7 @@ ], "title": "File (Full)", "x-box-resource-id": "file--full", + "x-box-tag": "files", "x-box-variant": "full" }, "File--Mini": { @@ -31631,6 +31635,7 @@ "nullable": true, "title": "File (Mini)", "x-box-resource-id": "file--mini", + "x-box-tag": "files", "x-box-variant": "mini" }, "FileConflict": { @@ -32822,6 +32827,7 @@ ], "title": "Folder", "x-box-resource-id": "folder", + "x-box-tag": "folders", "x-box-variant": "standard" }, "Folder--Base": { @@ -33196,6 +33202,7 @@ ], "title": "Folder (Full)", "x-box-resource-id": "folder--full", + "x-box-tag": "folders", "x-box-variant": "full" }, "Folder--Mini": { @@ -33231,6 +33238,7 @@ ], "title": "Folder (Mini)", "x-box-resource-id": "folder--mini", + "x-box-tag": "folders", "x-box-variant": "mini" }, "FolderLock": { @@ -33397,6 +33405,7 @@ ], "title": "Group", "x-box-resource-id": "group", + "x-box-tag": "groups", "x-box-variant": "standard" }, "Group--Base": { @@ -33501,6 +33510,7 @@ ], "title": "Group (Full)", "x-box-resource-id": "group--full", + "x-box-tag": "groups", "x-box-variant": "full" }, "Group--Mini": { @@ -33531,6 +33541,7 @@ ], "title": "Group (Mini)", "x-box-resource-id": "group--mini", + "x-box-tag": "groups", "x-box-variant": "mini" }, "GroupMembership": { @@ -34704,6 +34715,7 @@ ], "title": "Legal hold policy", "x-box-resource-id": "legal_hold_policy", + "x-box-tag": "legal_hold_policies", "x-box-variant": "standard" }, "LegalHoldPolicy--Mini": { @@ -34971,7 +34983,7 @@ "example": "Aaron Levie" }, { - "description": "A value for each of the fields that are present\non the metadata template.\nFor the `global.properties` template this can be\na list of zero or more fields,\nas this template allows for any generic key-value pairs \nto be stored stored in the template." + "description": "A value for each of the fields that are present\non the metadata template.\nFor the `global.properties` template this can be\na list of zero or more fields,\nas this template allows for any generic key-value pairs\nto be stored stored in the template." } ], "x-box-example-key": "name" @@ -34980,6 +34992,7 @@ ], "title": "Metadata instance (Full)", "x-box-resource-id": "metadata--full", + "x-box-tag": "file_metadata", "x-box-variant": "full" }, "MetadataCascadePolicies": { @@ -36172,7 +36185,7 @@ "example": "10" }, "max_retries": { - "description": "The maximum number of retries this server will\nallow before a new long poll should be started by\ngetting a [new list of server](#options-events).", + "description": "The maximum number of retries this server will\nallow before a new long poll should be started by\ngetting a [new list of server](https://developer.box.com/reference/options-events).", "type": "string", "example": "10" }, @@ -36576,6 +36589,7 @@ ], "title": "Retention policy (Mini)", "x-box-resource-id": "retention_policy--mini", + "x-box-tag": "retention_policies", "x-box-variant": "mini" }, "RetentionPolicyAssignment": { @@ -37877,7 +37891,7 @@ "$ref": "#/components/schemas/Folder--Mini" }, { - "description": "The destination folder to place final, signed document and signing\nlog.\n\nWhen this value was not passed in when the signature request was \ncreated, then we will use a default folder which is either the parent\nfolder of the first source file in the payload if we have the permission\nto upload to that folder or a folder called \"My Sign Requests\"." + "description": "The destination folder to place final, signed document and signing\nlog.\n\nWhen this value was not passed in when the signature request was\ncreated, then we will use a default folder which is either the parent\nfolder of the first source file in the payload if we have the permission\nto upload to that folder or a folder called \"My Sign Requests\"." } ], "nullable": false @@ -37925,12 +37939,7 @@ ], "title": "Box Sign request", "x-box-resource-id": "sign_request", - "x-box-tag": "sign_requests", - "x-box-variant": "standard", - "x-box-variants": [ - "standard", - "base" - ] + "x-box-tag": "sign_requests" }, "SignRequest--Base": { "description": "A standard representation of a signature request object.", @@ -38016,13 +38025,7 @@ } }, "title": "Box Sign request (Base)", - "x-box-resource-id": "sign_request--base", - "x-box-tag": "sign_requests", - "x-box-variant": "base", - "x-box-variants": [ - "standard", - "base" - ] + "x-box-tag": "sign_requests" }, "SignRequestCreateRequest": { "description": "Creates a Box Sign request object.", @@ -38076,7 +38079,8 @@ "required": [ "signers" ], - "title": "Create a Box Sign request" + "title": "Create a Box Sign request", + "x-box-resource-id": "sign_request_create_request" }, "SignRequestCreateSigner": { "description": "The schema for a Signer object used in\nfor creating a Box Sign request object.", @@ -39183,6 +39187,7 @@ ], "title": "Storage policy", "x-box-resource-id": "storage_policy", + "x-box-tag": "storage_policies", "x-box-variant": "standard" }, "StoragePolicy--Mini": { @@ -39849,6 +39854,7 @@ ], "title": "Terms of service", "x-box-resource-id": "terms_of_service", + "x-box-tag": "terms_of_services", "x-box-variant": "standard" }, "TermsOfService--Base": { @@ -41699,6 +41705,7 @@ ], "title": "Upload part", "x-box-resource-id": "upload_part", + "x-box-tag": "chunked_uploads", "x-box-variant": "standard" }, "UploadPart--Mini": { @@ -41943,7 +41950,7 @@ "example": "2012-12-12T10:53:43-08:00" }, "language": { - "description": "The language of the user, formatted in modified version of the\n[ISO 639-1](/guides/api-calls/language-codes) format.", + "description": "The language of the user, formatted in modified version of the\n[ISO 639-1](https://developer.box.com/guides/api-calls/language-codes) format.", "type": "string", "example": "en" }, @@ -42027,6 +42034,7 @@ ], "title": "User", "x-box-resource-id": "user", + "x-box-tag": "users", "x-box-variant": "standard" }, "User--Base": { @@ -42095,7 +42103,8 @@ } ], "title": "User (Collaborations)", - "x-box-resource-id": "user_collaborations" + "x-box-resource-id": "user_collaborations", + "x-box-tag": "users" }, "User--Full": { "description": "A full representation of a user, as can be returned from any\nuser API endpoint.", @@ -42210,6 +42219,7 @@ ], "title": "User (Full)", "x-box-resource-id": "user--full", + "x-box-tag": "users", "x-box-variant": "full" }, "User--Mini": { @@ -42240,6 +42250,7 @@ ], "title": "User (Mini)", "x-box-resource-id": "user--mini", + "x-box-tag": "users", "x-box-variant": "mini" }, "UserAvatar": { @@ -42693,6 +42704,7 @@ ], "title": "Web link", "x-box-resource-id": "web_link", + "x-box-tag": "web_links", "x-box-variant": "standard" }, "WebLink--Base": { @@ -42769,6 +42781,7 @@ ], "title": "Web link (Mini)", "x-box-resource-id": "web_link--mini", + "x-box-tag": "web_links", "x-box-variant": "mini" }, "Webhook": { @@ -43218,6 +43231,7 @@ ], "title": "Workflow", "x-box-resource-id": "workflow", + "x-box-tag": "workflows", "x-box-variant": "standard" }, "Workflow--Mini": {