Skip to content

feat: add find app item for shared link endpoint #514

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

Merged
wsocha merged 1 commit into from
Mar 12, 2025
Merged

feat: add find app item for shared link endpoint #514

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
58 changes: 54 additions & 4 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": "http://www.apache.org/licenses/LICENSE-2.0"
},
"version": "2024.0",
"x-box-commit-hash": "37fc802212"
"x-box-commit-hash": "882e37ea44"
},
"servers": [
{
Expand Down Expand Up @@ -11529,7 +11529,7 @@
}
},
"304": {
"description": "Returns an empty response when the `If-None-Match` header matches\nthe current `etag` value of the folder. This indicates that the folder\nhas not changed since it was last requested."
"description": "Returns an empty response when the `If-None-Match` header matches\nthe current `etag` value of the file. This indicates that the file\nhas not changed since it was last requested."
},
"default": {
"description": "An unexpected client error.",
Expand Down Expand Up @@ -13528,7 +13528,7 @@
],
"responses": {
"200": {
"description": "Returns a full file resource if the shared link is valid and\nthe user has access to it.",
"description": "Returns a full web link resource if the shared link is valid and\nthe user has access to it.",
"content": {
"application/json": {
"schema": {
Expand All @@ -13538,7 +13538,7 @@
}
},
"304": {
"description": "Returns an empty response when the `If-None-Match` header matches\nthe current `etag` value of the folder. This indicates that the folder\nhas not changed since it was last requested."
"description": "Returns an empty response when the `If-None-Match` header matches\nthe current `etag` value of the web link. This indicates that the web link\nhas not changed since it was last requested."
},
"default": {
"description": "An unexpected client error.",
Expand Down Expand Up @@ -14215,6 +14215,51 @@
]
}
},
"/shared_items#app_items": {
"get": {
"operationId": "get_shared_items#app_items",
"summary": "Find app item for shared link",
"description": "Returns the app item represented by a shared link.\n\nThe link can originate from the current enterprise or another.",
"parameters": [
{
"name": "boxapi",
"in": "header",
"description": "A header containing the shared link and optional password for the\nshared link.\n\nThe format for this header is `shared_link=[link]&shared_link_password=[password]`",
"required": true,
"schema": {
"type": "string"
},
"example": "shared_link=[example.com]&shared_link_password=[xyz123]"
}
],
"responses": {
"200": {
"description": "Returns a full app item resource if the shared link is valid and\nthe user has access to it.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppItem"
}
}
}
},
"default": {
"description": "An unexpected client error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClientError"
}
}
}
}
},
"x-box-tag": "shared_links_app_items",
"tags": [
"Shared links (App Items)"
]
}
},
"/users": {
"get": {
"operationId": "get_users",
Expand Down Expand Up @@ -40977,6 +41022,11 @@
"description": "Web links for files are URLs that are generated\nfor web links in Box,\nwhich provide direct, read-only access to the resource.",
"x-box-tag": "shared_links_web_links"
},
{
"name": "Shared links (App Items)",
"description": "URLs generated for app items stored in Box,\nwhich provide direct, read-only access to the resource.",
"x-box-tag": "shared_links_app_items"
},
{
"name": "Shield information barriers",
"description": "Shield information barrier in Box defines an ethical wall.\nAn ethical wall is a mechanism that prevents exchanges or communication that\ncould lead to conflicts of interest and therefore result in\nbusiness activities ethically or legally questionable.",
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": "http://www.apache.org/licenses/LICENSE-2.0"
},
"version": "2025.0",
"x-box-commit-hash": "37fc802212"
"x-box-commit-hash": "882e37ea44"
},
"servers": [
{
Expand Down
58 changes: 54 additions & 4 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": "http://www.apache.org/licenses/LICENSE-2.0"
},
"version": "2024.0",
"x-box-commit-hash": "37fc802212"
"x-box-commit-hash": "882e37ea44"
},
"servers": [
{
Expand Down Expand Up @@ -11529,7 +11529,7 @@
}
},
"304": {
"description": "Returns an empty response when the `If-None-Match` header matches\nthe current `etag` value of the folder. This indicates that the folder\nhas not changed since it was last requested."
"description": "Returns an empty response when the `If-None-Match` header matches\nthe current `etag` value of the file. This indicates that the file\nhas not changed since it was last requested."
},
"default": {
"description": "An unexpected client error.",
Expand Down Expand Up @@ -13528,7 +13528,7 @@
],
"responses": {
"200": {
"description": "Returns a full file resource if the shared link is valid and\nthe user has access to it.",
"description": "Returns a full web link resource if the shared link is valid and\nthe user has access to it.",
"content": {
"application/json": {
"schema": {
Expand All @@ -13538,7 +13538,7 @@
}
},
"304": {
"description": "Returns an empty response when the `If-None-Match` header matches\nthe current `etag` value of the folder. This indicates that the folder\nhas not changed since it was last requested."
"description": "Returns an empty response when the `If-None-Match` header matches\nthe current `etag` value of the web link. This indicates that the web link\nhas not changed since it was last requested."
},
"default": {
"description": "An unexpected client error.",
Expand Down Expand Up @@ -14215,6 +14215,51 @@
]
}
},
"/shared_items#app_items": {
"get": {
"operationId": "get_shared_items#app_items",
"summary": "Find app item for shared link",
"description": "Returns the app item represented by a shared link.\n\nThe link can originate from the current enterprise or another.",
"parameters": [
{
"name": "boxapi",
"in": "header",
"description": "A header containing the shared link and optional password for the\nshared link.\n\nThe format for this header is `shared_link=[link]&shared_link_password=[password]`",
"required": true,
"schema": {
"type": "string"
},
"example": "shared_link=[example.com]&shared_link_password=[xyz123]"
}
],
"responses": {
"200": {
"description": "Returns a full app item resource if the shared link is valid and\nthe user has access to it.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppItem"
}
}
}
},
"default": {
"description": "An unexpected client error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClientError"
}
}
}
}
},
"x-box-tag": "shared_links_app_items",
"tags": [
"Shared links (App Items)"
]
}
},
"/users": {
"get": {
"operationId": "get_users",
Expand Down Expand Up @@ -40977,6 +41022,11 @@
"description": "Web links for files are URLs that are generated\nfor web links in Box,\nwhich provide direct, read-only access to the resource.",
"x-box-tag": "shared_links_web_links"
},
{
"name": "Shared links (App Items)",
"description": "URLs generated for app items stored in Box,\nwhich provide direct, read-only access to the resource.",
"x-box-tag": "shared_links_app_items"
},
{
"name": "Shield information barriers",
"description": "Shield information barrier in Box defines an ethical wall.\nAn ethical wall is a mechanism that prevents exchanges or communication that\ncould lead to conflicts of interest and therefore result in\nbusiness activities ethically or legally questionable.",
Expand Down