Skip to content

feat: Move cancel sign request schema from v2 to OAS #583

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
box-apimgmt wants to merge 1 commit into from
Closed

feat: Move cancel sign request schema from v2 to OAS #583

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
118 changes: 112 additions & 6 deletions openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"url": "https://www.apache.org/licenses/LICENSE-2.0"
},
"version": "2024.0",
"x-box-commit-hash": "c8490cfcb1"
"x-box-commit-hash": "0083604302"
},
"servers": [
{
Expand Down Expand Up @@ -3708,7 +3708,7 @@
}
}
},
"403": {
"400": {
"description": "Returned when the request parameters are not valid.",
"content": {
"application/json": {
Expand Down Expand Up @@ -5004,7 +5004,7 @@
{
"name": "offset",
"in": "query",
"description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.",
"description": "The offset of the item at which to begin the response.\n\nOffset-based pagination is not guaranteed to work reliably for high offset values and may fail for large datasets. In\nthose cases, reduce the number of items in the folder (for example, by\nrestructuring the folder into smaller subfolders) before retrying the\nrequest.",
"required": false,
"schema": {
"type": "integer",
Expand Down Expand Up @@ -5790,7 +5790,7 @@
{
"name": "offset",
"in": "query",
"description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.",
"description": "The offset of the item at which to begin the response.\n\nOffset-based pagination is not guaranteed to work reliably for high offset values and may fail for large datasets. In\nthose cases, use marker-based pagination by setting `usemarker` to `true`.",
"required": false,
"schema": {
"type": "integer",
Expand Down Expand Up @@ -7401,7 +7401,7 @@
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Items"
"$ref": "#/components/schemas/TrashedItems"
}
}
}
Expand Down Expand Up @@ -23256,6 +23256,16 @@
"example": "33243242"
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SignRequestCancelRequest"
}
}
}
},
"responses": {
"200": {
"description": "Returns a Sign Request object.",
Expand Down Expand Up @@ -27509,7 +27519,7 @@
"example": "done"
},
"confidence_score": {
"description": "The confidence score numeric values for each extracted field as a JSON dictionary. This can be empty if no field could be extracted.",
"description": "The confidence score levels and numeric values for each extracted field as a JSON dictionary. This can be empty if no field could be extracted.",
"type": "object",
"additionalProperties": {}
},
Expand Down Expand Up @@ -36011,6 +36021,27 @@
],
"title": "Outcome"
},
"PaginationOrderItem": {
"description": "The order in which a pagination is ordered.",
"type": "object",
"properties": {
"by": {
"description": "The field to order by.",
"type": "string",
"example": "type"
},
"direction": {
"description": "The direction to order by, either ascending or descending.",
"type": "string",
"example": "ASC",
"enum": [
"ASC",
"DESC"
]
}
},
"title": "Pagination order item"
},
"PostOAuth2Revoke": {
"description": "A request to revoke an OAuth 2.0 token.",
"type": "object",
Expand Down Expand Up @@ -38049,6 +38080,18 @@
"title": "Box Sign request (Base)",
"x-box-tag": "sign_requests"
},
"SignRequestCancelRequest": {
"description": "Request body for cancelling a sign request.",
"type": "object",
"properties": {
"reason": {
"description": "An optional reason for cancelling the sign request.",
"type": "string",
"example": "Project cancelled"
}
},
"title": "Sign request cancel request"
},
"SignRequestCreateRequest": {
"description": "Creates a Box Sign request object.",
"type": "object",
Expand Down Expand Up @@ -41708,6 +41751,69 @@
"x-box-resource-id": "trash_web_link_restored",
"x-box-tag": "trashed_web_links"
},
"TrashedItems": {
"description": "A list of files, folders, and web links in\ntheir mini representation.",
"type": "object",
"allOf": [
{
"type": "object",
"description": "The part of an API response that describes pagination.",
"properties": {
"limit": {
"description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.",
"type": "integer",
"format": "int64",
"example": 1000
},
"next_marker": {
"description": "The marker for the start of the next page of results.",
"type": "string",
"example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
"nullable": true
},
"prev_marker": {
"description": "The marker for the start of the previous page of results.",
"type": "string",
"example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
"nullable": true
},
"total_count": {
"description": "One greater than the offset of the last entry in the entire collection.\nThe total number of entries in the collection may be less than\n`total_count`.\n\nFor example, when a user deletes items in a folder they collaborate on and are\nthen removed as a collaborator, deleted items will no longer appear in this\nendpoint’s results for that user. In such cases, the number of items in\nentries may be less than the value in `total_count`.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted.",
"type": "integer",
"format": "int64",
"example": 5000
},
"offset": {
"description": "The 0-based offset of the first entry in this set. This will be the same\nas the `offset` query parameter.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted.",
"type": "integer",
"format": "int64",
"example": 2000
},
"order": {
"description": "The order by which items are returned.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted.",
"type": "array",
"items": {
"$ref": "#/components/schemas/PaginationOrderItem"
}
}
}
},
{
"properties": {
"entries": {
"description": "The items in this collection.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Item"
}
}
}
}
],
"title": "Trashed items",
"x-box-resource-id": "trashed_items",
"x-box-tag": "trashed_items"
},
"UploadPart": {
"description": "The representation of an upload\nsession chunk.",
"type": "object",
Expand Down
2 changes: 1 addition & 1 deletion openapi/openapi-v2025.0.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"url": "https://www.apache.org/licenses/LICENSE-2.0"
},
"version": "2025.0",
"x-box-commit-hash": "c8490cfcb1"
"x-box-commit-hash": "0083604302"
},
"servers": [
{
Expand Down
118 changes: 112 additions & 6 deletions openapi/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"url": "https://www.apache.org/licenses/LICENSE-2.0"
},
"version": "2024.0",
"x-box-commit-hash": "c8490cfcb1"
"x-box-commit-hash": "0083604302"
},
"servers": [
{
Expand Down Expand Up @@ -3708,7 +3708,7 @@
}
}
},
"403": {
"400": {
"description": "Returned when the request parameters are not valid.",
"content": {
"application/json": {
Expand Down Expand Up @@ -5004,7 +5004,7 @@
{
"name": "offset",
"in": "query",
"description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.",
"description": "The offset of the item at which to begin the response.\n\nOffset-based pagination is not guaranteed to work reliably for high offset values and may fail for large datasets. In\nthose cases, reduce the number of items in the folder (for example, by\nrestructuring the folder into smaller subfolders) before retrying the\nrequest.",
"required": false,
"schema": {
"type": "integer",
Expand Down Expand Up @@ -5790,7 +5790,7 @@
{
"name": "offset",
"in": "query",
"description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.",
"description": "The offset of the item at which to begin the response.\n\nOffset-based pagination is not guaranteed to work reliably for high offset values and may fail for large datasets. In\nthose cases, use marker-based pagination by setting `usemarker` to `true`.",
"required": false,
"schema": {
"type": "integer",
Expand Down Expand Up @@ -7401,7 +7401,7 @@
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Items"
"$ref": "#/components/schemas/TrashedItems"
}
}
}
Expand Down Expand Up @@ -23256,6 +23256,16 @@
"example": "33243242"
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SignRequestCancelRequest"
}
}
}
},
"responses": {
"200": {
"description": "Returns a Sign Request object.",
Expand Down Expand Up @@ -27509,7 +27519,7 @@
"example": "done"
},
"confidence_score": {
"description": "The confidence score numeric values for each extracted field as a JSON dictionary. This can be empty if no field could be extracted.",
"description": "The confidence score levels and numeric values for each extracted field as a JSON dictionary. This can be empty if no field could be extracted.",
"type": "object",
"additionalProperties": {}
},
Expand Down Expand Up @@ -36011,6 +36021,27 @@
],
"title": "Outcome"
},
"PaginationOrderItem": {
"description": "The order in which a pagination is ordered.",
"type": "object",
"properties": {
"by": {
"description": "The field to order by.",
"type": "string",
"example": "type"
},
"direction": {
"description": "The direction to order by, either ascending or descending.",
"type": "string",
"example": "ASC",
"enum": [
"ASC",
"DESC"
]
}
},
"title": "Pagination order item"
},
"PostOAuth2Revoke": {
"description": "A request to revoke an OAuth 2.0 token.",
"type": "object",
Expand Down Expand Up @@ -38049,6 +38080,18 @@
"title": "Box Sign request (Base)",
"x-box-tag": "sign_requests"
},
"SignRequestCancelRequest": {
"description": "Request body for cancelling a sign request.",
"type": "object",
"properties": {
"reason": {
"description": "An optional reason for cancelling the sign request.",
"type": "string",
"example": "Project cancelled"
}
},
"title": "Sign request cancel request"
},
"SignRequestCreateRequest": {
"description": "Creates a Box Sign request object.",
"type": "object",
Expand Down Expand Up @@ -41708,6 +41751,69 @@
"x-box-resource-id": "trash_web_link_restored",
"x-box-tag": "trashed_web_links"
},
"TrashedItems": {
"description": "A list of files, folders, and web links in\ntheir mini representation.",
"type": "object",
"allOf": [
{
"type": "object",
"description": "The part of an API response that describes pagination.",
"properties": {
"limit": {
"description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.",
"type": "integer",
"format": "int64",
"example": 1000
},
"next_marker": {
"description": "The marker for the start of the next page of results.",
"type": "string",
"example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
"nullable": true
},
"prev_marker": {
"description": "The marker for the start of the previous page of results.",
"type": "string",
"example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
"nullable": true
},
"total_count": {
"description": "One greater than the offset of the last entry in the entire collection.\nThe total number of entries in the collection may be less than\n`total_count`.\n\nFor example, when a user deletes items in a folder they collaborate on and are\nthen removed as a collaborator, deleted items will no longer appear in this\nendpoint’s results for that user. In such cases, the number of items in\nentries may be less than the value in `total_count`.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted.",
"type": "integer",
"format": "int64",
"example": 5000
},
"offset": {
"description": "The 0-based offset of the first entry in this set. This will be the same\nas the `offset` query parameter.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted.",
"type": "integer",
"format": "int64",
"example": 2000
},
"order": {
"description": "The order by which items are returned.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted.",
"type": "array",
"items": {
"$ref": "#/components/schemas/PaginationOrderItem"
}
}
}
},
{
"properties": {
"entries": {
"description": "The items in this collection.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Item"
}
}
}
}
],
"title": "Trashed items",
"x-box-resource-id": "trashed_items",
"x-box-tag": "trashed_items"
},
"UploadPart": {
"description": "The representation of an upload\nsession chunk.",
"type": "object",
Expand Down