Skip to content
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

Jump to bottom

docs: add docs for hubs #426

Merged
merged 2 commits into from
May 21, 2024
Merged

docs: add docs for hubs #426

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3b80925
docs: add docs for hubs
bszwarc May 21, 2024
9714ae3
docs: fix json file
bszwarc May 21, 2024
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
12 changes: 6 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": "http://www.apache.org/licenses/LICENSE-2.0"
},
"version": "2.0.0",
"x-box-commit-hash": "d7c72dc254"
"x-box-commit-hash": ""
},
"servers": [
{
Expand Down Expand Up @@ -10328,7 +10328,7 @@
},
{
"name": "mdfilters",
"description": "Limits the search results to any items for which the metadata matches the provided filter.\nThis parameter is a list that specifies exactly **one** metadata template used to filter the search results. \nIt is required unless the `query` parameter is provided.",
"description": "Limits the search results to any items for which the metadata matches the provided filter.\nThis parameter is a list that specifies exactly **one** metadata template used to filter the search results. \nThe parameter is required unless the `query` parameter is provided.",
"in": "query",
"example": [
{
Expand Down Expand Up @@ -19411,7 +19411,7 @@
"Legal hold policy assignments"
],
"x-box-tag": "legal_hold_policy_assignments",
"description": "Get a list of files with current file versions for a legal hold\nassignment.\n\nIn some cases you may want to get previous file versions instead. In these\ncases, use the `GET /legal_hold_policy_assignments/:id/file_versions_on_hold`\nAPI instead to return any previous versions of a file for this legal hold\npolicy assignment.\n\nDue to ongoing re-architecture efforts this API might not return all file\nversions held for this policy ID. Instead, this API will only return the\nlatest file version held in the newly developed architecture. The `GET\n/file_version_legal_holds` API can be used to fetch current and past versions\nof files held within the legacy architecture.\n\nThe `GET /legal_hold_policy_assignments?policy_id={id}` API can be used to\nfind a list of policy assignments for a given policy ID.",
"description": "Get a list of files with current file versions for a legal hold\nassignment.\n\nIn some cases you may want to get previous file versions instead. In these\ncases, use the `GET /legal_hold_policy_assignments/:id/file_versions_on_hold`\nAPI instead to return any previous versions of a file for this legal hold\npolicy assignment.\n\nDue to ongoing re-architecture efforts this API might not return all file\nversions held for this policy ID. Instead, this API will only return the\nlatest file version held in the newly developed architecture. The `GET\n/file_version_legal_holds` API can be used to fetch current and past versions\nof files held within the legacy architecture.\n\nThis endpoint does not support returning any content that is on hold due to\na Custodian collaborating on a Hub.\n\nThe `GET /legal_hold_policy_assignments?policy_id={id}` API can be used to\nfind a list of policy assignments for a given policy ID.",
"parameters": [
{
"name": "legal_hold_policy_assignment_id",
Expand Down Expand Up @@ -19617,7 +19617,7 @@
"Legal hold policy assignments"
],
"x-box-tag": "legal_hold_policy_assignments",
"description": "Get a list of previous file versions for a legal hold\nassignment.\n\nIn some cases you may only need the latest file versions instead. In these\ncases, use the `GET /legal_hold_policy_assignments/:id/files_on_hold` API\ninstead to return any current (latest) versions of a file for this legal hold\npolicy assignment.\n\nDue to ongoing re-architecture efforts this API might not return all files\nheld for this policy ID. Instead, this API will only return past file versions\nheld in the newly developed architecture. The `GET /file_version_legal_holds`\nAPI can be used to fetch current and past versions of files held within the\nlegacy architecture.\n\nThe `GET /legal_hold_policy_assignments?policy_id={id}` API can be used to\nfind a list of policy assignments for a given policy ID.",
"description": "Get a list of previous file versions for a legal hold\nassignment.\n\nIn some cases you may only need the latest file versions instead. In these\ncases, use the `GET /legal_hold_policy_assignments/:id/files_on_hold` API\ninstead to return any current (latest) versions of a file for this legal hold\npolicy assignment.\n\nDue to ongoing re-architecture efforts this API might not return all files\nheld for this policy ID. Instead, this API will only return past file versions\nheld in the newly developed architecture. The `GET /file_version_legal_holds`\nAPI can be used to fetch current and past versions of files held within the\nlegacy architecture.\n\nThis endpoint does not support returning any content that is on hold due to\na Custodian collaborating on a Hub.\n\nThe `GET /legal_hold_policy_assignments?policy_id={id}` API can be used to\nfind a list of policy assignments for a given policy ID.",
"parameters": [
{
"name": "legal_hold_policy_assignment_id",
Expand Down Expand Up @@ -36749,7 +36749,7 @@
"type": "string",
"nullable": true,
"example": "Box",
"description": "Used as an optional system name to appear in the signature log next to the signers who have been assigned an `embed_url_external_id`"
"description": "Used as an optional system name to appear in the signature log next to the signers who have been assigned the `embed_url_external_id`."
}
}
},
Expand Down Expand Up @@ -36806,7 +36806,7 @@
"prepare_url": {
"type": "string",
"example": "https://prepareurl.com",
"description": "This URL is returned if `is_document_preparation_needed` is\nset to `true` for Box Sign request. It is used to prepare a signature request\nusing the UI. The signature request is not sent until the preparation\nphase is complete.",
"description": "This URL is returned if `is_document_preparation_needed` is\nset to `true` in the request. The parameter is used to prepare\nthe signature request\nusing the UI. The signature request is not\nsent until the preparation\nphase is complete.",
"nullable": true
},
"signing_log": {
Expand Down
Loading