Skip to content

Commit

Permalink
docs: add docs for hubs (box/box-openapi#426)
Browse files Browse the repository at this point in the history
  • Loading branch information
box-sdk-build committed May 21, 2024
1 parent 1d8597a commit 9275533
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .codegen.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{ "engineHash": "52af7c9", "specHash": "6c3dd22", "version": "0.3.1" }
{ "engineHash": "52af7c9", "specHash": "cb70223", "version": "0.3.1" }
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,9 @@ public async System.Threading.Tasks.Task DeleteLegalHoldPolicyAssignmentByIdAsyn
/// /file_version_legal_holds` API can be used to fetch current and past versions
/// of files held within the legacy architecture.
///
/// This endpoint does not support returning any content that is on hold due to
/// a Custodian collaborating on a Hub.
///
/// The `GET /legal_hold_policy_assignments?policy_id={id}` API can be used to
/// find a list of policy assignments for a given policy ID.
/// </summary>
Expand Down
2 changes: 1 addition & 1 deletion Box.Sdk.Gen/Managers/Search/SearchForContentQueryParams.cs
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ public class SearchForContentQueryParams {
/// <summary>
/// Limits the search results to any items for which the metadata matches the provided filter.
/// This parameter is a list that specifies exactly **one** metadata template used to filter the search results.
/// It is required unless the `query` parameter is provided.
/// The parameter is required unless the `query` parameter is provided.
/// </summary>
public IReadOnlyList<MetadataFilter>? Mdfilters { get; init; }

Expand Down
6 changes: 4 additions & 2 deletions Box.Sdk.Gen/Schemas/SignRequest/SignRequest.cs
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,10 @@ public class SignRequest : SignRequestBase {

/// <summary>
/// This URL is returned if `is_document_preparation_needed` is
/// set to `true` for Box Sign request. It is used to prepare a signature request
/// using the UI. The signature request is not sent until the preparation
/// set to `true` in the request. The parameter is used to prepare
/// the signature request
/// using the UI. The signature request is not
/// sent until the preparation
/// phase is complete.
/// </summary>
[JsonPropertyName("prepare_url")]
Expand Down
2 changes: 1 addition & 1 deletion Box.Sdk.Gen/Schemas/SignRequestBase/SignRequestBase.cs
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ public class SignRequestBase {
public string? TemplateId { get; init; }

/// <summary>
/// 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`
/// 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`.
/// </summary>
[JsonPropertyName("external_system_name")]
public string? ExternalSystemName { get; init; }
Expand Down
3 changes: 3 additions & 0 deletions docs/LegalHoldPolicyAssignments.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,9 @@ latest file version held in the newly developed architecture. The `GET
/file_version_legal_holds` API can be used to fetch current and past versions
of files held within the legacy architecture.

This endpoint does not support returning any content that is on hold due to
a Custodian collaborating on a Hub.

The `GET /legal_hold_policy_assignments?policy_id={id}` API can be used to
find a list of policy assignments for a given policy ID.

Expand Down

0 comments on commit 9275533

Please sign in to comment.