Skip to content

feat: Add metadata assignment target to the legal holds API #625

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
lukaszsocha2 merged 1 commit into from
Nov 4, 2026
Merged

feat: Add metadata assignment target to the legal holds API #625

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
56 changes: 50 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": "0274a35f73"
"x-box-commit-hash": "e34422e289"
},
"servers": [
{
Expand Down Expand Up @@ -19787,7 +19787,8 @@
"folder",
"user",
"ownership",
"interactions"
"interactions",
"metadata_template"
]
},
"example": "file"
Expand Down Expand Up @@ -19873,7 +19874,7 @@
"post": {
"operationId": "post_legal_hold_policy_assignments",
"summary": "Assign legal hold policy",
"description": "Assign a legal hold to an item type of: file, file version, folder, user, ownership, or interactions.",
"description": "Assign a legal hold to an item type of: file, file version, folder, user, ownership, interactions, or metadata template.",
"requestBody": {
"content": {
"application/json": {
Expand All @@ -19899,7 +19900,8 @@
"folder",
"user",
"ownership",
"interactions"
"interactions",
"metadata_template"
]
},
"id": {
Expand All @@ -19912,6 +19914,13 @@
"type",
"id"
]
},
"filter_fields": {
"description": "List of metadata template field filters. Only required when `assign_to.type` is `metadata_template`.",
"type": "array",
"items": {
"$ref": "#/components/schemas/LegalHoldPolicyAssignmentFilterField"
}
}
},
"required": [
Expand Down Expand Up @@ -35493,6 +35502,12 @@
"type": "integer",
"format": "int64",
"example": 6
},
"metadata_template": {
"description": "The number of metadata templates this policy is applied to.",
"type": "integer",
"format": "int64",
"example": 1
}
}
},
Expand Down Expand Up @@ -35595,7 +35610,8 @@
"folder",
"user",
"ownership",
"interactions"
"interactions",
"metadata_template"
]
},
"id": {
Expand All @@ -35611,7 +35627,7 @@
"title": "Legal hold policy item"
},
"LegalHoldPolicyAssignment": {
"description": "Legal Hold Assignments are used to assign Legal Hold\nPolicies to an item type of: Users, Folders, Files, File Versions, Ownership, or Interactions.\n\nCreating a Legal Hold Assignment puts a hold\non the File-Versions that belong to the Assignment's\n'apply-to' entity.",
"description": "Legal Hold Assignments are used to assign Legal Hold\nPolicies to an item type of: Users, Folders, Files, File Versions, Ownership, Interactions, or Metadata Templates.\n\nCreating a Legal Hold Assignment puts a hold\non the File-Versions that belong to the Assignment's\n'apply-to' entity.",
"type": "object",
"allOf": [
{
Expand Down Expand Up @@ -35660,6 +35676,13 @@
"type": "string",
"format": "date-time",
"example": "2012-12-12T10:53:43-08:00"
},
"filter_fields": {
"description": "List of metadata template field filters. Only present when `assigned_to.type` is `metadata_template`.",
"type": "array",
"items": {
"$ref": "#/components/schemas/LegalHoldPolicyAssignmentFilterField"
}
}
}
}
Expand Down Expand Up @@ -35695,6 +35718,27 @@
"standard"
]
},
"LegalHoldPolicyAssignmentFilterField": {
"description": "A metadata template field filter for a legal hold policy assignment.",
"type": "object",
"properties": {
"field": {
"description": "The ID of the metadata template field to filter on.",
"type": "string",
"example": "a0f4ee4e-1dc1-4h90-a8a9-aef55fc681d4"
},
"value": {
"description": "The value of the metadata template field to filter on.",
"type": "string",
"example": "0c27b756-0p87-4fe0-a43a-59fb661ccc4e"
}
},
"required": [
"field",
"value"
],
"title": "Legal hold policy assignment filter field"
},
"LegalHoldPolicyAssignments": {
"description": "A list of legal hold policies assignments.",
"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": "0274a35f73"
"x-box-commit-hash": "e34422e289"
},
"servers": [
{
Expand Down
2 changes: 1 addition & 1 deletion openapi/openapi-v2026.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": "2026.0",
"x-box-commit-hash": "0274a35f73"
"x-box-commit-hash": "e34422e289"
},
"servers": [
{
Expand Down
56 changes: 50 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": "0274a35f73"
"x-box-commit-hash": "e34422e289"
},
"servers": [
{
Expand Down Expand Up @@ -19787,7 +19787,8 @@
"folder",
"user",
"ownership",
"interactions"
"interactions",
"metadata_template"
]
},
"example": "file"
Expand Down Expand Up @@ -19873,7 +19874,7 @@
"post": {
"operationId": "post_legal_hold_policy_assignments",
"summary": "Assign legal hold policy",
"description": "Assign a legal hold to an item type of: file, file version, folder, user, ownership, or interactions.",
"description": "Assign a legal hold to an item type of: file, file version, folder, user, ownership, interactions, or metadata template.",
"requestBody": {
"content": {
"application/json": {
Expand All @@ -19899,7 +19900,8 @@
"folder",
"user",
"ownership",
"interactions"
"interactions",
"metadata_template"
]
},
"id": {
Expand All @@ -19912,6 +19914,13 @@
"type",
"id"
]
},
"filter_fields": {
"description": "List of metadata template field filters. Only required when `assign_to.type` is `metadata_template`.",
"type": "array",
"items": {
"$ref": "#/components/schemas/LegalHoldPolicyAssignmentFilterField"
}
}
},
"required": [
Expand Down Expand Up @@ -35493,6 +35502,12 @@
"type": "integer",
"format": "int64",
"example": 6
},
"metadata_template": {
"description": "The number of metadata templates this policy is applied to.",
"type": "integer",
"format": "int64",
"example": 1
}
}
},
Expand Down Expand Up @@ -35595,7 +35610,8 @@
"folder",
"user",
"ownership",
"interactions"
"interactions",
"metadata_template"
]
},
"id": {
Expand All @@ -35611,7 +35627,7 @@
"title": "Legal hold policy item"
},
"LegalHoldPolicyAssignment": {
"description": "Legal Hold Assignments are used to assign Legal Hold\nPolicies to an item type of: Users, Folders, Files, File Versions, Ownership, or Interactions.\n\nCreating a Legal Hold Assignment puts a hold\non the File-Versions that belong to the Assignment's\n'apply-to' entity.",
"description": "Legal Hold Assignments are used to assign Legal Hold\nPolicies to an item type of: Users, Folders, Files, File Versions, Ownership, Interactions, or Metadata Templates.\n\nCreating a Legal Hold Assignment puts a hold\non the File-Versions that belong to the Assignment's\n'apply-to' entity.",
"type": "object",
"allOf": [
{
Expand Down Expand Up @@ -35660,6 +35676,13 @@
"type": "string",
"format": "date-time",
"example": "2012-12-12T10:53:43-08:00"
},
"filter_fields": {
"description": "List of metadata template field filters. Only present when `assigned_to.type` is `metadata_template`.",
"type": "array",
"items": {
"$ref": "#/components/schemas/LegalHoldPolicyAssignmentFilterField"
}
}
}
}
Expand Down Expand Up @@ -35695,6 +35718,27 @@
"standard"
]
},
"LegalHoldPolicyAssignmentFilterField": {
"description": "A metadata template field filter for a legal hold policy assignment.",
"type": "object",
"properties": {
"field": {
"description": "The ID of the metadata template field to filter on.",
"type": "string",
"example": "a0f4ee4e-1dc1-4h90-a8a9-aef55fc681d4"
},
"value": {
"description": "The value of the metadata template field to filter on.",
"type": "string",
"example": "0c27b756-0p87-4fe0-a43a-59fb661ccc4e"
}
},
"required": [
"field",
"value"
],
"title": "Legal hold policy assignment filter field"
},
"LegalHoldPolicyAssignments": {
"description": "A list of legal hold policies assignments.",
"type": "object",
Expand Down
Loading