diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock
index 3a407568..5d5ed87f 100644
--- a/.speakeasy/gen.lock
+++ b/.speakeasy/gen.lock
@@ -1,19 +1,19 @@
lockVersion: 2.0.0
id: 3e3290ca-0ee8-4981-b1bc-14536048fa63
management:
- docChecksum: 29ddd799353c1c1040a4230321552173
+ docChecksum: 0136ea2be3fd874b52e2e27539b9447d
docVersion: 0.9.0
- speakeasyVersion: 1.709.1
- generationVersion: 2.812.2
- releaseVersion: 0.12.4
- configChecksum: 31048150fb47264f175d124e744dc74a
+ speakeasyVersion: 1.709.3
+ generationVersion: 2.814.0
+ releaseVersion: 0.12.5
+ configChecksum: b35af09418a4a2a512be668ee6baff30
repoURL: https://github.com/gleanwork/api-client-python.git
installationURL: https://github.com/gleanwork/api-client-python.git
published: true
persistentEdits:
- generation_id: 1c6e2a64-bfad-4b68-bc48-085caf81e313
- pristine_commit_hash: 418c0cac94bd92ece53121d29614d395c115c1b1
- pristine_tree_hash: 18f6f2e4ed99500074bc803f4bcc3869710dfc4f
+ generation_id: f9f6f953-6068-4ac3-aa7d-144b5e7a8349
+ pristine_commit_hash: edd9315321429dbe9e6640acdcb3539e339065a9
+ pristine_tree_hash: 1e4872412f1b51b42f627a8beb275b7f43912f85
features:
python:
additionalDependencies: 1.0.0
@@ -943,8 +943,8 @@ trackedFiles:
pristine_git_object: 497f8be3d27c23d6065e3bb5488de7ec5c2655b3
docs/models/documentinteractions.md:
id: 40929f336351
- last_write_checksum: sha1:0767f87c7e460960b1ee5d1c3f0a08f447a28d17
- pristine_git_object: 42713431478c1e9fc301a0368ca8fbbebfb9d07d
+ last_write_checksum: sha1:ede65df5d5f50eeeaf919598bcb2c04ff569e552
+ pristine_git_object: 6c5eb1a1ec1f832f1c392423a138bfc441fa0e7d
docs/models/documentinteractionsdefinition.md:
id: c25cb3fbc0da
last_write_checksum: sha1:db3ce2e164b64346a2d686e1f00bd08f17828a73
@@ -1115,8 +1115,8 @@ trackedFiles:
pristine_git_object: aba28baec1db3447632d5e920f5766a354b304e8
docs/models/event.md:
id: 311c22a8574a
- last_write_checksum: sha1:65da65e93a1b3f2413558a5d6421797481fd0875
- pristine_git_object: 399107aa3439773cd831820ab8642e8050b20017
+ last_write_checksum: sha1:2d16d2e416ab647f6543f046845f91b65a82d064
+ pristine_git_object: cddb621e1a82d2155746e64b5d9424cd1f844fb5
docs/models/eventclassification.md:
id: e77adeacd229
last_write_checksum: sha1:a946fb8b2c26b78a03a640d841a4f5222f8586c7
@@ -1171,8 +1171,8 @@ trackedFiles:
pristine_git_object: 5db794d949ed3e2e606579aa6eefc7f6477eaa13
docs/models/facetfiltervalue.md:
id: 501cf7ea1ad2
- last_write_checksum: sha1:31ab0cc602d2b7d5ad430acc0ea24585385450a1
- pristine_git_object: 74ab3a85ebe3a374502fb770122e105dc896adc0
+ last_write_checksum: sha1:3c9405d204fb20a25b89b57a674fa6bd07de1f56
+ pristine_git_object: 84c2170436d8a27af07137fc9ec9e7d3402da784
docs/models/facetresult.md:
id: 7a68e5e2821e
last_write_checksum: sha1:3393d2c01205b3d3c46fc46a8d5c3e24217099d3
@@ -2003,8 +2003,8 @@ trackedFiles:
pristine_git_object: 961316baec5e47232764342301bcb7e7fa5e45a7
docs/models/relateddocuments.md:
id: 37f62d34d466
- last_write_checksum: sha1:898e4715d46b6d6acaf24ac6477bebafd6998600
- pristine_git_object: 622962663e3885e469f9378389edf00bbfc04327
+ last_write_checksum: sha1:fa99942ef722571ea6a82d8c2b4fc2e1f647f2b0
+ pristine_git_object: 0002a5a978cc3e3f2cb153d3f261c152649aa36e
docs/models/relatedobject.md:
id: b199f29bd27f
last_write_checksum: sha1:6792ea9688f7506cde526301de830759490c72ac
@@ -2091,8 +2091,8 @@ trackedFiles:
pristine_git_object: fcc597abd3b5095bef1a5bdd9fd2bb372b2785b8
docs/models/role.md:
id: b694540a5b1e
- last_write_checksum: sha1:527519264ae05019a7bb015a8765e406ea9b2ad2
- pristine_git_object: 3a788dbf0cb332a456902365b8ab43352e4b67b6
+ last_write_checksum: sha1:750cefe00c4ddee3abc4fa5251981487531aa960
+ pristine_git_object: 8176a687d746d3fb71074cae218635571567695e
docs/models/rotatetokenresponse.md:
id: bb8958b26e2a
last_write_checksum: sha1:1a25b03ff78895912dbb7d50e6dfda816b67cb65
@@ -2179,12 +2179,12 @@ trackedFiles:
pristine_git_object: 9115fe32b92d4a72016dcbe12cf6699babaf9704
docs/models/sensitiveinfotype.md:
id: a96873d05eba
- last_write_checksum: sha1:6921e5e164d837b63661dbaf7a86f1b4a11f8dc0
- pristine_git_object: 1a643b059dcdb9ab8642a2ffa1cf50e6e7d5f5f7
+ last_write_checksum: sha1:923004ffe629074132c7d41c7ba991ba7f9397f6
+ pristine_git_object: cce44d495574a77d559ba3f01d7e4514804efde1
docs/models/sensitiveinfotypelikelihoodthreshold.md:
id: 3ee71d33a4d7
- last_write_checksum: sha1:d889dbea748e1432c642cdc23e9301da011abacf
- pristine_git_object: df75e2b002981ec4a43b8c2f92a71b9cd15189ad
+ last_write_checksum: sha1:7b50f0247ad07a6c09165e41fa2f27f7761c1e53
+ pristine_git_object: e64355829076c9c9f333f1317eec637d85d89127
docs/models/sessioninfo.md:
id: 4f35f0cd75e6
last_write_checksum: sha1:54947b191223cc0100d33978470ef085255e0b45
@@ -2559,8 +2559,8 @@ trackedFiles:
pristine_git_object: 8f87704c8059174c4b82314e393da7476d80b6a1
docs/models/viewerinfo.md:
id: ac723e0773ae
- last_write_checksum: sha1:15bec9627873d5b40ef06a4936c3a231ea2e1deb
- pristine_git_object: 17e7a6fa7b1fcb67972308ce7511cb929540cdb0
+ last_write_checksum: sha1:1124c51f4946d09c751638c54eba5c4d90dd9ee0
+ pristine_git_object: 13f5dde99980decbd4182124f1f033f58308d933
docs/models/warningtype.md:
id: 0b9df591f487
last_write_checksum: sha1:c2eb99d70a6980d44d807c54f76266ac2ec80d6c
@@ -2719,8 +2719,8 @@ trackedFiles:
pristine_git_object: 33c17ec92e441b6c363a28a5b7319df5a2ad94dd
pyproject.toml:
id: 5d07e7d72637
- last_write_checksum: sha1:d14f0894eed100b32217758818b4826afc9492bf
- pristine_git_object: 85256d915510526d9183fbbefee0a60236ce45c1
+ last_write_checksum: sha1:4e15438e44a3016909c40a0c5cb5ba68999ec4e3
+ pristine_git_object: 9c50e79408a92c888433d83f64068031f21f9e3c
scripts/prepare_readme.py:
id: e0c5957a6035
last_write_checksum: sha1:c2c83f71dea61eb50c9e05da83b16d18b4da8794
@@ -2747,8 +2747,8 @@ trackedFiles:
pristine_git_object: 58c4d70ac1797b86ff5c4237cafbc344c42d8f64
src/glean/api_client/_version.py:
id: 0ce22b26136b
- last_write_checksum: sha1:af56329a7e662365cd8d055035c41533074e71c8
- pristine_git_object: d914938529975adc94f58d758b8badce181a4eeb
+ last_write_checksum: sha1:b8da60344fe3708019a2795a93be61ca271b56b9
+ pristine_git_object: 93779ca3df54aea6904cd8c2f959f6f41218eb15
src/glean/api_client/agents.py:
id: b925701a9217
last_write_checksum: sha1:c1688c3d141db7707458f3ac7ff29c4a71e6812b
@@ -3603,8 +3603,8 @@ trackedFiles:
pristine_git_object: f81d6f4596c961bc80f58a6afae55af4b30229d6
src/glean/api_client/models/documentinteractions.py:
id: 1cbd7f0ca8c2
- last_write_checksum: sha1:cecb1e6fdad496d9a266d0d6d7be8ce51c1d9340
- pristine_git_object: 159a5dfa03fcaa581b52c3be2d822eb7b0102122
+ last_write_checksum: sha1:702639681088e53ab22de33ec1d5434cb3652029
+ pristine_git_object: bf70b403037add863bcbdb3ff78a7e80f7c505f6
src/glean/api_client/models/documentinteractionsdefinition.py:
id: 08e2b97a68ab
last_write_checksum: sha1:34aafc0245f74c3fd4f1468d5778d2bb5ad551d2
@@ -3767,8 +3767,8 @@ trackedFiles:
pristine_git_object: 660a4cfd2bd0c88bcd0b9fbebf1817ad380d3524
src/glean/api_client/models/facetfiltervalue.py:
id: 2538d6322ce2
- last_write_checksum: sha1:2ddb82f66f90ee06b00ba6329653f7f5fc71fe95
- pristine_git_object: b1f4c89eff8bc8b379e260d2361f14b7c6a8f9d3
+ last_write_checksum: sha1:7cd02b99e5ffcee420402cd92134f8384e7ca5ce
+ pristine_git_object: 83ed0638c73ac9d49886ecd5a05ee503c555c932
src/glean/api_client/models/facetresult.py:
id: 0b08040192a1
last_write_checksum: sha1:b82c0a556cbb5ba351ff2d269c77232bfe16d115
@@ -3783,8 +3783,8 @@ trackedFiles:
pristine_git_object: df6efe65c2e13b52f7e031908e3de404059b14fe
src/glean/api_client/models/feedback.py:
id: 511140b14aff
- last_write_checksum: sha1:937812f67ad43763cdd2edf25113c049be42c2fa
- pristine_git_object: faaeefd68d0b35a87eb43c609c01f73919258f54
+ last_write_checksum: sha1:e86665f58a2008203601d6946f33c7ef471eb056
+ pristine_git_object: cd39afb8835d1aa80bca927a0853bde2bb4cc872
src/glean/api_client/models/feedbackchatexchange.py:
id: 8a8e469394a1
last_write_checksum: sha1:9c274382e72e5a599629454ab0435f69ca1b6bc7
@@ -4419,8 +4419,8 @@ trackedFiles:
pristine_git_object: 453716364f6c5e16e5978989b587a594230a309f
src/glean/api_client/models/relateddocuments.py:
id: "956195080413"
- last_write_checksum: sha1:5ec870b562eba40c1f643eb7a2a540e7dcbb75d8
- pristine_git_object: d19b3c35c254f253699b038024afbb0c60bc01b1
+ last_write_checksum: sha1:7783f5e7e4d3605ff6b6a487b362d809a8b626be
+ pristine_git_object: a6d1efe7e2a010ada8b449bbabdb0577f168e337
src/glean/api_client/models/relatedobject.py:
id: c8937c435039
last_write_checksum: sha1:420e9303bf60fc927a99d5efda0174d8565d1464
@@ -4543,8 +4543,8 @@ trackedFiles:
pristine_git_object: ddc4bf2e43c37f93aead49b02339dd7780d077cb
src/glean/api_client/models/sensitiveinfotype.py:
id: 6d9d1a461507
- last_write_checksum: sha1:00a22f335767d31191c294a277685e772a5ce8c5
- pristine_git_object: b4f1207312faec6a0e5835dfcd308562434a9bfe
+ last_write_checksum: sha1:7e9883b73b49e57904e61d212de40c98c63bba06
+ pristine_git_object: 7f0a68e49260e678d03758fff3771588753331ae
src/glean/api_client/models/sessioninfo.py:
id: 4127a11bdfbc
last_write_checksum: sha1:0145413faf4c697540b04e263415f174ca9aff6a
@@ -4851,8 +4851,8 @@ trackedFiles:
pristine_git_object: 564b1844c0126dae8decdf50260d514963ba32bb
src/glean/api_client/models/viewerinfo.py:
id: dc44fac102b9
- last_write_checksum: sha1:8979842e6c80b43b1fb25b49be3b668cdf68fa0b
- pristine_git_object: dffc8d946c0fa745a976a9d74377614ed9e22eca
+ last_write_checksum: sha1:3ccf1aec9633594c70cffa3de6ec61b2af8e9e1a
+ pristine_git_object: b7a6c1f85bc901773b5ef97eaead05f3e306b26d
src/glean/api_client/models/workflow.py:
id: e59e0fe5f663
last_write_checksum: sha1:abebed551d71fbfa6d89e46154da2e5119fc4d59
@@ -5532,7 +5532,7 @@ trackedFiles:
tests/mockserver/internal/sdk/models/components/documentdefinition.go:
last_write_checksum: sha1:04dc959087a57790f99f0b47e6fe2359603b48ff
tests/mockserver/internal/sdk/models/components/documentinteractions.go:
- last_write_checksum: sha1:16f1d08ae52ecf4b5f8110bb1f3ba88810dd9a50
+ last_write_checksum: sha1:5e29169410c2971f57b96b24ea4fad8b6437b79e
tests/mockserver/internal/sdk/models/components/documentinteractionsdefinition.go:
last_write_checksum: sha1:b34825743a5a76d8b6a521b6bcbaf37a5ef18d44
tests/mockserver/internal/sdk/models/components/documentmetadata.go:
@@ -5600,7 +5600,7 @@ trackedFiles:
tests/mockserver/internal/sdk/models/components/facetfilterset.go:
last_write_checksum: sha1:6a7c1068dca4aa32c440398c5755f94834859c40
tests/mockserver/internal/sdk/models/components/facetfiltervalue.go:
- last_write_checksum: sha1:4b1731d2b08e2e1e4bb0e4665d8577cda514da44
+ last_write_checksum: sha1:d59e535246c7d9b5d43ef7542bfc9c599c9322d8
tests/mockserver/internal/sdk/models/components/facetresult.go:
last_write_checksum: sha1:700eafec2b5b7a550913114c69dc43fa1acf6826
tests/mockserver/internal/sdk/models/components/facetvalue.go:
@@ -5608,7 +5608,7 @@ trackedFiles:
tests/mockserver/internal/sdk/models/components/favoriteinfo.go:
last_write_checksum: sha1:64a199091535bec155fa46cd3022c50574f8e329
tests/mockserver/internal/sdk/models/components/feedback.go:
- last_write_checksum: sha1:b8cbb9ea258cc0fbfccd63cd55ca7053d1c035d1
+ last_write_checksum: sha1:0ace13f3aea5502c4b169f1ea633d10c7b791d56
tests/mockserver/internal/sdk/models/components/feedbackchatexchange.go:
last_write_checksum: sha1:59418d4b2dc683c810308022eade51a8894ab3b0
tests/mockserver/internal/sdk/models/components/feedentry.go:
@@ -5858,7 +5858,7 @@ trackedFiles:
tests/mockserver/internal/sdk/models/components/referencerange.go:
last_write_checksum: sha1:cd2d934fbc80cc4ff9e23f37e573b9a33e8a7d8d
tests/mockserver/internal/sdk/models/components/relateddocuments.go:
- last_write_checksum: sha1:e6cc3deef8a5485268dd31e12db59417528276ce
+ last_write_checksum: sha1:eea27dba609f1624659fcbd0d15777c55eb703e0
tests/mockserver/internal/sdk/models/components/relatedobject.go:
last_write_checksum: sha1:643744c2a87fa946d97b54f20a7ee7e140cb703c
tests/mockserver/internal/sdk/models/components/relatedobjectedge.go:
@@ -5918,7 +5918,7 @@ trackedFiles:
tests/mockserver/internal/sdk/models/components/sensitiveexpression.go:
last_write_checksum: sha1:b4fbc845bc2db4f1bc0cc4401b990d697491fbf0
tests/mockserver/internal/sdk/models/components/sensitiveinfotype.go:
- last_write_checksum: sha1:1dd541f242e2761119938d9a948c86fd3c039140
+ last_write_checksum: sha1:20f1d2089955876f297f6effc3667f6ae84c5108
tests/mockserver/internal/sdk/models/components/sessioninfo.go:
last_write_checksum: sha1:d0a7c3cb679745701743e6ec68c15cf72b3e0a2f
tests/mockserver/internal/sdk/models/components/share.go:
@@ -6058,7 +6058,7 @@ trackedFiles:
tests/mockserver/internal/sdk/models/components/verifyrequest.go:
last_write_checksum: sha1:b21b8e5f5f48355b6b3afd4be9229b08e78123d9
tests/mockserver/internal/sdk/models/components/viewerinfo.go:
- last_write_checksum: sha1:dde2be514fc0a6bff7d7dc27ad154e5edfdb35ac
+ last_write_checksum: sha1:bf5d4b48cfa2e68cc2b2b7c47d1f0668d18e1b56
tests/mockserver/internal/sdk/models/components/workflow.go:
last_write_checksum: sha1:22bec7e5d678873d1efc40d537a5beee7c7e4205
tests/mockserver/internal/sdk/models/components/workflowfeedbackinfo.go:
@@ -7340,6 +7340,7 @@ generatedTests:
updateshortcut: "2025-06-12T19:13:52-04:00"
listfindingsexports: "2025-12-10T17:53:31Z"
downloadfindingsexport: "2025-12-10T17:53:31Z"
+releaseNotes: "## Python SDK Changes:\n* `glean.client.activity.feedback()`: \n * `request.feedback1.event.enum(feedback_time_saved)` **Added**\n"
generatedFiles:
- .devcontainer/README.md
- .devcontainer/devcontainer.json
diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml
index 8668ec4c..b35efa60 100644
--- a/.speakeasy/gen.yaml
+++ b/.speakeasy/gen.yaml
@@ -33,7 +33,7 @@ generation:
generateNewTests: true
skipResponseBodyAssertions: true
python:
- version: 0.12.4
+ version: 0.12.5
additionalDependencies:
dev: {}
main: {}
diff --git a/.speakeasy/glean-merged-spec.yaml b/.speakeasy/glean-merged-spec.yaml
index d1b3e7b6..2f5c144b 100644
--- a/.speakeasy/glean-merged-spec.yaml
+++ b/.speakeasy/glean-merged-spec.yaml
@@ -2,7 +2,7 @@ openapi: 3.0.0
info:
version: 0.9.0
title: Glean API
- x-source-commit-sha: b909c25b9d5cf09a104244083b68d7954786bdca
+ x-source-commit-sha: 1eacb96a6653695f696c2091e98242f35d256b07
description: |
# Introduction
In addition to the data sources that Glean has built-in support for, Glean also provides a REST API that enables customers to put arbitrary content in the search index. This is useful, for example, for doing permissions-aware search over content in internal tools that reside on-prem as well as for searching over applications that Glean does not currently support first class. In addition these APIs allow the customer to push organization data (people info, organization structure etc) into Glean.
@@ -22,7 +22,7 @@ info:
These API clients provide type-safe, idiomatic interfaces for working with Glean IndexingAPIs in your language of choice.
x-logo:
url: https://app.glean.com/images/glean-text2.svg
- x-open-api-commit-sha: bcbc2642293d9f9765218b737ed785a49f105698
+ x-open-api-commit-sha: e02de4230f917f7474db5ec459a13b3877661199
x-speakeasy-name: 'Glean API'
servers:
- url: https://{instance}-be.glean.com
@@ -332,8 +332,14 @@ paths:
deprecated: true
x-visibility: Public
x-codegen-request-body-name: payload
+ x-glean-deprecated:
+ id: 4c0923bd-64c7-45b9-99a5-b36f2705e618
+ introduced: "2026-01-21"
+ message: Answer boards have been removed and this endpoint no longer serves a purpose
+ removal: "2026-10-15"
parameters:
- $ref: "#/components/parameters/locale"
+ x-speakeasy-deprecation-message: "Deprecated on 2026-01-21, removal scheduled for 2026-10-15: Answer boards have been removed and this endpoint no longer serves a purpose"
requestBody:
content:
application/json:
@@ -355,12 +361,6 @@ paths:
description: Not Authorized
"429":
description: Too Many Requests
- x-glean-deprecated:
- id: 4c0923bd-64c7-45b9-99a5-b36f2705e618
- introduced: "2026-01-21"
- message: Answer boards have been removed and this endpoint no longer serves a purpose
- removal: "2026-10-15"
- x-speakeasy-deprecation-message: "Deprecated on 2026-01-21, removal scheduled for 2026-10-15: Answer boards have been removed and this endpoint no longer serves a purpose"
x-speakeasy-name-override: list
x-speakeasy-group: client.answers
/rest/api/v1/createauthtoken:
@@ -2288,7 +2288,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/IndexDocumentRequest'
+ $ref: "#/components/schemas/IndexDocumentRequest"
required: true
x-exportParamName: IndexDocumentRequest
responses:
@@ -2314,7 +2314,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/IndexDocumentsRequest'
+ $ref: "#/components/schemas/IndexDocumentsRequest"
required: true
x-exportParamName: IndexDocumentsRequest
responses:
@@ -2340,7 +2340,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/BulkIndexDocumentsRequest'
+ $ref: "#/components/schemas/BulkIndexDocumentsRequest"
required: true
x-exportParamName: BulkIndexDocumentsRequest
responses:
@@ -2364,7 +2364,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/UpdatePermissionsRequest'
+ $ref: "#/components/schemas/UpdatePermissionsRequest"
required: true
x-exportParamName: UpdatePermissionsRequest
responses:
@@ -2401,7 +2401,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ProcessAllDocumentsRequest'
+ $ref: "#/components/schemas/ProcessAllDocumentsRequest"
x-exportParamName: ProcessAllDocumentsRequest
responses:
"200":
@@ -2424,7 +2424,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/DeleteDocumentRequest'
+ $ref: "#/components/schemas/DeleteDocumentRequest"
required: true
x-exportParamName: DeleteDocumentRequest
responses:
@@ -2448,7 +2448,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/IndexUserRequest'
+ $ref: "#/components/schemas/IndexUserRequest"
required: true
x-exportParamName: IndexUserRequest
responses:
@@ -2474,7 +2474,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/BulkIndexUsersRequest'
+ $ref: "#/components/schemas/BulkIndexUsersRequest"
required: true
x-exportParamName: BulkIndexUsersRequest
responses:
@@ -2498,7 +2498,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/IndexGroupRequest'
+ $ref: "#/components/schemas/IndexGroupRequest"
required: true
x-exportParamName: IndexGroupRequest
responses:
@@ -2524,7 +2524,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/BulkIndexGroupsRequest'
+ $ref: "#/components/schemas/BulkIndexGroupsRequest"
required: true
x-exportParamName: BulkIndexGroupsRequest
responses:
@@ -2548,7 +2548,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/IndexMembershipRequest'
+ $ref: "#/components/schemas/IndexMembershipRequest"
required: true
x-exportParamName: IndexMembershipRequest
responses:
@@ -2572,7 +2572,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/BulkIndexMembershipsRequest'
+ $ref: "#/components/schemas/BulkIndexMembershipsRequest"
required: true
x-exportParamName: BulkIndexMembershipsRequest
responses:
@@ -2597,7 +2597,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ProcessAllMembershipsRequest'
+ $ref: "#/components/schemas/ProcessAllMembershipsRequest"
x-exportParamName: ProcessAllMembershipsRequest
responses:
"200":
@@ -2620,7 +2620,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/DeleteUserRequest'
+ $ref: "#/components/schemas/DeleteUserRequest"
required: true
x-exportParamName: DeleteUserRequest
responses:
@@ -2646,7 +2646,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/DeleteGroupRequest'
+ $ref: "#/components/schemas/DeleteGroupRequest"
required: true
x-exportParamName: DeleteGroupRequest
responses:
@@ -2670,7 +2670,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/DeleteMembershipRequest'
+ $ref: "#/components/schemas/DeleteMembershipRequest"
required: true
x-exportParamName: DeleteMembershipRequest
responses:
@@ -2686,6 +2686,7 @@ paths:
x-speakeasy-group: indexing.permissions
/api/index/v1/debug/{datasource}/status:
post:
+ x-beta: true
summary: |
Beta: Get datasource status
description: |
@@ -2707,16 +2708,16 @@ paths:
content:
application/json; charset=UTF-8:
schema:
- $ref: '#/components/schemas/DebugDatasourceStatusResponse'
+ $ref: "#/components/schemas/DebugDatasourceStatusResponse"
"400":
description: Bad Request
"401":
description: Not Authorized
- x-beta: true
x-speakeasy-name-override: status
x-speakeasy-group: indexing.datasource
/api/index/v1/debug/{datasource}/document:
post:
+ x-beta: true
summary: |
Beta: Get document information
description: |
@@ -2736,7 +2737,7 @@ paths:
content:
application/json; charset=UTF-8:
schema:
- $ref: '#/components/schemas/DebugDocumentRequest'
+ $ref: "#/components/schemas/DebugDocumentRequest"
required: true
x-exportParamName: DebugDocumentRequest
responses:
@@ -2745,16 +2746,16 @@ paths:
content:
application/json; charset=UTF-8:
schema:
- $ref: '#/components/schemas/DebugDocumentResponse'
+ $ref: "#/components/schemas/DebugDocumentResponse"
"400":
description: Bad Request
"401":
description: Not Authorized
- x-beta: true
x-speakeasy-group: indexing.documents
x-speakeasy-name-override: debug
/api/index/v1/debug/{datasource}/documents:
post:
+ x-beta: true
summary: |
Beta: Get information of a batch of documents
description: |
@@ -2774,7 +2775,7 @@ paths:
content:
application/json; charset=UTF-8:
schema:
- $ref: '#/components/schemas/DebugDocumentsRequest'
+ $ref: "#/components/schemas/DebugDocumentsRequest"
required: true
x-exportParamName: DebugDocumentsRequest
responses:
@@ -2783,16 +2784,16 @@ paths:
content:
application/json; charset=UTF-8:
schema:
- $ref: '#/components/schemas/DebugDocumentsResponse'
+ $ref: "#/components/schemas/DebugDocumentsResponse"
"400":
description: Bad Request
"401":
description: Not Authorized
- x-beta: true
x-speakeasy-group: indexing.documents
x-speakeasy-name-override: debugMany
/api/index/v1/debug/{datasource}/user:
post:
+ x-beta: true
summary: |
Beta: Get user information
description: |
@@ -2812,7 +2813,7 @@ paths:
content:
application/json; charset=UTF-8:
schema:
- $ref: '#/components/schemas/DebugUserRequest'
+ $ref: "#/components/schemas/DebugUserRequest"
required: true
x-exportParamName: DebugUserRequest
responses:
@@ -2821,12 +2822,11 @@ paths:
content:
application/json; charset=UTF-8:
schema:
- $ref: '#/components/schemas/DebugUserResponse'
+ $ref: "#/components/schemas/DebugUserResponse"
"400":
description: Bad Request
"401":
description: Not Authorized
- x-beta: true
x-speakeasy-name-override: debug
x-speakeasy-group: indexing.people
/api/index/v1/checkdocumentaccess:
@@ -2842,7 +2842,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/CheckDocumentAccessRequest'
+ $ref: "#/components/schemas/CheckDocumentAccessRequest"
required: true
x-exportParamName: CheckDocumentAccessRequest
responses:
@@ -2851,7 +2851,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/CheckDocumentAccessResponse'
+ $ref: "#/components/schemas/CheckDocumentAccessResponse"
"400":
description: Bad Request
"401":
@@ -2862,6 +2862,7 @@ paths:
x-speakeasy-name-override: checkAccess
/api/index/v1/getdocumentstatus:
post:
+ deprecated: true
summary: Get document upload and indexing status
description: |
Intended for debugging/validation. Fetches the current upload and indexing status of documents.
@@ -2873,7 +2874,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/GetDocumentStatusRequest'
+ $ref: "#/components/schemas/GetDocumentStatusRequest"
required: true
x-exportParamName: GetDocumentStatusRequest
responses:
@@ -2882,18 +2883,18 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/GetDocumentStatusResponse'
+ $ref: "#/components/schemas/GetDocumentStatusResponse"
"400":
description: Bad Request
"401":
description: Not Authorized
"429":
description: Too Many Requests
- deprecated: true
x-speakeasy-group: indexing.documents
x-speakeasy-name-override: status
/api/index/v1/getdocumentcount:
post:
+ deprecated: true
summary: Get document count
description: |
Fetches document count for the specified custom datasource.
@@ -2905,7 +2906,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/GetDocumentCountRequest'
+ $ref: "#/components/schemas/GetDocumentCountRequest"
required: true
x-exportParamName: GetDocumentCountRequest
responses:
@@ -2914,18 +2915,18 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/GetDocumentCountResponse'
+ $ref: "#/components/schemas/GetDocumentCountResponse"
"400":
description: Bad Request
"401":
description: Not Authorized
"409":
description: Conflict
- deprecated: true
x-speakeasy-group: indexing.documents
x-speakeasy-name-override: count
/api/index/v1/getusercount:
post:
+ deprecated: true
summary: Get user count
description: |
Fetches user count for the specified custom datasource.
@@ -2937,7 +2938,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/GetUserCountRequest'
+ $ref: "#/components/schemas/GetUserCountRequest"
required: true
x-exportParamName: GetUserCountRequest
responses:
@@ -2946,14 +2947,13 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/GetUserCountResponse'
+ $ref: "#/components/schemas/GetUserCountResponse"
"400":
description: Bad Request
"401":
description: Not Authorized
"409":
description: Conflict
- deprecated: true
x-speakeasy-name-override: count
x-speakeasy-group: indexing.people
/api/index/v1/betausers:
@@ -2966,7 +2966,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/GreenlistUsersRequest'
+ $ref: "#/components/schemas/GreenlistUsersRequest"
required: true
x-exportParamName: GreenlistUsersRequest
responses:
@@ -2990,7 +2990,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/CustomDatasourceConfig'
+ $ref: "#/components/schemas/CustomDatasourceConfig"
required: true
x-exportParamName: DatasourceConfig
responses:
@@ -3012,7 +3012,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/GetDatasourceConfigRequest'
+ $ref: "#/components/schemas/GetDatasourceConfigRequest"
required: true
x-exportParamName: GetDatasourceConfigRequest
responses:
@@ -3021,7 +3021,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/CustomDatasourceConfig'
+ $ref: "#/components/schemas/CustomDatasourceConfig"
"400":
description: Bad Request
"401":
@@ -3042,7 +3042,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/RotateTokenResponse'
+ $ref: "#/components/schemas/RotateTokenResponse"
"400":
description: Bad Request
"401":
@@ -3059,7 +3059,7 @@ paths:
content:
application/json; charset=UTF-8:
schema:
- $ref: '#/components/schemas/IndexEmployeeRequest'
+ $ref: "#/components/schemas/IndexEmployeeRequest"
required: true
x-exportParamName: IndexEmployeeRequest
responses:
@@ -3083,7 +3083,7 @@ paths:
content:
application/json; charset=UTF-8:
schema:
- $ref: '#/components/schemas/BulkIndexEmployeesRequest'
+ $ref: "#/components/schemas/BulkIndexEmployeesRequest"
required: true
x-exportParamName: BulkIndexEmployeesRequest
responses:
@@ -3126,7 +3126,7 @@ paths:
content:
application/json; charset=UTF-8:
schema:
- $ref: '#/components/schemas/DeleteEmployeeRequest'
+ $ref: "#/components/schemas/DeleteEmployeeRequest"
required: true
x-exportParamName: DeleteEmployeeRequest
responses:
@@ -3150,7 +3150,7 @@ paths:
content:
application/json; charset=UTF-8:
schema:
- $ref: '#/components/schemas/IndexTeamRequest'
+ $ref: "#/components/schemas/IndexTeamRequest"
required: true
x-exportParamName: IndexTeamRequest
responses:
@@ -3174,7 +3174,7 @@ paths:
content:
application/json; charset=UTF-8:
schema:
- $ref: '#/components/schemas/DeleteTeamRequest'
+ $ref: "#/components/schemas/DeleteTeamRequest"
required: true
x-exportParamName: DeleteTeamRequest
responses:
@@ -3198,7 +3198,7 @@ paths:
content:
application/json; charset=UTF-8:
schema:
- $ref: '#/components/schemas/BulkIndexTeamsRequest'
+ $ref: "#/components/schemas/BulkIndexTeamsRequest"
required: true
x-exportParamName: BulkIndexTeamsRequest
responses:
@@ -3222,7 +3222,7 @@ paths:
content:
application/json; charset=UTF-8:
schema:
- $ref: '#/components/schemas/BulkIndexShortcutsRequest'
+ $ref: "#/components/schemas/BulkIndexShortcutsRequest"
required: true
x-exportParamName: BulkIndexShortcutsRequest
responses:
@@ -3246,7 +3246,7 @@ paths:
content:
application/json; charset=UTF-8:
schema:
- $ref: '#/components/schemas/UploadShortcutsRequest'
+ $ref: "#/components/schemas/UploadShortcutsRequest"
required: true
x-exportParamName: UploadShortcutsRequest
responses:
@@ -3262,9 +3262,10 @@ paths:
x-speakeasy-group: indexing.shortcuts
/rest/api/v1/governance/data/policies/{id}:
get:
- operationId: getpolicy
- summary: Gets specified policy
description: Fetches the specified policy version, or the latest if no version is provided.
+ summary: Gets specified policy
+ operationId: getpolicy
+ x-visibility: Public
tags:
- Governance
parameters:
@@ -3287,18 +3288,17 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/GetDlpReportResponse'
+ $ref: "#/components/schemas/GetDlpReportResponse"
"403":
description: Permissions error
"500":
description: Internal error
- x-visibility: Public
x-speakeasy-group: client.governance.data.policies
x-speakeasy-name-override: retrieve
post:
- operationId: updatepolicy
- summary: Updates an existing policy
description: Updates an existing policy.
+ summary: Updates an existing policy
+ operationId: updatepolicy
tags:
- Governance
parameters:
@@ -3312,7 +3312,7 @@ paths:
content:
application/json; charset=UTF-8:
schema:
- $ref: '#/components/schemas/UpdateDlpReportRequest'
+ $ref: "#/components/schemas/UpdateDlpReportRequest"
required: true
responses:
"200":
@@ -3320,7 +3320,7 @@ paths:
content:
application/json; charset=UTF-8:
schema:
- $ref: '#/components/schemas/UpdateDlpReportResponse'
+ $ref: "#/components/schemas/UpdateDlpReportResponse"
"403":
description: Permissions error
"500":
@@ -3329,9 +3329,10 @@ paths:
x-speakeasy-name-override: update
/rest/api/v1/governance/data/policies:
get:
- operationId: listpolicies
- summary: Lists policies
description: Lists policies with filtering.
+ summary: Lists policies
+ operationId: listpolicies
+ x-visibility: Public
tags:
- Governance
parameters:
@@ -3353,25 +3354,25 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ListDlpReportsResponse'
+ $ref: "#/components/schemas/ListDlpReportsResponse"
"403":
description: Permissions error
"500":
description: Internal error
- x-visibility: Public
x-speakeasy-group: client.governance.data.policies
x-speakeasy-name-override: list
post:
- operationId: createpolicy
- summary: Creates new policy
description: Creates a new policy with specified specifications and returns its id.
+ summary: Creates new policy
+ operationId: createpolicy
+ x-visibility: Public
tags:
- Governance
requestBody:
content:
application/json; charset=UTF-8:
schema:
- $ref: '#/components/schemas/CreateDlpReportRequest'
+ $ref: "#/components/schemas/CreateDlpReportRequest"
required: true
responses:
"200":
@@ -3379,19 +3380,19 @@ paths:
content:
application/json; charset=UTF-8:
schema:
- $ref: '#/components/schemas/CreateDlpReportResponse'
+ $ref: "#/components/schemas/CreateDlpReportResponse"
"403":
description: Permissions error
"500":
description: Internal error
- x-visibility: Public
x-speakeasy-group: client.governance.data.policies
x-speakeasy-name-override: create
/rest/api/v1/governance/data/policies/{id}/download:
get:
- operationId: downloadpolicycsv
- summary: Downloads violations CSV for policy
description: Downloads CSV violations report for a specific policy id. This does not support continuous policies.
+ summary: Downloads violations CSV for policy
+ operationId: downloadpolicycsv
+ x-visibility: Public
tags:
- Governance
parameters:
@@ -3407,29 +3408,29 @@ paths:
content:
text/csv; charset=UTF-8:
schema:
- type: string
description: CSV of all the violations found for this policy.
+ type: string
"400":
description: Bad request error (e.g., continuous policies are not supported).
"403":
description: Permissions error
"500":
description: Internal error
- x-visibility: Public
x-speakeasy-group: client.governance.data.policies
x-speakeasy-name-override: download
/rest/api/v1/governance/data/reports:
post:
- operationId: createreport
- summary: Creates new one-time report
description: Creates a new one-time report and executes its batch job.
+ summary: Creates new one-time report
+ operationId: createreport
+ x-visibility: Public
tags:
- Governance
requestBody:
content:
application/json; charset=UTF-8:
schema:
- $ref: '#/components/schemas/UpdateDlpConfigRequest'
+ $ref: "#/components/schemas/UpdateDlpConfigRequest"
required: true
responses:
"200":
@@ -3437,19 +3438,19 @@ paths:
content:
application/json; charset=UTF-8:
schema:
- $ref: '#/components/schemas/UpdateDlpConfigResponse'
+ $ref: "#/components/schemas/UpdateDlpConfigResponse"
"403":
description: Permissions error
"500":
description: Internal error
- x-visibility: Public
x-speakeasy-group: client.governance.data.reports
x-speakeasy-name-override: create
/rest/api/v1/governance/data/reports/{id}/download:
get:
- operationId: downloadreportcsv
- summary: Downloads violations CSV for report
description: Downloads CSV violations report for a specific report id.
+ summary: Downloads violations CSV for report
+ operationId: downloadreportcsv
+ x-visibility: Public
tags:
- Governance
parameters:
@@ -3465,20 +3466,20 @@ paths:
content:
text/csv; charset=UTF-8:
schema:
- type: string
description: CSV of all the violations found for this report.
+ type: string
"403":
description: Permissions error
"500":
description: Internal error
- x-visibility: Public
x-speakeasy-group: client.governance.data.reports
x-speakeasy-name-override: download
/rest/api/v1/governance/data/reports/{id}/status:
get:
- operationId: getreportstatus
- summary: Fetches report run status
description: Fetches the status of the run corresponding to the report-id.
+ summary: Fetches report run status
+ operationId: getreportstatus
+ x-visibility: Public
tags:
- Governance
parameters:
@@ -3494,19 +3495,19 @@ paths:
content:
application/json; charset=UTF-8:
schema:
- $ref: '#/components/schemas/ReportStatusResponse'
+ $ref: "#/components/schemas/ReportStatusResponse"
"403":
description: Permissions error
"500":
description: Internal error
- x-visibility: Public
x-speakeasy-group: client.governance.data.reports
x-speakeasy-name-override: status
/rest/api/v1/governance/documents/visibilityoverrides:
get:
- operationId: getdocvisibility
- summary: Fetches documents visibility
description: Fetches the visibility override status of the documents passed.
+ summary: Fetches documents visibility
+ operationId: getdocvisibility
+ x-visibility: Public
tags:
- Governance
parameters:
@@ -3523,25 +3524,25 @@ paths:
content:
application/json; charset=UTF-8:
schema:
- $ref: '#/components/schemas/GetDocumentVisibilityOverridesResponse'
+ $ref: "#/components/schemas/GetDocumentVisibilityOverridesResponse"
"403":
description: Permissions error
"500":
description: Internal error
- x-visibility: Public
x-speakeasy-group: client.governance.documents.visibilityoverrides
x-speakeasy-name-override: list
post:
- operationId: setdocvisibility
- summary: Hide or unhide docs
description: Sets the visibility-override state of the documents specified, effectively hiding or un-hiding documents.
+ summary: Hide or unhide docs
+ operationId: setdocvisibility
+ x-visibility: Public
tags:
- Governance
requestBody:
content:
application/json; charset=UTF-8:
schema:
- $ref: '#/components/schemas/UpdateDocumentVisibilityOverridesRequest'
+ $ref: "#/components/schemas/UpdateDocumentVisibilityOverridesRequest"
required: true
responses:
"200":
@@ -3549,26 +3550,26 @@ paths:
content:
application/json; charset=UTF-8:
schema:
- $ref: '#/components/schemas/UpdateDocumentVisibilityOverridesResponse'
+ $ref: "#/components/schemas/UpdateDocumentVisibilityOverridesResponse"
"403":
description: Permissions error
"500":
description: Internal error
- x-visibility: Public
x-speakeasy-group: client.governance.documents.visibilityoverrides
x-speakeasy-name-override: create
/rest/api/v1/governance/data/findings/exports:
post:
- operationId: createfindingsexport
- summary: Creates findings export
description: Creates a new DLP findings export job.
+ summary: Creates findings export
+ operationId: createfindingsexport
+ x-visibility: Public
tags:
- Governance
requestBody:
content:
application/json; charset=UTF-8:
schema:
- $ref: '#/components/schemas/DlpExportFindingsRequest'
+ $ref: "#/components/schemas/DlpExportFindingsRequest"
required: true
responses:
"200":
@@ -3576,16 +3577,16 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ExportInfo'
+ $ref: "#/components/schemas/ExportInfo"
"403":
description: Permissions error
"500":
description: Internal error
- x-visibility: Public
get:
- operationId: listfindingsexports
- summary: Lists findings exports
description: Lists all DLP findings exports.
+ summary: Lists findings exports
+ operationId: listfindingsexports
+ x-visibility: Public
tags:
- Governance
responses:
@@ -3594,17 +3595,17 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ListDlpFindingsExportsResponse'
+ $ref: "#/components/schemas/ListDlpFindingsExportsResponse"
"403":
description: Permissions error
"500":
description: Internal error
- x-visibility: Public
/rest/api/v1/governance/data/findings/exports/{id}:
get:
- operationId: downloadfindingsexport
- summary: Downloads findings export
description: Downloads a DLP findings export as a CSV file.
+ summary: Downloads findings export
+ operationId: downloadfindingsexport
+ x-visibility: Public
tags:
- Governance
parameters:
@@ -3620,17 +3621,17 @@ paths:
content:
text/csv; charset=UTF-8:
schema:
- type: string
description: CSV of all the exported findings.
+ type: string
"403":
description: Permissions error
"500":
description: Internal error
- x-visibility: Public
delete:
- operationId: deletefindingsexport
- summary: Deletes findings export
description: Deletes a DLP findings export.
+ summary: Deletes findings export
+ operationId: deletefindingsexport
+ x-visibility: Public
tags:
- Governance
parameters:
@@ -3648,7 +3649,6 @@ paths:
description: Permissions error
"500":
description: Internal error
- x-visibility: Public
/rest/api/v1/chat#stream:
post:
tags:
@@ -3843,14 +3843,6 @@ components:
CRAWL: Represents an explicit request to index the given `url` along with associated attributes in this payload.
HISTORICAL_SEARCH: Represents a search performed at the given `url` as indicated by the user's history.
HISTORICAL_VIEW: Represents a visit to the given `url` as indicated by the user's history.
- enum:
- - VIEW
- - EDIT
- - SEARCH
- - COMMENT
- - CRAWL
- - HISTORICAL_SEARCH
- - HISTORICAL_VIEW
x-speakeasy-enum-descriptions:
VIEW: Represents a visit to the given `url`.
EDIT: Represents an edit of the document represented by the `url`.
@@ -3859,6 +3851,14 @@ components:
CRAWL: Represents an explicit request to index the given `url` along with associated attributes in this payload.
HISTORICAL_SEARCH: Represents a search performed at the given `url` as indicated by the user's history.
HISTORICAL_VIEW: Represents a visit to the given `url` as indicated by the user's history.
+ enum:
+ - VIEW
+ - EDIT
+ - SEARCH
+ - COMMENT
+ - CRAWL
+ - HISTORICAL_SEARCH
+ - HISTORICAL_VIEW
params:
$ref: "#/components/schemas/ActivityEventParams"
timestamp:
@@ -4181,6 +4181,39 @@ components:
LAST_TOKEN: The final token of a streaming response is received.
MANUAL_FEEDBACK: The user submitted textual manual feedback regarding the object.
MANUAL_FEEDBACK_SIDE_BY_SIDE: The user submitted comparative feedback for multiple side-by-side implementations.
+ FEEDBACK_TIME_SAVED: The user submitted feedback about time saved by an agent or workflow.
+ MARK_AS_READ: The user explicitly marked the content as read.
+ MESSAGE: The user attempted to send a message using their default messaing app.
+ MIDDLE_CLICK: The user middle clicked the object's primary link with the intent to open its full representation in a new tab.
+ PAGE_BLUR: The user puts a page out of focus but keeps it in the background.
+ PAGE_FOCUS: The user puts a page in focus, meaning it is the first to receive keyboard events.
+ PAGE_LEAVE: The user leaves a page and it is unloaded (by clicking a link, closing the tab/window, etc).
+ PREVIEW: The user clicked the object's inline preview affordance.
+ RIGHT_CLICK: The user right clicked the object's primary link. This may indicate an intent to open it in a new tab or copy it.
+ SECTION_CLICK: The user clicked a link to a subsection of the primary object.
+ SEEN: The user has likely seen the object (e.g. took action to make the object visible within the user's viewport).
+ SELECT: The user explicitly selected something, eg. a chat response variant they prefer.
+ SHARE: The user shared the object with another user.
+ SHOW_MORE: The user clicked the object's show more affordance.
+ UPVOTE: The user gave feedback that the object was useful.
+ VIEW: The object was visible within the user's viewport.
+ VISIBLE: The object was visible within the user's viewport.
+ x-speakeasy-enum-descriptions:
+ CLICK: The object's primary link was clicked with the intent to view its full representation. Depending on the object type, this may imply an external navigation or navigating to a new page or view within the Glean app.
+ CONTAINER_CLICK: A link to the object's parent container (e.g. the folder in which it's located) was clicked.
+ COPY_LINK: The user copied a link to the primary link.
+ CREATE: The user creates a document.
+ DISMISS: The user dismissed the object such that it was hidden from view.
+ DOWNVOTE: The user gave feedback that the object was not useful.
+ EMAIL: The user attempted to send an email.
+ EXECUTE: The user executed the object (e.g. ran a workflow).
+ FILTER: The user applied a filter.
+ FIRST_TOKEN: The first token of a streaming response is received.
+ FOCUS_IN: The user clicked into an interactive element, e.g. the search box.
+ LAST_TOKEN: The final token of a streaming response is received.
+ MANUAL_FEEDBACK: The user submitted textual manual feedback regarding the object.
+ MANUAL_FEEDBACK_SIDE_BY_SIDE: The user submitted comparative feedback for multiple side-by-side implementations.
+ FEEDBACK_TIME_SAVED: The user submitted feedback about time saved by an agent or workflow.
MARK_AS_READ: The user explicitly marked the content as read.
MESSAGE: The user attempted to send a message using their default messaing app.
MIDDLE_CLICK: The user middle clicked the object's primary link with the intent to open its full representation in a new tab.
@@ -4212,6 +4245,7 @@ components:
- LAST_TOKEN
- MANUAL_FEEDBACK
- MANUAL_FEEDBACK_SIDE_BY_SIDE
+ - FEEDBACK_TIME_SAVED
- MARK_AS_READ
- MESSAGE
- MIDDLE_CLICK
@@ -4229,37 +4263,6 @@ components:
- UPVOTE
- VIEW
- VISIBLE
- x-speakeasy-enum-descriptions:
- CLICK: The object's primary link was clicked with the intent to view its full representation. Depending on the object type, this may imply an external navigation or navigating to a new page or view within the Glean app.
- CONTAINER_CLICK: A link to the object's parent container (e.g. the folder in which it's located) was clicked.
- COPY_LINK: The user copied a link to the primary link.
- CREATE: The user creates a document.
- DISMISS: The user dismissed the object such that it was hidden from view.
- DOWNVOTE: The user gave feedback that the object was not useful.
- EMAIL: The user attempted to send an email.
- EXECUTE: The user executed the object (e.g. ran a workflow).
- FILTER: The user applied a filter.
- FIRST_TOKEN: The first token of a streaming response is received.
- FOCUS_IN: The user clicked into an interactive element, e.g. the search box.
- LAST_TOKEN: The final token of a streaming response is received.
- MANUAL_FEEDBACK: The user submitted textual manual feedback regarding the object.
- MANUAL_FEEDBACK_SIDE_BY_SIDE: The user submitted comparative feedback for multiple side-by-side implementations.
- MARK_AS_READ: The user explicitly marked the content as read.
- MESSAGE: The user attempted to send a message using their default messaing app.
- MIDDLE_CLICK: The user middle clicked the object's primary link with the intent to open its full representation in a new tab.
- PAGE_BLUR: The user puts a page out of focus but keeps it in the background.
- PAGE_FOCUS: The user puts a page in focus, meaning it is the first to receive keyboard events.
- PAGE_LEAVE: The user leaves a page and it is unloaded (by clicking a link, closing the tab/window, etc).
- PREVIEW: The user clicked the object's inline preview affordance.
- RIGHT_CLICK: The user right clicked the object's primary link. This may indicate an intent to open it in a new tab or copy it.
- SECTION_CLICK: The user clicked a link to a subsection of the primary object.
- SEEN: The user has likely seen the object (e.g. took action to make the object visible within the user's viewport).
- SELECT: The user explicitly selected something, eg. a chat response variant they prefer.
- SHARE: The user shared the object with another user.
- SHOW_MORE: The user clicked the object's show more affordance.
- UPVOTE: The user gave feedback that the object was useful.
- VIEW: The object was visible within the user's viewport.
- VISIBLE: The object was visible within the user's viewport.
position:
type: integer
description: Position of the element in the case that the client controls order (such as feed and autocomplete).
@@ -4422,17 +4425,23 @@ components:
LT: The value is less than the specified value.
GT: The value is greater than the specified value.
NOT_EQUALS: The value is not equal to the specified value.
- example: EQUALS
x-speakeasy-enum-descriptions:
EQUALS: The value is equal to the specified value.
ID_EQUALS: The value is equal to the specified ID.
LT: The value is less than the specified value.
GT: The value is greater than the specified value.
NOT_EQUALS: The value is not equal to the specified value.
+ example: EQUALS
isNegated:
type: boolean
deprecated: true
description: DEPRECATED - please use relationType instead
+ x-glean-deprecated:
+ id: 75a48c79-b36a-4171-a0a0-4af7189da66e
+ introduced: "2026-02-05"
+ message: Use relationType instead
+ removal: "2026-10-15"
+ x-speakeasy-deprecation-message: "Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Use relationType instead"
FacetFilter:
properties:
fieldName:
@@ -4618,18 +4627,18 @@ components:
QUERY_METADATA: Returns result counts for each result set which has non-zero results, as well as other information about the search such as suggested spelling corrections.
RESULTS: Return search result documents.
SPELLCHECK_METADATA: Return metadata pertaining to spellcheck results.
- enum:
- - ALL_RESULT_COUNTS
- - FACET_RESULTS
- - QUERY_METADATA
- - RESULTS
- - SPELLCHECK_METADATA
x-speakeasy-enum-descriptions:
ALL_RESULT_COUNTS: Return result counts for each result set which has non-zero results, even when the request itself is limited to a subset.
FACET_RESULTS: Return only facet results.
QUERY_METADATA: Returns result counts for each result set which has non-zero results, as well as other information about the search such as suggested spelling corrections.
RESULTS: Return search result documents.
SPELLCHECK_METADATA: Return metadata pertaining to spellcheck results.
+ enum:
+ - ALL_RESULT_COUNTS
+ - FACET_RESULTS
+ - QUERY_METADATA
+ - RESULTS
+ - SPELLCHECK_METADATA
timezoneOffset:
type: integer
description: The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC.
@@ -4955,6 +4964,8 @@ components:
format: date-time
description: The team member's start date
TeamEmail:
+ type: object
+ description: Information about a team's email
properties:
email:
type: string
@@ -4962,13 +4973,11 @@ components:
description: An email address
type:
type: string
- default: OTHER
description: An enum of `PRIMARY`, `SECONDARY`, `ONCALL`, `OTHER`
- type: object
+ default: OTHER
required:
- email
- type
- description: Information about a team's email
CustomFieldValueStr:
properties:
strText:
@@ -6141,6 +6150,12 @@ components:
$ref: "#/components/schemas/Document"
description: A truncated list of documents with this relation. TO BE DEPRECATED.
deprecated: true
+ x-glean-deprecated:
+ id: 68de0429-b0cc-4b40-8061-f848788079a2
+ introduced: "2026-02-05"
+ message: Field is deprecated
+ removal: "2026-10-15"
+ x-speakeasy-deprecation-message: "Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Field is deprecated"
results:
type: array
items:
@@ -6264,14 +6279,14 @@ components:
HERO: A high-confidence result that should feature prominently on the page.
PROMOTED: May not be the best result but should be given additional visual distinction.
STANDARD: Should not be distinct from any other results.
- enum:
- - HERO
- - PROMOTED
- - STANDARD
x-speakeasy-enum-descriptions:
HERO: A high-confidence result that should feature prominently on the page.
PROMOTED: May not be the best result but should be given additional visual distinction.
STANDARD: Should not be distinct from any other results.
+ enum:
+ - HERO
+ - PROMOTED
+ - STANDARD
source:
type: string
description: Source context for this result. Possible values depend on the result type.
@@ -6327,14 +6342,14 @@ components:
HERO: A high-confidence result that should feature prominently on the page.
PROMOTED: May not be the best result but should be given additional visual distinction.
STANDARD: Should not be distinct from any other results.
- enum:
- - HERO
- - PROMOTED
- - STANDARD
x-speakeasy-enum-descriptions:
HERO: A high-confidence result that should feature prominently on the page.
PROMOTED: May not be the best result but should be given additional visual distinction.
STANDARD: Should not be distinct from any other results.
+ enum:
+ - HERO
+ - PROMOTED
+ - STANDARD
PinDocumentMutableProperties:
properties:
queries:
@@ -6629,17 +6644,17 @@ components:
CONTRACTOR: The person is a current contractor of the company.
NON_EMPLOYEE: The person object represents a non-human actor such as a service or admin account.
FORMER_EMPLOYEE: The person is a previous employee of the company.
+ x-speakeasy-enum-descriptions:
+ FULL_TIME: The person is a current full-time employee of the company.
+ CONTRACTOR: The person is a current contractor of the company.
+ NON_EMPLOYEE: The person object represents a non-human actor such as a service or admin account.
+ FORMER_EMPLOYEE: The person is a previous employee of the company.
enum:
- FULL_TIME
- CONTRACTOR
- NON_EMPLOYEE
- FORMER_EMPLOYEE
example: FULL_TIME
- x-speakeasy-enum-descriptions:
- FULL_TIME: The person is a current full-time employee of the company.
- CONTRACTOR: The person is a current contractor of the company.
- NON_EMPLOYEE: The person object represents a non-human actor such as a service or admin account.
- FORMER_EMPLOYEE: The person is a previous employee of the company.
firstName:
type: string
description: The first name of the person
@@ -6814,13 +6829,6 @@ components:
DOMAIN_VISIBLE: Anyone in the domain can search for the document.
PUBLIC_LINK: Anyone with the link can see the document.
PUBLIC_VISIBLE: Anyone on the internet can search for the document.
- enum:
- - PRIVATE
- - SPECIFIC_PEOPLE_AND_GROUPS
- - DOMAIN_LINK
- - DOMAIN_VISIBLE
- - PUBLIC_LINK
- - PUBLIC_VISIBLE
x-speakeasy-enum-descriptions:
PRIVATE: Only one person is able to see the document.
SPECIFIC_PEOPLE_AND_GROUPS: Only specific people and/or groups can see the document.
@@ -6828,9 +6836,16 @@ components:
DOMAIN_VISIBLE: Anyone in the domain can search for the document.
PUBLIC_LINK: Anyone with the link can see the document.
PUBLIC_VISIBLE: Anyone on the internet can search for the document.
- Reaction:
- properties:
- type:
+ enum:
+ - PRIVATE
+ - SPECIFIC_PEOPLE_AND_GROUPS
+ - DOMAIN_LINK
+ - DOMAIN_VISIBLE
+ - PUBLIC_LINK
+ - PUBLIC_VISIBLE
+ Reaction:
+ properties:
+ type:
type: string
count:
type: integer
@@ -6868,6 +6883,12 @@ components:
deprecated: true
items:
type: string
+ x-glean-deprecated:
+ id: cd754845-6eec-480f-b395-c93478aff563
+ introduced: "2026-02-05"
+ message: Use reacts instead
+ removal: "2026-10-15"
+ x-speakeasy-deprecation-message: "Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Use reacts instead"
reacts:
type: array
items:
@@ -6889,6 +6910,13 @@ components:
- VIEWER
description: DEPRECATED - use permissions instead. Viewer's role on the specific document.
deprecated: true
+ x-glean-deprecated:
+ - id: fbc55efe-3e6c-485c-8b60-bab574c3813b
+ introduced: "2026-02-05"
+ kind: property
+ message: Use permissions instead
+ removal: "2026-10-15"
+ x-speakeasy-deprecation-message: "Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Use permissions instead"
lastViewedTime:
type: string
format: date-time
@@ -7312,13 +7340,6 @@ components:
FAST: Uses an agent powered by the agentic engine that responds faster but may have lower quality results. Requires the agentic engine to be enabled in the deployment.
ADVANCED: Uses an agent powered by the agentic engine that thinks for longer and potentially makes more LLM calls to return higher quality results. Requires the agentic engine to be enabled in the deployment.
AUTO: Uses an agent powered by the agentic engine that routes between reasoning efforts based on the question and context.
- enum:
- - DEFAULT
- - GPT
- - UNIVERSAL
- - FAST
- - ADVANCED
- - AUTO
x-speakeasy-enum-descriptions:
DEFAULT: Integrates with your company's knowledge. This will soon be deprecated in favor of the FAST and ADVANCED `agent` values
GPT: Communicates directly with the LLM. This will soon be deprecated in favor of the FAST and ADVANCED `agent` values
@@ -7326,6 +7347,13 @@ components:
FAST: Uses an agent powered by the agentic engine that responds faster but may have lower quality results. Requires the agentic engine to be enabled in the deployment.
ADVANCED: Uses an agent powered by the agentic engine that thinks for longer and potentially makes more LLM calls to return higher quality results. Requires the agentic engine to be enabled in the deployment.
AUTO: Uses an agent powered by the agentic engine that routes between reasoning efforts based on the question and context.
+ enum:
+ - DEFAULT
+ - GPT
+ - UNIVERSAL
+ - FAST
+ - ADVANCED
+ - AUTO
toolSets:
$ref: "#/components/schemas/ToolSets"
mode:
@@ -7334,12 +7362,12 @@ components:
x-enumDescriptions:
DEFAULT: Used if no mode supplied.
QUICK: Deprecated.
- enum:
- - DEFAULT
- - QUICK
x-speakeasy-enum-descriptions:
DEFAULT: Used if no mode supplied.
QUICK: Deprecated.
+ enum:
+ - DEFAULT
+ - QUICK
useImageGeneration:
type: boolean
description: Whether the agent should create an image.
@@ -7721,16 +7749,6 @@ components:
HEADING: A heading message used to distinguish different sections of the holistic response.
WARNING: A warning message to be shown to the user.
SERVER_TOOL: A message used to for server-side tool auth/use, for request and response.
- enum:
- - UPDATE
- - CONTENT
- - CONTEXT
- - DEBUG
- - DEBUG_EXTERNAL
- - ERROR
- - HEADING
- - WARNING
- - SERVER_TOOL
x-speakeasy-enum-descriptions:
UPDATE: An intermediate state message for progress updates.
CONTENT: A user query or response message.
@@ -7741,6 +7759,16 @@ components:
HEADING: A heading message used to distinguish different sections of the holistic response.
WARNING: A warning message to be shown to the user.
SERVER_TOOL: A message used to for server-side tool auth/use, for request and response.
+ enum:
+ - UPDATE
+ - CONTENT
+ - CONTEXT
+ - DEBUG
+ - DEBUG_EXTERNAL
+ - ERROR
+ - HEADING
+ - WARNING
+ - SERVER_TOOL
hasMoreFragments:
deprecated: true
type: boolean
@@ -9755,26 +9783,26 @@ components:
CHANNEL: A standard section for channel-based digests (e.g. from Slack, Teams).
MENTIONS: A dedicated section that surfaces user mentions (actionable, informative, or all).
TOPIC: A section driven by a generic topic, not tied to any specific channel or instance.
- enum:
- - CHANNEL
- - MENTIONS
- - TOPIC
x-speakeasy-enum-descriptions:
CHANNEL: A standard section for channel-based digests (e.g. from Slack, Teams).
MENTIONS: A dedicated section that surfaces user mentions (actionable, informative, or all).
TOPIC: A section driven by a generic topic, not tied to any specific channel or instance.
+ enum:
+ - CHANNEL
+ - MENTIONS
+ - TOPIC
UpdateType:
type: string
description: Optional type classification for the update.
x-enumDescriptions:
ACTIONABLE: Updates that require user attention or action
INFORMATIVE: Updates that are purely informational
- enum:
- - ACTIONABLE
- - INFORMATIVE
x-speakeasy-enum-descriptions:
ACTIONABLE: Updates that require user attention or action
INFORMATIVE: Updates that are purely informational
+ enum:
+ - ACTIONABLE
+ - INFORMATIVE
DigestUpdate:
type: object
properties:
@@ -10288,12 +10316,12 @@ components:
x-enumDescriptions:
STANDARD: Used by default for all requests and satisfies all standard use cases for list requests. Limited to 10000 entities.
FULL_DIRECTORY: Used exclusively to return a comprehensive list of all people entities in the organization, typically for audit like purposes. The recommended approach is to sort by FIRST_NAME or LAST_NAME, and use pagination for large organizations.
- enum:
- - STANDARD
- - FULL_DIRECTORY
x-speakeasy-enum-descriptions:
STANDARD: Used by default for all requests and satisfies all standard use cases for list requests. Limited to 10000 entities.
FULL_DIRECTORY: Used exclusively to return a comprehensive list of all people entities in the organization, typically for audit like purposes. The recommended approach is to sort by FIRST_NAME or LAST_NAME, and use pagination for large organizations.
+ enum:
+ - STANDARD
+ - FULL_DIRECTORY
EntitiesSortOrder:
type: string
description: Different ways of sorting entities
@@ -10380,15 +10408,15 @@ components:
x-enumDescriptions:
PEOPLE_WITHOUT_MANAGER: Returns all people without a manager apart from the requested IDs.
INVALID_ENTITIES: Includes invalid entities in the response if any of the requested IDs are invalid.
+ x-speakeasy-enum-descriptions:
+ PEOPLE_WITHOUT_MANAGER: Returns all people without a manager apart from the requested IDs.
+ INVALID_ENTITIES: Includes invalid entities in the response if any of the requested IDs are invalid.
type: array
items:
type: string
enum:
- PEOPLE_WITHOUT_MANAGER
- INVALID_ENTITIES
- x-speakeasy-enum-descriptions:
- PEOPLE_WITHOUT_MANAGER: Returns all people without a manager apart from the requested IDs.
- INVALID_ENTITIES: Includes invalid entities in the response if any of the requested IDs are invalid.
source:
type: string
description: A string denoting the search surface from which the endpoint is called.
@@ -10719,19 +10747,20 @@ components:
description: The error message if applicable
IndexDocumentRequest:
type: object
+ description: Describes the request body of the /indexdocument API call
properties:
version:
type: integer
format: int64
description: Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done.
document:
- $ref: '#/components/schemas/DocumentDefinition'
description: Document being added/updated
+ $ref: "#/components/schemas/DocumentDefinition"
required:
- document
- description: Describes the request body of the /indexdocument API call
IndexDocumentsRequest:
type: object
+ description: Describes the request body of the /indexdocuments API call
properties:
uploadId:
type: string
@@ -10740,16 +10769,16 @@ components:
type: string
description: Datasource of the documents
documents:
+ description: Batch of documents being added/updated
type: array
items:
- $ref: '#/components/schemas/DocumentDefinition'
- description: Batch of documents being added/updated
+ $ref: "#/components/schemas/DocumentDefinition"
required:
- documents
- datasource
- description: Describes the request body of the /indexdocuments API call
UpdatePermissionsRequest:
type: object
+ description: Describes the request body of the /updatepermissions API call
properties:
datasource:
type: string
@@ -10764,30 +10793,30 @@ components:
description: |
The permalink for viewing the document. **Note: viewURL is a required field if id was not set when uploading the document.**'
permissions:
- $ref: '#/components/schemas/DocumentPermissionsDefinition'
+ $ref: "#/components/schemas/DocumentPermissionsDefinition"
description: The permissions that define who can view this document in the search results. Please refer to [this](https://developers.glean.com/indexing/documents/permissions) for more details.
required:
- permissions
- datasource
- description: Describes the request body of the /updatepermissions API call
GetDocumentCountRequest:
type: object
+ description: Describes the request body of the /getdocumentcount API call
properties:
datasource:
type: string
description: Datasource name for which document count is needed.
required:
- datasource
- description: Describes the request body of the /getdocumentcount API call
GetDocumentCountResponse:
type: object
+ description: Describes the response body of the /getdocumentcount API call
properties:
documentCount:
type: integer
description: Number of documents corresponding to the specified custom datasource.
- description: Describes the response body of the /getdocumentcount API call
GetDocumentStatusRequest:
type: object
+ description: Describes the request body for /getdocumentstatus API call
properties:
datasource:
type: string
@@ -10802,9 +10831,9 @@ components:
- datasource
- objectType
- docId
- description: Describes the request body for /getdocumentstatus API call
GetDocumentStatusResponse:
type: object
+ description: Describes the response body of the /getdocumentstatus API call
properties:
uploadStatus:
type: string
@@ -10820,9 +10849,11 @@ components:
type: integer
format: int64
description: Time of last successful indexing, in epoch seconds
- description: Describes the response body of the /getdocumentstatus API call
BulkIndexRequest:
type: object
+ description: Describes the request body of a bulk upload API call
+ required:
+ - uploadId
properties:
uploadId:
type: string
@@ -10836,70 +10867,68 @@ components:
forceRestartUpload:
type: boolean
description: Flag to discard previous upload attempts and start from scratch. Must be specified with isFirstPage=true
- required:
- - uploadId
- description: Describes the request body of a bulk upload API call
BulkIndexTeamsRequest:
type: object
+ description: Describes the request body of the /bulkindexteams API call
allOf:
- - $ref: '#/components/schemas/BulkIndexRequest'
+ - $ref: "#/components/schemas/BulkIndexRequest"
- type: object
properties:
teams:
+ description: Batch of team information
type: array
items:
- $ref: '#/components/schemas/TeamInfoDefinition'
- description: Batch of team information
+ $ref: "#/components/schemas/TeamInfoDefinition"
required:
- teams
- description: Describes the request body of the /bulkindexteams API call
BulkIndexEmployeesRequest:
type: object
+ description: Describes the request body of the /bulkindexemployees API call
allOf:
- - $ref: '#/components/schemas/BulkIndexRequest'
+ - $ref: "#/components/schemas/BulkIndexRequest"
- type: object
properties:
employees:
+ description: Batch of employee information
type: array
items:
- $ref: '#/components/schemas/EmployeeInfoDefinition'
- description: Batch of employee information
+ $ref: "#/components/schemas/EmployeeInfoDefinition"
disableStaleDataDeletionCheck:
type: boolean
description: True if older employee data needs to be force deleted after the upload completes. Defaults to older data being deleted only if the percentage of data being deleted is less than 20%. This must only be set when `isLastPage = true`
required:
- employees
- description: Describes the request body of the /bulkindexemployees API call
BulkIndexDocumentsRequest:
type: object
+ description: Describes the request body of the /bulkindexdocuments API call
allOf:
- - $ref: '#/components/schemas/BulkIndexRequest'
+ - $ref: "#/components/schemas/BulkIndexRequest"
- type: object
properties:
datasource:
type: string
description: Datasource of the documents
documents:
+ description: Batch of documents for the datasource
type: array
items:
- $ref: '#/components/schemas/DocumentDefinition'
- description: Batch of documents for the datasource
+ $ref: "#/components/schemas/DocumentDefinition"
disableStaleDocumentDeletionCheck:
type: boolean
description: True if older documents need to be force deleted after the upload completes. Defaults to older documents being deleted asynchronously. This must only be set when `isLastPage = true`
required:
- datasource
- documents
- description: Describes the request body of the /bulkindexdocuments API call
ProcessAllDocumentsRequest:
type: object
+ description: Describes the request body of the /processalldocuments API call
properties:
datasource:
type: string
description: If provided, process documents only for this custom datasource. Otherwise all uploaded documents are processed.
- description: Describes the request body of the /processalldocuments API call
DeleteDocumentRequest:
type: object
+ description: Describes the request body of the /deletedocument API call
properties:
version:
type: integer
@@ -10918,9 +10947,9 @@ components:
- datasource
- id
- objectType
- description: Describes the request body of the /deletedocument API call
IndexUserRequest:
type: object
+ description: Describes the request body of the /indexuser API call
properties:
version:
type: integer
@@ -10930,30 +10959,30 @@ components:
type: string
description: The datasource for which the user is added
user:
- $ref: '#/components/schemas/DatasourceUserDefinition'
description: The user to be added or updated
+ $ref: "#/components/schemas/DatasourceUserDefinition"
required:
- datasource
- user
- description: Describes the request body of the /indexuser API call
GetUserCountRequest:
type: object
+ description: Describes the request body of the /getusercount API call
properties:
datasource:
type: string
description: Datasource name for which user count is needed.
required:
- datasource
- description: Describes the request body of the /getusercount API call
GetUserCountResponse:
type: object
+ description: Describes the response body of the /getusercount API call
properties:
userCount:
type: integer
description: Number of users corresponding to the specified custom datasource.
- description: Describes the response body of the /getusercount API call
BulkIndexUsersRequest:
type: object
+ description: Describes the request body for the /bulkindexusers API call
properties:
uploadId:
type: string
@@ -10971,10 +11000,10 @@ components:
type: string
description: datasource of the users
users:
+ description: batch of users for the datasource
type: array
items:
- $ref: '#/components/schemas/DatasourceUserDefinition'
- description: batch of users for the datasource
+ $ref: "#/components/schemas/DatasourceUserDefinition"
disableStaleDataDeletionCheck:
type: boolean
description: True if older user data needs to be force deleted after the upload completes. Defaults to older data being deleted only if the percentage of data being deleted is less than a reasonable threshold. This must only be set when `isLastPage = true`
@@ -10982,31 +11011,31 @@ components:
- uploadId
- datasource
- users
- description: Describes the request body for the /bulkindexusers API call
GreenlistUsersRequest:
type: object
+ description: Describes the request body of the /betausers API call
properties:
datasource:
type: string
description: Datasource which needs to be made visible to users specified in the `emails` field.
emails:
type: array
+ description: The emails of the beta users
items:
type: string
format: email
- description: The emails of the beta users
required:
- datasource
- emails
- description: Describes the request body of the /betausers API call
DatasourceUserDefinition:
type: object
+ description: describes a user in the datasource
properties:
email:
type: string
userId:
- type: string
description: To be supplied if the user id in the datasource is not the email
+ type: string
name:
type: string
isActive:
@@ -11015,9 +11044,9 @@ components:
required:
- email
- name
- description: describes a user in the datasource
IndexGroupRequest:
type: object
+ description: Describes the request body of the /indexgroup API call
properties:
version:
type: integer
@@ -11027,14 +11056,14 @@ components:
type: string
description: The datasource for which the group is added
group:
- $ref: '#/components/schemas/DatasourceGroupDefinition'
description: The group to be added or updated
+ $ref: "#/components/schemas/DatasourceGroupDefinition"
required:
- datasource
- group
- description: Describes the request body of the /indexgroup API call
BulkIndexGroupsRequest:
type: object
+ description: Describes the request body for the /bulkindexgroups API call
properties:
uploadId:
type: string
@@ -11052,10 +11081,10 @@ components:
type: string
description: datasource of the groups
groups:
+ description: batch of groups for the datasource
type: array
items:
- $ref: '#/components/schemas/DatasourceGroupDefinition'
- description: batch of groups for the datasource
+ $ref: "#/components/schemas/DatasourceGroupDefinition"
disableStaleDataDeletionCheck:
type: boolean
description: True if older group data needs to be force deleted after the upload completes. Defaults to older data being deleted only if the percentage of data being deleted is less than a reasonable threshold. This must only be set when `isLastPage = true`
@@ -11063,18 +11092,18 @@ components:
- uploadId
- datasource
- groups
- description: Describes the request body for the /bulkindexgroups API call
DatasourceGroupDefinition:
type: object
+ description: describes a group in the datasource
properties:
name:
type: string
description: name of the group. Should be unique among all groups for the datasource, and cannot have spaces.
required:
- name
- description: describes a group in the datasource
IndexMembershipRequest:
type: object
+ description: Describes the request body of the /indexmembership API call
properties:
version:
type: integer
@@ -11084,14 +11113,14 @@ components:
type: string
description: The datasource for which the membership is added
membership:
- $ref: '#/components/schemas/DatasourceMembershipDefinition'
description: The membership to be added or updated
+ $ref: "#/components/schemas/DatasourceMembershipDefinition"
required:
- datasource
- membership
- description: Describes the request body of the /indexmembership API call
BulkIndexMembershipsRequest:
type: object
+ description: Describes the request body for the /bulkindexmemberships API call
properties:
uploadId:
type: string
@@ -11112,49 +11141,49 @@ components:
type: string
description: group who's memberships are specified
memberships:
+ description: batch of memberships for the group
type: array
items:
- $ref: '#/components/schemas/DatasourceBulkMembershipDefinition'
- description: batch of memberships for the group
+ $ref: "#/components/schemas/DatasourceBulkMembershipDefinition"
required:
- uploadId
- datasource
- memberships
- description: Describes the request body for the /bulkindexmemberships API call
ProcessAllMembershipsRequest:
type: object
+ description: Describes the request body of the /processallmemberships API call
properties:
datasource:
type: string
description: If provided, process group memberships only for this custom datasource. Otherwise all uploaded memberships are processed.
- description: Describes the request body of the /processallmemberships API call
DatasourceMembershipDefinition:
type: object
+ description: describes the membership row of a group. Only one of memberUserId and memberGroupName can be specified.
properties:
groupName:
- type: string
description: The group for which the membership is specified
- memberUserId:
type: string
+ memberUserId:
description: If the member is a user, then the email or datasource id for the user
- memberGroupName:
type: string
+ memberGroupName:
description: If the member is a group, then the name of the member group
+ type: string
required:
- groupName
- description: describes the membership row of a group. Only one of memberUserId and memberGroupName can be specified.
DatasourceBulkMembershipDefinition:
type: object
+ description: describes the membership row of a group in the bulk uploaded. Only one of memberUserId and memberGroupName can be specified.
properties:
memberUserId:
- type: string
description: If the member is a user, then the email or datasource id for the user
- memberGroupName:
type: string
+ memberGroupName:
description: If the member is a group, then the name of the member group
- description: describes the membership row of a group in the bulk uploaded. Only one of memberUserId and memberGroupName can be specified.
+ type: string
DeleteUserRequest:
type: object
+ description: Describes the request body of the /deleteuser API call
properties:
version:
type: integer
@@ -11164,14 +11193,14 @@ components:
type: string
description: The datasource for which the user is removed
email:
- type: string
description: The email of the user to be deleted
+ type: string
required:
- datasource
- email
- description: Describes the request body of the /deleteuser API call
DeleteGroupRequest:
type: object
+ description: Describes the request body of the /deletegroup API call
properties:
version:
type: integer
@@ -11181,14 +11210,14 @@ components:
type: string
description: The datasource for which the group is removed
groupName:
- type: string
description: the name of the group to be deleted
+ type: string
required:
- datasource
- groupName
- description: Describes the request body of the /deletegroup API call
DeleteMembershipRequest:
type: object
+ description: Describes the request body of the /deletemembership API call
properties:
version:
type: integer
@@ -11198,36 +11227,36 @@ components:
type: string
description: The datasource for which the membership is removed
membership:
- $ref: '#/components/schemas/DatasourceMembershipDefinition'
description: the name of the membership to be deleted
+ $ref: "#/components/schemas/DatasourceMembershipDefinition"
required:
- datasource
- membership
- description: Describes the request body of the /deletemembership API call
DeleteEmployeeRequest:
type: object
+ description: Describes the request body of the /deleteemployee API call
properties:
version:
type: integer
format: int64
description: Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done.
employeeEmail:
- type: string
description: The deleted employee's email
+ type: string
required:
- employeeEmail
- description: Describes the request body of the /deleteemployee API call
DeleteTeamRequest:
type: object
+ description: Describes the request body of the /deleteteam API call
properties:
id:
- type: string
description: The deleted team's id
+ type: string
required:
- id
- description: Describes the request body of the /deleteteam API call
DocumentDefinition:
type: object
+ description: Indexable document structure
properties:
title:
type: string
@@ -11258,16 +11287,16 @@ components:
description: |
The datasource specific id for the document. This field is case insensitive and should not be more than 200 characters in length. Note: id is a required field for datasources created after 1st March 2025
summary:
- $ref: '#/components/schemas/ContentDefinition'
+ $ref: "#/components/schemas/ContentDefinition"
body:
- $ref: '#/components/schemas/ContentDefinition'
+ $ref: "#/components/schemas/ContentDefinition"
author:
- $ref: '#/components/schemas/UserReferenceDefinition'
+ $ref: "#/components/schemas/UserReferenceDefinition"
owner:
- $ref: '#/components/schemas/UserReferenceDefinition'
+ $ref: "#/components/schemas/UserReferenceDefinition"
description: The current owner of the document, if not the author.
permissions:
- $ref: '#/components/schemas/DocumentPermissionsDefinition'
+ $ref: "#/components/schemas/DocumentPermissionsDefinition"
description: The permissions that define who can view this document in the search results. Please refer to [this](https://developers.glean.com/indexing/documents/permissions) for more details.
createdAt:
type: integer
@@ -11278,14 +11307,14 @@ components:
format: int64
description: The last update time, in epoch seconds.
updatedBy:
- $ref: '#/components/schemas/UserReferenceDefinition'
+ $ref: "#/components/schemas/UserReferenceDefinition"
tags:
type: array
items:
type: string
description: Labels associated with the document.
interactions:
- $ref: '#/components/schemas/DocumentInteractionsDefinition'
+ $ref: "#/components/schemas/DocumentInteractionsDefinition"
status:
type: string
additionalUrls:
@@ -11296,27 +11325,27 @@ components:
comments:
type: array
items:
- $ref: '#/components/schemas/CommentDefinition'
+ $ref: "#/components/schemas/CommentDefinition"
description: Comments associated with the document.
customProperties:
type: array
items:
- $ref: '#/components/schemas/CustomProperty'
+ $ref: "#/components/schemas/CustomProperty"
description: Additional metadata properties of the document. These can surface as [facets and operators](https://developers.glean.com/indexing/datasource/custom-properties/operators_and_facets).
required:
- datasource
- description: Indexable document structure
CommentDefinition:
type: object
+ description: Describes a comment on a document
properties:
id:
type: string
description: The document specific id for the comment. This field is case insensitive and should not be more than 200 characters in length.
author:
- $ref: '#/components/schemas/UserReferenceDefinition'
+ $ref: "#/components/schemas/UserReferenceDefinition"
description: The author of the comment.
content:
- $ref: '#/components/schemas/ContentDefinition'
+ $ref: "#/components/schemas/ContentDefinition"
description: The content of the comment.
createdAt:
type: integer
@@ -11327,13 +11356,13 @@ components:
format: int64
description: The last updated time, in epoch seconds.
updatedBy:
- $ref: '#/components/schemas/UserReferenceDefinition'
+ $ref: "#/components/schemas/UserReferenceDefinition"
description: The user who last updated the comment.
required:
- id
- description: Describes a comment on a document
ContentDefinition:
type: object
+ description: Describes text content or base64 encoded binary content
properties:
mimeType:
type: string
@@ -11345,9 +11374,9 @@ components:
description: base64 encoded binary content. Only one of textContent or binary content can be specified
required:
- mimeType
- description: Describes text content or base64 encoded binary content
UserReferenceDefinition:
type: object
+ description: Describes how a user is referenced in a document. The user can be referenced by email or by a datasource specific id.
properties:
email:
type: string
@@ -11356,42 +11385,42 @@ components:
description: some datasources refer to the user by the datasource user id in the document
name:
type: string
- description: Describes how a user is referenced in a document. The user can be referenced by email or by a datasource specific id.
PermissionsGroupIntersectionDefinition:
type: object
+ description: describes a list of groups that are all required in a permissions constraint
properties:
requiredGroups:
type: array
items:
type: string
- description: describes a list of groups that are all required in a permissions constraint
DocumentPermissionsDefinition:
type: object
+ description: describes the access control details of the document
properties:
allowedUsers:
+ description: List of users who can view the document
type: array
items:
- $ref: '#/components/schemas/UserReferenceDefinition'
- description: List of users who can view the document
+ $ref: "#/components/schemas/UserReferenceDefinition"
allowedGroups:
+ description: List of groups that can view the document
type: array
items:
type: string
- description: List of groups that can view the document
allowedGroupIntersections:
+ description: List of allowed group intersections. This describes a permissions constraint of the form ((GroupA AND GroupB AND GroupC) OR (GroupX AND GroupY) OR ...
type: array
items:
- $ref: '#/components/schemas/PermissionsGroupIntersectionDefinition'
- description: List of allowed group intersections. This describes a permissions constraint of the form ((GroupA AND GroupB AND GroupC) OR (GroupX AND GroupY) OR ...
+ $ref: "#/components/schemas/PermissionsGroupIntersectionDefinition"
allowAnonymousAccess:
- type: boolean
description: If true, then any Glean user can view the document
- allowAllDatasourceUsersAccess:
type: boolean
+ allowAllDatasourceUsersAccess:
description: If true, then any user who has an account in the datasource can view the document.
- description: describes the access control details of the document
+ type: boolean
DocumentInteractionsDefinition:
type: object
+ description: describes the interactions on the document
properties:
numViews:
type: integer
@@ -11399,9 +11428,9 @@ components:
type: integer
numComments:
type: integer
- description: describes the interactions on the document
CheckDocumentAccessRequest:
type: object
+ description: Describes the request body of the /checkdocumentaccess API call
properties:
datasource:
type: string
@@ -11420,44 +11449,44 @@ components:
- objectType
- docId
- userEmail
- description: Describes the request body of the /checkdocumentaccess API call
CheckDocumentAccessResponse:
type: object
+ description: Describes the response body of the /checkdocumentaccess API call
properties:
hasAccess:
type: boolean
description: If true, user has access to document for search
- description: Describes the response body of the /checkdocumentaccess API call
CustomProperty:
type: object
+ description: Describes the custom properties of the object.
properties:
name:
type: string
value:
description: Must either be a string or an array of strings. An integer, boolean, etc. is not valid. When OpenAPI Generator supports `oneOf`, we can semantically enforce this.
- description: Describes the custom properties of the object.
DatasourceConfig:
- $ref: '#/components/schemas/SharedDatasourceConfig'
+ $ref: "#/components/schemas/SharedDatasourceConfig"
GetDatasourceConfigRequest:
type: object
+ description: Describes the request body of the /getdatasourceconfig API call
properties:
datasource:
type: string
description: Datasource name for which config is needed.
required:
- datasource
- description: Describes the request body of the /getdatasourceconfig API call
DatasourceConfigList:
+ description: List of datasource configurations.
+ required:
+ - datasourceConfig
properties:
datasourceConfig:
type: array
- items:
- $ref: '#/components/schemas/SharedDatasourceConfig'
description: Datasource configuration.
- required:
- - datasourceConfig
- description: List of datasource configurations.
+ items:
+ $ref: "#/components/schemas/SharedDatasourceConfig"
RotateTokenResponse:
+ description: Describes the response body of the /rotatetoken API call
properties:
rawSecret:
type: string
@@ -11470,31 +11499,31 @@ components:
type: integer
format: int64
description: Refers to the time period in minutes before which this token needs to be rotated. It is required to rotate the token within the specified `rotationPeriodMinutes` after each `/rotatetoken` call, otherwise the tokens would expire. Note that the token would still expire at `expiresAt` timestamp provided during token creation even if the token is being regularly rotated. `rotationPeriodMinutes` property is inherited from the parent token being rotated
- description: Describes the response body of the /rotatetoken API call
IndexEmployeeRequest:
type: object
+ description: Info about an employee and optional version for that info
properties:
employee:
- $ref: '#/components/schemas/EmployeeInfoDefinition'
description: Info about the employee
+ $ref: "#/components/schemas/EmployeeInfoDefinition"
version:
+ description: Version number for the employee object. If absent or 0 then no version checks are done
type: integer
format: int64
- description: Version number for the employee object. If absent or 0 then no version checks are done
required:
- employee
- description: Info about an employee and optional version for that info
IndexEmployeeListRequest:
type: object
+ description: Describes the request body of the /indexemployeelist API call
properties:
employees:
+ description: List of employee info and version.
type: array
items:
- $ref: '#/components/schemas/IndexEmployeeRequest'
- description: List of employee info and version.
- description: Describes the request body of the /indexemployeelist API call
+ $ref: "#/components/schemas/IndexEmployeeRequest"
SocialNetworkDefinition:
type: object
+ description: Employee's social network profile
properties:
name:
type: string
@@ -11505,18 +11534,15 @@ components:
profileUrl:
type: string
description: Link to profile.
- description: Employee's social network profile
AdditionalFieldDefinition:
type: object
+ description: Additional information about the employee or team.
properties:
key:
type: string
description: Key to reference this field, e.g. "languages". Note that the key should be all lowercase alphabetic characters with no numbers, spaces, hyphens or underscores.
value:
type: array
- items:
- type: object
- description: Either a string or HypertextField. When OpenAPI Generator supports oneOf, we can semantically enforce this in the docs.
description: |
List of type string or HypertextField.
@@ -11533,7 +11559,9 @@ components:
**Note**: If using the Python SDK to pass in a list of strings, the value may need to be a list of dictionaries. In that case, the key in that dictionary will be ignored.
Example: ```"languages": [{"lang":"English","lang":"Spanish",...}]```. In this case, the key "lang" will be ignored and can even be passed in as an empty string.
- description: Additional information about the employee or team.
+ items:
+ type: object
+ description: Either a string or HypertextField. When OpenAPI Generator supports oneOf, we can semantically enforce this in the docs.
HypertextField:
type: object
properties:
@@ -11545,6 +11573,7 @@ components:
description: URL for the hypertext field.
EmployeeInfoDefinition:
type: object
+ description: Describes employee info
properties:
email:
type: string
@@ -11571,15 +11600,15 @@ components:
type: string
description: The employee's location (city/office name etc).
deprecated: true
- x-speakeasy-deprecation-message: "Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Field is deprecated"
x-glean-deprecated:
id: a7f6fbaa-0eaf-4c0c-a4f5-ab90347f73fd
introduced: "2026-02-05"
message: Field is deprecated
removal: "2026-10-15"
+ x-speakeasy-deprecation-message: "Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Field is deprecated"
structuredLocation:
- $ref: '#/components/schemas/StructuredLocation'
description: Detailed location with information about country, state, city etc.
+ $ref: "#/components/schemas/StructuredLocation"
title:
type: string
description: The employee's role title.
@@ -11595,14 +11624,14 @@ components:
description: An organizational unit where everyone has a similar task, e.g. `Engineering`.
datasourceProfiles:
type: array
- items:
- $ref: '#/components/schemas/DatasourceProfile'
description: The datasource profiles of the employee, e.g. `Slack`,`Github`.
+ items:
+ $ref: "#/components/schemas/DatasourceProfile"
teams:
type: array
- items:
- $ref: '#/components/schemas/EmployeeTeamInfo'
description: Info about the employee's team(s)
+ items:
+ $ref: "#/components/schemas/EmployeeTeamInfo"
startDate:
type: string
format: date
@@ -11619,17 +11648,17 @@ components:
description: She/her, He/his or other pronoun.
alsoKnownAs:
type: array
+ description: Other names associated with the employee.
items:
type: string
- description: Other names associated with the employee.
profileUrl:
type: string
description: Link to internal company person profile.
socialNetworks:
type: array
- items:
- $ref: '#/components/schemas/SocialNetworkDefinition'
description: List of social network profiles.
+ items:
+ $ref: "#/components/schemas/SocialNetworkDefinition"
managerEmail:
type: string
description: The email of the employee's manager
@@ -11643,37 +11672,37 @@ components:
default: FULL_TIME
relationships:
type: array
- items:
- $ref: '#/components/schemas/EntityRelationship'
description: List of unidirectional relationships with other employees. E.g. this employee (`A`) is a CHIEF_OF_STAFF to another employee (`B`); or this employee (`A`) is an EXECUTIVE_ASSISTANT of another employee (`C`). The mapping should be attached to `A`'s profile.
+ items:
+ $ref: "#/components/schemas/EntityRelationship"
status:
type: string
description: The status of the employee, an enum of `CURRENT`, `FUTURE`, `EX`
default: CURRENT
additionalFields:
type: array
- items:
- $ref: '#/components/schemas/AdditionalFieldDefinition'
description: List of additional fields with more information about the employee.
+ items:
+ $ref: "#/components/schemas/AdditionalFieldDefinition"
required:
- department
- email
- description: Describes employee info
EmployeeAndVersionDefinition:
type: object
+ description: describes info about an employee and optional version for that info
properties:
employee:
- $ref: '#/components/schemas/EmployeeInfoDefinition'
description: Info about the employee
+ $ref: "#/components/schemas/EmployeeInfoDefinition"
version:
+ description: Version number for the employee object. If absent or 0 then no version checks are done
type: integer
format: int64
- description: Version number for the employee object. If absent or 0 then no version checks are done
required:
- info
- description: describes info about an employee and optional version for that info
EmployeeTeamInfo:
type: object
+ description: Information about which team an employee belongs to
properties:
id:
type: string
@@ -11685,9 +11714,12 @@ components:
type: string
format: uri
description: Link to internal company team page
- description: Information about which team an employee belongs to
EntityRelationship:
type: object
+ description: Describes a relationship edge between a source and destination entity
+ required:
+ - name
+ - email
properties:
name:
type: string
@@ -11695,17 +11727,14 @@ components:
email:
type: string
description: Email of the person with whom the relationship exists. Per the example above, either `B` or `C`'s email depending on the relationship.
- required:
- - name
- - email
- description: Describes a relationship edge between a source and destination entity
TeamMember:
type: object
+ description: Information about a team's member
properties:
email:
type: string
- format: email
description: The member's email
+ format: email
relationship:
type: string
description: The member's relationship to the team, an enum of `MEMBER`, `MANAGER`, `LEAD`, `POINT_OF_CONTACT`, `OTHER`
@@ -11716,9 +11745,9 @@ components:
description: The member's start date
required:
- email
- description: Information about a team's member
TeamInfoDefinition:
type: object
+ description: Information about an employee's team
properties:
id:
type: string
@@ -11746,121 +11775,120 @@ components:
A link to an external team page. If set, team results will link to it.
emails:
type: array
- items:
- $ref: '#/components/schemas/TeamEmail'
description: The emails of the team
+ items:
+ $ref: "#/components/schemas/TeamEmail"
datasourceProfiles:
type: array
- items:
- $ref: '#/components/schemas/DatasourceProfile'
description: The datasource profiles of the team, e.g. `Slack`,`Github`.
+ items:
+ $ref: "#/components/schemas/DatasourceProfile"
members:
type: array
- items:
- $ref: '#/components/schemas/TeamMember'
description: The members of the team
+ items:
+ $ref: "#/components/schemas/TeamMember"
additionalFields:
type: array
- items:
- $ref: '#/components/schemas/AdditionalFieldDefinition'
description: List of additional fields with more information about the team.
+ items:
+ $ref: "#/components/schemas/AdditionalFieldDefinition"
required:
- id
- members
- name
- description: Information about an employee's team
IndexTeamRequest:
type: object
+ description: Info about a team and optional version for that info
properties:
team:
- $ref: '#/components/schemas/TeamInfoDefinition'
description: Info about the team
+ $ref: "#/components/schemas/TeamInfoDefinition"
version:
+ description: Version number for the team object. If absent or 0 then no version checks are done
type: integer
format: int64
- description: Version number for the team object. If absent or 0 then no version checks are done
required:
- team
- description: Info about a team and optional version for that info
BulkIndexShortcutsRequest:
type: object
+ description: Describes the request body of the /bulkindexshortcuts API call
allOf:
- - $ref: '#/components/schemas/BulkIndexRequest'
+ - $ref: "#/components/schemas/BulkIndexRequest"
- type: object
properties:
shortcuts:
+ description: Batch of shortcuts information
type: array
items:
- $ref: '#/components/schemas/ExternalShortcut'
- description: Batch of shortcuts information
+ $ref: "#/components/schemas/ExternalShortcut"
required:
- shortcuts
- description: Describes the request body of the /bulkindexshortcuts API call
UploadShortcutsRequest:
type: object
+ description: Describes the request body of the /uploadshortcuts API call
allOf:
- - $ref: '#/components/schemas/BulkIndexRequest'
+ - $ref: "#/components/schemas/BulkIndexRequest"
- type: object
properties:
shortcuts:
+ description: Batch of shortcuts information
type: array
items:
- $ref: '#/components/schemas/IndexingShortcut'
- description: Batch of shortcuts information
+ $ref: "#/components/schemas/IndexingShortcut"
required:
- shortcuts
- description: Describes the request body of the /uploadshortcuts API call
DebugDatasourceStatusResponse:
type: object
+ description: Describes the response body of the /debug/{datasource}/status API call
properties:
documents:
type: object
properties:
bulkUploadHistory:
- $ref: '#/components/schemas/BulkUploadHistoryEventList'
type: object
+ $ref: "#/components/schemas/BulkUploadHistoryEventList"
counts:
type: object
properties:
uploaded:
type: array
items:
- $ref: '#/components/schemas/DatasourceObjectTypeDocumentCountEntry'
+ $ref: "#/components/schemas/DatasourceObjectTypeDocumentCountEntry"
description: |
A list of object types and corresponding upload counts. Note: This data may be cached and could be up to 3 hours stale.
indexed:
type: array
- items:
- $ref: '#/components/schemas/DatasourceObjectTypeDocumentCountEntry'
description: The number of documents indexed, grouped by objectType
+ items:
+ $ref: "#/components/schemas/DatasourceObjectTypeDocumentCountEntry"
processingHistory:
- $ref: '#/components/schemas/ProcessingHistoryEventList'
+ $ref: "#/components/schemas/ProcessingHistoryEventList"
identity:
type: object
properties:
processingHistory:
- $ref: '#/components/schemas/ProcessingHistoryEventList'
+ $ref: "#/components/schemas/ProcessingHistoryEventList"
users:
- $ref: '#/components/schemas/DebugDatasourceStatusIdentityResponseComponent'
+ $ref: "#/components/schemas/DebugDatasourceStatusIdentityResponseComponent"
groups:
- $ref: '#/components/schemas/DebugDatasourceStatusIdentityResponseComponent'
+ $ref: "#/components/schemas/DebugDatasourceStatusIdentityResponseComponent"
memberships:
- $ref: '#/components/schemas/DebugDatasourceStatusIdentityResponseComponent'
+ $ref: "#/components/schemas/DebugDatasourceStatusIdentityResponseComponent"
datasourceVisibility:
type: string
+ description: The visibility of the datasource, an enum of VISIBLE_TO_ALL, VISIBLE_TO_TEST_GROUP, NOT_VISIBLE
enum:
- ENABLED_FOR_ALL
- ENABLED_FOR_TEST_GROUP
- NOT_ENABLED
- description: The visibility of the datasource, an enum of VISIBLE_TO_ALL, VISIBLE_TO_TEST_GROUP, NOT_VISIBLE
example: ENABLED_FOR_ALL
- description: Describes the response body of the /debug/{datasource}/status API call
DebugDatasourceStatusIdentityResponseComponent:
type: object
properties:
bulkUploadHistory:
- $ref: '#/components/schemas/BulkUploadHistoryEventList'
type: object
+ $ref: "#/components/schemas/BulkUploadHistoryEventList"
counts:
type: object
properties:
@@ -11881,6 +11909,7 @@ components:
example: 15
BulkUploadHistoryEvent:
type: object
+ description: Information about a successful bulk upload
properties:
uploadId:
type: string
@@ -11896,13 +11925,14 @@ components:
example: "2021-08-06T18:58:01.000Z"
status:
type: string
+ description: The status of the upload, an enum of ACTIVE, SUCCESSFUL
enum:
- ACTIVE
- SUCCESSFUL
- description: The status of the upload, an enum of ACTIVE, SUCCESSFUL
example: SUCCESSFUL
processingState:
type: string
+ description: The current state of the upload, an enum of UNAVAILABLE, UPLOAD STARTED, UPLOAD IN PROGRESS, UPLOAD COMPLETED, DELETION PAUSED, INDEXING COMPLETED
enum:
- UNAVAILABLE
- UPLOAD STARTED
@@ -11910,16 +11940,15 @@ components:
- UPLOAD COMPLETED
- DELETION PAUSED
- INDEXING COMPLETED
- description: The current state of the upload, an enum of UNAVAILABLE, UPLOAD STARTED, UPLOAD IN PROGRESS, UPLOAD COMPLETED, DELETION PAUSED, INDEXING COMPLETED
example: UPLOAD COMPLETED
- description: Information about a successful bulk upload
BulkUploadHistoryEventList:
+ description: Information about active and recent successful uploads for the datasource
type: array
items:
- $ref: '#/components/schemas/BulkUploadHistoryEvent'
- description: Information about active and recent successful uploads for the datasource
+ $ref: "#/components/schemas/BulkUploadHistoryEvent"
DebugDocumentRequest:
type: object
+ description: Describes the request body of the /debug/{datasource}/document API call.
properties:
objectType:
type: string
@@ -11932,30 +11961,30 @@ components:
required:
- objectType
- docId
- description: Describes the request body of the /debug/{datasource}/document API call.
DebugDocumentResponse:
type: object
+ description: Describes the response body of the /debug/{datasource}/document API call
properties:
status:
- $ref: '#/components/schemas/DocumentStatusResponse'
type: object
description: Upload and indexing status of the document
+ $ref: "#/components/schemas/DocumentStatusResponse"
uploadedPermissions:
- $ref: '#/components/schemas/DocumentPermissionsDefinition'
- description: Describes the response body of the /debug/{datasource}/document API call
+ $ref: "#/components/schemas/DocumentPermissionsDefinition"
DebugDocumentsRequest:
type: object
+ description: Describes the request body of the /debug/{datasource}/documents API call.
properties:
debugDocuments:
type: array
- items:
- $ref: '#/components/schemas/DebugDocumentRequest'
description: Documents to fetch debug information for
+ items:
+ $ref: "#/components/schemas/DebugDocumentRequest"
required:
- debugDocuments
- description: Describes the request body of the /debug/{datasource}/documents API call.
DebugDocumentsResponseItem:
type: object
+ description: Describes the response body of a single document in the /debug/{datasource}/documents API call
properties:
docId:
type: string
@@ -11964,21 +11993,21 @@ components:
type: string
description: objectType of the document
debugInfo:
- $ref: '#/components/schemas/DebugDocumentResponse'
type: object
description: Debug information of the document
- description: Describes the response body of a single document in the /debug/{datasource}/documents API call
+ $ref: "#/components/schemas/DebugDocumentResponse"
DebugDocumentsResponse:
type: object
+ description: Describes the response body of a single document in the /debug/{datasource}/documents API call
properties:
documentStatuses:
type: array
- items:
- $ref: '#/components/schemas/DebugDocumentsResponseItem'
description: List of document ids/urls and their debug information
- description: Describes the response body of a single document in the /debug/{datasource}/documents API call
+ items:
+ $ref: "#/components/schemas/DebugDocumentsResponseItem"
DocumentStatusResponse:
type: object
+ description: Describes the document status response body
properties:
uploadStatus:
type: string
@@ -12000,18 +12029,17 @@ components:
type: string
description: Permission identity status, enum of NOT_UPLOADED, UPLOADED, STATUS_UNKNOWN (Always unknown if `identityDatasourceName` is set). Document visibility may be affected status is `NOT_UPLOADED`.
example: UPLOADED
- description: Describes the document status response body
LifeCycleEvent:
type: object
properties:
event:
type: string
+ description: Type of event
enum:
- UPLOADED
- INDEXED
- DELETION_REQUESTED
- DELETED
- description: Type of event
example: INDEXED
timestamp:
type: string
@@ -12019,6 +12047,7 @@ components:
example: "2021-08-06T17:58:01.000Z"
ProcessingHistoryEvent:
type: object
+ description: Processing history event for a datasource
properties:
startTime:
type: string
@@ -12028,14 +12057,14 @@ components:
type: string
description: The end time of the processing in ISO 8601 format, 'NA' if still in progress
example: "2021-08-06T18:58:01.000Z"
- description: Processing history event for a datasource
ProcessingHistoryEventList:
+ description: Information about processing history for the datasource
type: array
items:
- $ref: '#/components/schemas/ProcessingHistoryEvent'
- description: Information about processing history for the datasource
+ $ref: "#/components/schemas/ProcessingHistoryEvent"
DebugUserRequest:
type: object
+ description: Describes the request body of the /debug/{datasource}/user API call
properties:
email:
type: string
@@ -12043,44 +12072,44 @@ components:
example: u1@foo.com
required:
- email
- description: Describes the request body of the /debug/{datasource}/user API call
DebugUserResponse:
type: object
+ description: Describes the response body of the /debug/{datasource}/user API call
properties:
status:
- $ref: '#/components/schemas/UserStatusResponse'
type: object
description: Upload and indexing status of the user
+ $ref: "#/components/schemas/UserStatusResponse"
uploadedGroups:
type: array
- items:
- $ref: '#/components/schemas/DatasourceGroupDefinition'
description: List of groups the user is a member of, as uploaded via permissions API.
- description: Describes the response body of the /debug/{datasource}/user API call
+ items:
+ $ref: "#/components/schemas/DatasourceGroupDefinition"
UserStatusResponse:
type: object
+ description: Describes the user status response body
properties:
isActiveUser:
type: boolean
description: Whether the user is active or not
example: true
uploadStatus:
- $ref: '#/components/schemas/UploadStatusEnum'
+ $ref: "#/components/schemas/UploadStatusEnum"
lastUploadedAt:
type: string
description: Time of last successful upload for the user, in ISO 8601 format
example: "2021-08-06T17:58:01.000Z"
- description: Describes the user status response body
UploadStatusEnum:
type: string
+ description: Upload status, enum of NOT_UPLOADED, UPLOADED, STATUS_UNKNOWN
enum:
- UPLOADED
- NOT_UPLOADED
- STATUS_UNKNOWN
- description: Upload status, enum of NOT_UPLOADED, UPLOADED, STATUS_UNKNOWN
example: UPLOADED
DebugDocumentLifecycleRequest:
type: object
+ description: Describes the request body of the /debug/{datasource}/document/events API call.
properties:
objectType:
type: string
@@ -12101,26 +12130,26 @@ components:
required:
- objectType
- docId
- description: Describes the request body of the /debug/{datasource}/document/events API call.
DebugDocumentLifecycleResponse:
type: object
+ description: Describes the response body of the /debug/{datasource}/document/events API call
properties:
lifeCycleEvents:
type: array
- items:
- $ref: '#/components/schemas/LifeCycleEvent'
description: List of lifecycle events corresponding to the document
- description: Describes the response body of the /debug/{datasource}/document/events API call
+ items:
+ $ref: "#/components/schemas/LifeCycleEvent"
SuccessResponse:
type: object
+ description: Success response for custom metadata operations
properties:
success:
type: boolean
description: Indicates if the operation was successful
default: true
- description: Success response for custom metadata operations
ErrorInfoResponse:
type: object
+ description: Error response for custom metadata operations
properties:
error:
type: string
@@ -12130,7 +12159,6 @@ components:
description: Additional details about the error
required:
- error
- description: Error response for custom metadata operations
PropertyDefinition:
properties:
name:
@@ -12172,6 +12200,7 @@ components:
type: string
description: The unique identifier of the `PropertyGroup` to which this property belongs.
PropertyGroup:
+ description: A grouping for multiple PropertyDefinition. Grouped properties will be displayed together in the UI.
properties:
name:
type: string
@@ -12179,8 +12208,8 @@ components:
displayLabel:
type: string
description: The user-friendly group label to display.
- description: A grouping for multiple PropertyDefinition. Grouped properties will be displayed together in the UI.
ObjectDefinition:
+ description: The definition for an `DocumentMetadata.objectType` within a datasource.
properties:
name:
type: string
@@ -12213,17 +12242,17 @@ components:
propertyDefinitions:
type: array
items:
- $ref: '#/components/schemas/PropertyDefinition'
+ $ref: "#/components/schemas/PropertyDefinition"
propertyGroups:
type: array
- items:
- $ref: '#/components/schemas/PropertyGroup'
description: A list of `PropertyGroup`s belonging to this object type, which will group properties to be displayed together in the UI.
+ items:
+ $ref: "#/components/schemas/PropertyGroup"
summarizable:
- type: boolean
description: Whether or not the object is summarizable
- description: The definition for an `DocumentMetadata.objectType` within a datasource.
+ type: boolean
CanonicalizingRegexType:
+ description: Regular expression to apply to an arbitrary string to transform it into a canonical string.
properties:
matchRegex:
type: string
@@ -12231,9 +12260,11 @@ components:
rewriteRegex:
type: string
description: Regular expression to transform into a canonical string.
- description: Regular expression to apply to an arbitrary string to transform it into a canonical string.
SharedDatasourceConfigNoInstance:
type: object
+ description: Structure describing shared config properties of a datasource with no multi-instance support.
+ required:
+ - name
properties:
name:
type: string
@@ -12262,20 +12293,20 @@ components:
- ENTITY
- CALENDAR
- AGENTS
- description: The type of this datasource. It is an important signal for relevance and must be specified and cannot be UNCATEGORIZED. Please refer to [this](https://developers.glean.com/docs/indexing_api_datasource_category/) for more details.
default: UNCATEGORIZED
+ description: The type of this datasource. It is an important signal for relevance and must be specified and cannot be UNCATEGORIZED. Please refer to [this](https://developers.glean.com/docs/indexing_api_datasource_category/) for more details.
urlRegex:
type: string
- description: 'Regular expression that matches URLs of documents of the datasource instance. The behavior for multiple matches is non-deterministic. **Note: `urlRegex` is a required field for non-entity datasources, but not required if the datasource is used to push custom entities (ie. datasources where isEntityDatasource is false). Please add a regex as specific as possible to this datasource instance.**'
+ description: "Regular expression that matches URLs of documents of the datasource instance. The behavior for multiple matches is non-deterministic. **Note: `urlRegex` is a required field for non-entity datasources, but not required if the datasource is used to push custom entities (ie. datasources where isEntityDatasource is false). Please add a regex as specific as possible to this datasource instance.**"
example: https://example-company.datasource.com/.*
iconUrl:
type: string
description: The URL to an image to be displayed as an icon for this datasource instance. Must have a transparency mask. SVG are recommended over PNG. Public, scio-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs).
objectDefinitions:
type: array
- items:
- $ref: '#/components/schemas/ObjectDefinition'
description: The list of top-level `objectType`s for the datasource.
+ items:
+ $ref: "#/components/schemas/ObjectDefinition"
suggestionText:
type: string
description: Example text for what to search for in this datasource
@@ -12284,14 +12315,15 @@ components:
description: The URL of the landing page for this datasource instance. Should point to the most useful page for users, not the company marketing page.
crawlerSeedUrls:
type: array
+ description: This only applies to WEB_CRAWL and BROWSER_CRAWL datasources. Defines the seed URLs for crawling.
items:
type: string
- description: This only applies to WEB_CRAWL and BROWSER_CRAWL datasources. Defines the seed URLs for crawling.
iconDarkUrl:
type: string
description: The URL to an image to be displayed as an icon for this datasource instance in dark mode. Must have a transparency mask. SVG are recommended over PNG. Public, scio-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs).
hideBuiltInFacets:
type: array
+ description: List of built-in facet types that should be hidden for the datasource.
items:
type: string
enum:
@@ -12299,58 +12331,54 @@ components:
- TAG
- AUTHOR
- OWNER
- description: List of built-in facet types that should be hidden for the datasource.
canonicalizingURLRegex:
type: array
- items:
- $ref: '#/components/schemas/CanonicalizingRegexType'
description: A list of regular expressions to apply to an arbitrary URL to transform it into a canonical URL for this datasource instance. Regexes are to be applied in the order specified in this list.
+ items:
+ $ref: "#/components/schemas/CanonicalizingRegexType"
canonicalizingTitleRegex:
type: array
- items:
- $ref: '#/components/schemas/CanonicalizingRegexType'
description: A list of regular expressions to apply to an arbitrary title to transform it into a title that will be displayed in the search results
+ items:
+ $ref: "#/components/schemas/CanonicalizingRegexType"
redlistTitleRegex:
type: string
description: A regex that identifies titles that should not be indexed
connectorType:
- type: string
allOf:
- - $ref: '#/components/schemas/ConnectorType'
- deprecated: false
+ - $ref: "#/components/schemas/ConnectorType"
+ type: string
quicklinks:
type: array
- items:
- $ref: '#/components/schemas/Quicklink'
description: List of actions for this datasource instance that will show up in autocomplete and app card, e.g. "Create new issue" for jira
+ items:
+ $ref: "#/components/schemas/Quicklink"
renderConfigPreset:
type: string
description: The name of a render config to use for displaying results from this datasource. Any well known datasource name may be used to render the same as that source, e.g. `web` or `gdrive`. Please refer to [this](https://developers.glean.com/docs/rendering_search_results/) for more details
aliases:
type: array
+ description: Aliases that can be used as `app` operator-values.
items:
type: string
- description: Aliases that can be used as `app` operator-values.
isOnPrem:
type: boolean
description: Whether or not this datasource is hosted on-premise.
trustUrlRegexForViewActivity:
type: boolean
- description: True if browser activity is able to report the correct URL for VIEW events. Set this to true if the URLs reported by Chrome are constant throughout each page load. Set this to false if the page has Javascript that modifies the URL during or after the load.
default: true
+ description: True if browser activity is able to report the correct URL for VIEW events. Set this to true if the URLs reported by Chrome are constant throughout each page load. Set this to false if the page has Javascript that modifies the URL during or after the load.
includeUtmSource:
type: boolean
description: If true, a utm_source query param will be added to outbound links to this datasource within Glean.
stripFragmentInCanonicalUrl:
type: boolean
- description: If true, the fragment part of the URL will be stripped when converting to a canonical url.
default: true
- required:
- - name
- description: Structure describing shared config properties of a datasource with no multi-instance support.
+ description: If true, the fragment part of the URL will be stripped when converting to a canonical url.
CustomDatasourceConfig:
+ description: Structure describing config properties of a custom datasource
allOf:
- - $ref: '#/components/schemas/SharedDatasourceConfigNoInstance'
+ - $ref: "#/components/schemas/SharedDatasourceConfigNoInstance"
- type: object
properties:
identityDatasourceName:
@@ -12364,13 +12392,12 @@ components:
description: whether email is used to reference users in document ACLs and in group memberships.
isEntityDatasource:
type: boolean
- description: True if this datasource is used to push custom entities.
default: false
+ description: True if this datasource is used to push custom entities.
isTestDatasource:
type: boolean
- description: True if this datasource will be used for testing purpose only. Documents from such a datasource wouldn't have any effect on search rankings.
default: false
- description: Structure describing config properties of a custom datasource
+ description: True if this datasource will be used for testing purpose only. Documents from such a datasource wouldn't have any effect on search rankings.
ShortcutProperties:
properties:
inputAlias:
@@ -12399,7 +12426,7 @@ components:
description: The time the shortcut was updated in epoch seconds.
ExternalShortcut:
allOf:
- - $ref: '#/components/schemas/ShortcutProperties'
+ - $ref: "#/components/schemas/ShortcutProperties"
- type: object
required:
- destinationUrl
@@ -12423,8 +12450,9 @@ components:
format: url
description: The URL using which the user can access the edit page of the shortcut.
SharedDatasourceConfig:
+ description: Structure describing shared config properties of the datasource (including multi-instance support)
allOf:
- - $ref: '#/components/schemas/SharedDatasourceConfigNoInstance'
+ - $ref: "#/components/schemas/SharedDatasourceConfigNoInstance"
- type: object
properties:
datasourceName:
@@ -12436,10 +12464,9 @@ components:
instanceDescription:
type: string
description: A human readable string identifying this instance as compared to its peers, e.g. "github.com/askscio" or "github.askscio.com"
- description: Structure describing shared config properties of the datasource (including multi-instance support)
IndexingShortcut:
allOf:
- - $ref: '#/components/schemas/ShortcutProperties'
+ - $ref: "#/components/schemas/ShortcutProperties"
- type: object
required:
- destinationUrl
@@ -12455,6 +12482,7 @@ components:
SensitiveInfoType:
properties:
likelihoodThreshold:
+ deprecated: true
type: string
enum:
- LIKELY
@@ -12462,141 +12490,140 @@ components:
- POSSIBLE
- UNLIKELY
- VERY_UNLIKELY
- deprecated: true
- x-speakeasy-deprecation-message: Deprecated on undefined, removal scheduled for undefined
x-glean-deprecated:
- id: d45039ec-d6f6-47ba-93b7-ab2307b07f84
introduced: "2026-02-05"
kind: property
message: Field is deprecated
removal: "2026-10-15"
+ x-speakeasy-deprecation-message: "Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Field is deprecated"
infoType:
- type: string
description: Text representation of an info-type to scan for.
+ type: string
TimeRange:
properties:
startTime:
type: string
- format: date-time
description: start time of the time range, applicable for the CUSTOM type.
+ format: date-time
endTime:
type: string
- format: date-time
description: end time of the time range, applicable for the CUSTOM type.
+ format: date-time
lastNDaysValue:
type: integer
- format: int64
description: The number of days to look back from the current time, applicable for the LAST_N_DAYS type.
+ format: int64
InputOptions:
+ description: Controls which data-sources and what time-range to include in scans.
properties:
urlGreenlist:
+ deprecated: true
type: array
+ description: list of url regex matching documents excluded from report
items:
type: string
- description: list of url regex matching documents excluded from report
- deprecated: true
- x-speakeasy-deprecation-message: "Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Field is deprecated"
x-glean-deprecated:
id: e022aaa5-56e6-4b57-bca3-b11943da76a0
introduced: "2026-02-05"
message: Field is deprecated
removal: "2026-10-15"
+ x-speakeasy-deprecation-message: "Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Field is deprecated"
datasourcesType:
type: string
+ description: The types of datasource for which to run the report/policy.
enum:
- ALL
- CUSTOM
- description: The types of datasource for which to run the report/policy.
datasources:
+ deprecated: true
type: array
+ description: List of datasources to consider for report. DEPRECATED - use datasourceInstances instead.
items:
type: string
- description: List of datasources to consider for report. DEPRECATED - use datasourceInstances instead.
- deprecated: true
- x-speakeasy-deprecation-message: "Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Use datasourceInstances instead"
x-glean-deprecated:
id: 97e35970-e0ed-4248-be13-2af8c22e7894
introduced: "2026-02-05"
message: Use datasourceInstances instead
removal: "2026-10-15"
+ x-speakeasy-deprecation-message: "Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Use datasourceInstances instead"
datasourceInstances:
type: array
+ description: List of datasource instances to consider for report/policy.
items:
type: string
- description: List of datasource instances to consider for report/policy.
timePeriodType:
type: string
+ description: Type of time period for which to run the report/policy. PAST_DAY is deprecated.
enum:
- ALL_TIME
- PAST_YEAR
- PAST_DAY
- CUSTOM
- LAST_N_DAYS
- description: Type of time period for which to run the report/policy. PAST_DAY is deprecated.
customTimeRange:
- $ref: '#/components/schemas/TimeRange'
+ $ref: "#/components/schemas/TimeRange"
subsetDocIdsToScan:
type: array
+ description: Subset of document IDs to scan. If empty, all documents matching other scope criteria will be scanned.
items:
type: string
- description: Subset of document IDs to scan. If empty, all documents matching other scope criteria will be scanned.
- description: Controls which data-sources and what time-range to include in scans.
SharingOptions:
+ description: Controls how "shared" a document must be to get picked for scans.
properties:
enabled:
- type: boolean
deprecated: true
- x-speakeasy-deprecation-message: "Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Field is deprecated"
+ type: boolean
x-glean-deprecated:
id: e9260be6-209b-4ce2-a4b3-f7f22879dd86
introduced: "2026-02-05"
message: Field is deprecated
removal: "2026-10-15"
+ x-speakeasy-deprecation-message: "Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Field is deprecated"
threshold:
- type: integer
description: The minimum number of users the document is shared with.
+ type: integer
thresholdEnabled:
- type: boolean
description: Documents will be filtered based on how many people have access to it.
- anyoneWithLinkEnabled:
type: boolean
+ anyoneWithLinkEnabled:
deprecated: true
- x-speakeasy-deprecation-message: "Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Field is deprecated"
+ type: boolean
x-glean-deprecated:
id: 30646ced-e0db-43ef-8412-64a67c5d0f53
introduced: "2026-02-05"
message: Field is deprecated
removal: "2026-10-15"
+ x-speakeasy-deprecation-message: "Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Field is deprecated"
anyoneInternalEnabled:
- type: boolean
description: Only users within the organization can access the document.
- anonymousAccessEnabled:
type: boolean
+ anonymousAccessEnabled:
description: Anyone on the internet can access the document.
- userAccessEnabled:
type: boolean
+ userAccessEnabled:
description: Enable user access check
+ type: boolean
userIds:
type: array
+ description: Any one of the specified users can access the document.
items:
type: string
- description: Any one of the specified users can access the document.
- description: Controls how "shared" a document must be to get picked for scans.
ExternalSharingOptions:
- allOf:
- - description: DEPRECATED - use `broadSharingOptions` instead.
- - $ref: '#/components/schemas/SharingOptions'
- - type: object
- properties:
- domainAccessEnabled:
- type: boolean
deprecated: true
- x-speakeasy-deprecation-message: "Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Use broadSharingOptions instead"
x-glean-deprecated:
id: 7c9e4a1d-3f8b-4e2c-9a5d-6b0f1c8e2d4a
introduced: "2026-02-05"
message: Use broadSharingOptions instead
removal: "2026-10-15"
+ x-speakeasy-deprecation-message: "Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Use broadSharingOptions instead"
+ allOf:
+ - description: DEPRECATED - use `broadSharingOptions` instead.
+ - $ref: "#/components/schemas/SharingOptions"
+ - type: object
+ properties:
+ domainAccessEnabled:
+ type: boolean
HotwordProximity:
properties:
windowBefore:
@@ -12608,35 +12635,36 @@ components:
regex:
type: string
proximity:
- $ref: '#/components/schemas/HotwordProximity'
+ $ref: "#/components/schemas/HotwordProximity"
SensitiveExpression:
properties:
expression:
- type: string
description: Sensitive word, phrase, or regular expression.
+ type: string
hotwords:
+ description: Zero to three proximate regular expressions necessary to consider an expression as sensitive content.
type: array
items:
- $ref: '#/components/schemas/Hotword'
- description: Zero to three proximate regular expressions necessary to consider an expression as sensitive content.
+ $ref: "#/components/schemas/Hotword"
CustomSensitiveRuleType:
type: string
+ description: Type of the custom sensitive rule.
enum:
- REGEX
- TERM
- INFO_TYPE
- description: Type of the custom sensitive rule.
CustomSensitiveRule:
properties:
id:
- type: string
description: Identifier for the custom sensitive expression.
+ type: string
value:
type: string
description: The value of the custom sensitive rule. For REGEX type, this is the regex pattern; for TERM type, it is the term to match; and for INFO_TYPE type, it refers to predefined categories of sensitive content. See https://cloud.google.com/dlp/docs/infotypes-reference for available options.
type:
- $ref: '#/components/schemas/CustomSensitiveRuleType'
+ $ref: "#/components/schemas/CustomSensitiveRuleType"
likelihoodThreshold:
+ description: Likelihood threshold for BUILT_IN infotypes (e.g., LIKELY, VERY_LIKELY). Only applicable for BUILT_IN type.
type: string
enum:
- LIKELY
@@ -12644,62 +12672,61 @@ components:
- POSSIBLE
- UNLIKELY
- VERY_UNLIKELY
- description: Likelihood threshold for BUILT_IN infotypes (e.g., LIKELY, VERY_LIKELY). Only applicable for BUILT_IN type.
CustomSensitiveExpression:
properties:
id:
- type: string
description: Identifier for the custom sensitive expression.
+ type: string
keyword:
- $ref: '#/components/schemas/CustomSensitiveRule'
description: The keyword to match against.
+ $ref: "#/components/schemas/CustomSensitiveRule"
evaluationExpression:
- type: string
description: The expression to evaluate the keyword match.
+ type: string
SensitiveContentOptions:
+ description: Options for defining sensitive content within scanned documents.
properties:
sensitiveInfoTypes:
+ deprecated: true
+ description: DEPRECATED - use 'customSensitiveExpressions' instead.
type: array
items:
- $ref: '#/components/schemas/SensitiveInfoType'
- description: DEPRECATED - use 'customSensitiveExpressions' instead.
- deprecated: true
- x-speakeasy-deprecation-message: "Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Use customSensitiveExpressions instead"
+ $ref: "#/components/schemas/SensitiveInfoType"
x-glean-deprecated:
id: 3497cb1c-f7aa-42d8-81b8-309c3adeed84
introduced: "2026-02-05"
message: Use customSensitiveExpressions instead
removal: "2026-10-15"
+ x-speakeasy-deprecation-message: "Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Use customSensitiveExpressions instead"
sensitiveTerms:
+ deprecated: true
+ description: DEPRECATED - use 'customSensitiveExpressions' instead.
type: array
items:
- $ref: '#/components/schemas/SensitiveExpression'
- description: DEPRECATED - use 'customSensitiveExpressions' instead.
- deprecated: true
- x-speakeasy-deprecation-message: "Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Use customSensitiveExpressions instead"
+ $ref: "#/components/schemas/SensitiveExpression"
x-glean-deprecated:
id: b0713b37-472e-4c29-80ba-6f5d6f2b449c
introduced: "2026-02-05"
message: Use customSensitiveExpressions instead
removal: "2026-10-15"
+ x-speakeasy-deprecation-message: "Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Use customSensitiveExpressions instead"
sensitiveRegexes:
+ deprecated: true
+ description: DEPRECATED - use 'customSensitiveExpressions' instead.
type: array
items:
- $ref: '#/components/schemas/SensitiveExpression'
- description: DEPRECATED - use 'customSensitiveExpressions' instead.
- deprecated: true
- x-speakeasy-deprecation-message: "Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Use customSensitiveExpressions instead"
+ $ref: "#/components/schemas/SensitiveExpression"
x-glean-deprecated:
id: a26e1920-36b6-4c0f-981f-57b09a9ebce3
introduced: "2026-02-05"
message: Use customSensitiveExpressions instead
removal: "2026-10-15"
+ x-speakeasy-deprecation-message: "Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Use customSensitiveExpressions instead"
customSensitiveExpressions:
+ description: list of custom sensitive expressions to consider as sensitive content
type: array
items:
- $ref: '#/components/schemas/CustomSensitiveExpression'
- description: list of custom sensitive expressions to consider as sensitive content
- description: Options for defining sensitive content within scanned documents.
+ $ref: "#/components/schemas/CustomSensitiveExpression"
DlpPersonMetadata:
properties:
firstName:
@@ -12709,6 +12736,10 @@ components:
type: string
description: The user's primary email address
DlpPerson:
+ description: Details about the person who created this report/policy.
+ required:
+ - name
+ - obfuscatedId
properties:
name:
type: string
@@ -12717,126 +12748,123 @@ components:
type: string
description: An opaque identifier that can be used to request metadata for a Person.
metadata:
- $ref: '#/components/schemas/DlpPersonMetadata'
- required:
- - name
- - obfuscatedId
- description: Details about the person who created this report/policy.
+ $ref: "#/components/schemas/DlpPersonMetadata"
AllowlistOptions:
+ description: Terms that are allow-listed during the scans. If any finding picked up by a rule exactly matches a term in the allow-list, it will not be counted as a violation.
properties:
terms:
type: array
+ description: list of words and phrases to consider as whitelisted content
items:
type: string
- description: list of words and phrases to consider as whitelisted content
- description: Terms that are allow-listed during the scans. If any finding picked up by a rule exactly matches a term in the allow-list, it will not be counted as a violation.
DlpConfig:
+ description: Detailed configuration of what documents and sensitive content will be scanned.
properties:
version:
+ description: Synonymous with report/policy id.
type: integer
format: int64
- description: Synonymous with report/policy id.
sensitiveInfoTypes:
+ deprecated: true
+ description: DEPRECATED - use `sensitiveContentOptions` instead.
type: array
items:
- $ref: '#/components/schemas/SensitiveInfoType'
- description: DEPRECATED - use `sensitiveContentOptions` instead.
- deprecated: true
- x-speakeasy-deprecation-message: "Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Use sensitiveContentOptions instead"
+ $ref: "#/components/schemas/SensitiveInfoType"
x-glean-deprecated:
id: 60d6d182-e9d0-448d-af75-137f68bbdcbf
introduced: "2026-02-05"
message: Use sensitiveContentOptions instead
removal: "2026-10-15"
+ x-speakeasy-deprecation-message: "Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Use sensitiveContentOptions instead"
inputOptions:
- $ref: '#/components/schemas/InputOptions'
description: Options for documents to include or exclude in a report
+ $ref: "#/components/schemas/InputOptions"
externalSharingOptions:
- $ref: '#/components/schemas/ExternalSharingOptions'
- description: DEPRECATED - use `broadSharingOptions` instead.
deprecated: true
- x-speakeasy-deprecation-message: "Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Use broadSharingOptions instead"
+ description: DEPRECATED - use `broadSharingOptions` instead.
+ $ref: "#/components/schemas/ExternalSharingOptions"
x-glean-deprecated:
id: 6484ec17-a133-4176-b2ce-28e25b0e9065
introduced: "2026-02-05"
message: Use broadSharingOptions instead
removal: "2026-10-15"
+ x-speakeasy-deprecation-message: "Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Use broadSharingOptions instead"
broadSharingOptions:
- $ref: '#/components/schemas/SharingOptions'
description: Options for defining documents to scan for sensitive content.
+ $ref: "#/components/schemas/SharingOptions"
sensitiveContentOptions:
- $ref: '#/components/schemas/SensitiveContentOptions'
description: Options for defining sensitive content within scanned documents.
+ $ref: "#/components/schemas/SensitiveContentOptions"
reportName:
type: string
frequency:
- type: string
description: Interval between scans.
+ type: string
createdBy:
- $ref: '#/components/schemas/DlpPerson'
description: Person who created this report/policy.
+ $ref: "#/components/schemas/DlpPerson"
createdAt:
+ description: Timestamp at which this configuration was created.
type: string
format: iso-date-time
- description: Timestamp at which this configuration was created.
redactQuote:
- type: boolean
description: redact quote in findings of the report
- autoHideDocs:
type: boolean
+ autoHideDocs:
description: auto hide documents with findings in the report
+ type: boolean
allowlistOptions:
- $ref: '#/components/schemas/AllowlistOptions'
description: Options for defining whitelisting content within scanned documents
- description: Detailed configuration of what documents and sensitive content will be scanned.
+ $ref: "#/components/schemas/AllowlistOptions"
DlpFrequency:
type: string
+ description: Interval between scans. DAILY is deprecated.
+ x-include-enum-class-prefix: true
enum:
- ONCE
- DAILY
- WEEKLY
- CONTINUOUS
- NONE
- description: Interval between scans. DAILY is deprecated.
- x-include-enum-class-prefix: true
DlpReportStatus:
type: string
+ description: The status of the policy/report. Only ACTIVE status will be picked for scans.
+ x-include-enum-class-prefix: true
enum:
- ACTIVE
- INACTIVE
- CANCELLED
- NONE
- description: The status of the policy/report. Only ACTIVE status will be picked for scans.
- x-include-enum-class-prefix: true
DlpReport:
+ description: Full policy information that will be used for scans.
properties:
id:
type: string
name:
type: string
config:
- $ref: '#/components/schemas/DlpConfig'
description: All details of the policy that is needed for a scan.
+ $ref: "#/components/schemas/DlpConfig"
frequency:
- $ref: '#/components/schemas/DlpFrequency'
description: The interval between scans.
+ $ref: "#/components/schemas/DlpFrequency"
status:
- $ref: '#/components/schemas/DlpReportStatus'
description: The status of the policy.
+ $ref: "#/components/schemas/DlpReportStatus"
createdBy:
- $ref: '#/components/schemas/DlpPerson'
description: Person who created this report.
+ $ref: "#/components/schemas/DlpPerson"
createdAt:
+ description: Timestamp at which the policy was created.
type: string
format: iso-date-time
- description: Timestamp at which the policy was created.
lastUpdatedAt:
+ description: Timestamp at which the policy was last updated.
type: string
format: iso-date-time
- description: Timestamp at which the policy was last updated.
autoHideDocs:
- type: boolean
description: Auto hide documents with findings in the policy.
+ type: boolean
lastScanStatus:
type: string
enum:
@@ -12847,34 +12875,33 @@ components:
- CANCELLING
- ACTIVE
lastScanStartTime:
+ description: The timestamp at which the report's last run/scan began.
type: string
format: iso-date-time
- description: The timestamp at which the report's last run/scan began.
updatedBy:
- $ref: '#/components/schemas/DlpPerson'
description: Person who last updated this report.
- description: Full policy information that will be used for scans.
+ $ref: "#/components/schemas/DlpPerson"
GetDlpReportResponse:
properties:
report:
- $ref: '#/components/schemas/DlpReport'
+ $ref: "#/components/schemas/DlpReport"
UpdateDlpReportRequest:
properties:
config:
- $ref: '#/components/schemas/DlpConfig'
description: The new configuration the policy will follow if provided.
+ $ref: "#/components/schemas/DlpConfig"
frequency:
- $ref: '#/components/schemas/DlpFrequency'
description: The new frequency the policy will follow if provided.
+ $ref: "#/components/schemas/DlpFrequency"
status:
- $ref: '#/components/schemas/DlpReportStatus'
description: The new status the policy will be updated to if provided.
+ $ref: "#/components/schemas/DlpReportStatus"
autoHideDocs:
- type: boolean
description: The new autoHideDoc boolean the policy will be updated to if provided.
+ type: boolean
reportName:
- type: string
description: The new name of the policy if provided.
+ type: string
DlpSimpleResult:
type: string
enum:
@@ -12883,45 +12910,45 @@ components:
UpdateDlpReportResponse:
properties:
result:
- $ref: '#/components/schemas/DlpSimpleResult'
+ $ref: "#/components/schemas/DlpSimpleResult"
ListDlpReportsResponse:
properties:
reports:
type: array
items:
- $ref: '#/components/schemas/DlpReport'
+ $ref: "#/components/schemas/DlpReport"
CreateDlpReportRequest:
properties:
name:
- type: string
description: Name of the policy being created.
+ type: string
config:
- $ref: '#/components/schemas/DlpConfig'
description: Details on the configuration used in the scans.
+ $ref: "#/components/schemas/DlpConfig"
frequency:
- $ref: '#/components/schemas/DlpFrequency'
description: Interval between scans.
+ $ref: "#/components/schemas/DlpFrequency"
autoHideDocs:
- type: boolean
description: Controls whether the policy should hide documents with violations.
+ type: boolean
CreateDlpReportResponse:
properties:
report:
- $ref: '#/components/schemas/DlpReport'
+ $ref: "#/components/schemas/DlpReport"
UpdateDlpConfigRequest:
properties:
config:
- $ref: '#/components/schemas/DlpConfig'
+ $ref: "#/components/schemas/DlpConfig"
frequency:
- type: string
description: Only "ONCE" is supported for reports.
+ type: string
UpdateDlpConfigResponse:
properties:
result:
- $ref: '#/components/schemas/DlpSimpleResult'
+ $ref: "#/components/schemas/DlpSimpleResult"
reportId:
- type: string
description: The id of the report that was just created and run.
+ type: string
ReportStatusResponse:
properties:
status:
@@ -12934,70 +12961,70 @@ components:
- CANCELLING
- ACTIVE
startTime:
+ description: The timestamp at which the report's run/scan began.
type: string
format: iso-date-time
- description: The timestamp at which the report's run/scan began.
DocumentVisibilityOverride:
properties:
docId:
type: string
override:
+ description: The visibility-override state of the document.
type: string
enum:
- NONE
- HIDE_FROM_ALL
- HIDE_FROM_GROUPS
- HIDE_FROM_ALL_EXCEPT_OWNER
- description: The visibility-override state of the document.
GetDocumentVisibilityOverridesResponse:
properties:
visibilityOverrides:
type: array
items:
- $ref: '#/components/schemas/DocumentVisibilityOverride'
+ $ref: "#/components/schemas/DocumentVisibilityOverride"
UpdateDocumentVisibilityOverridesRequest:
properties:
visibilityOverrides:
type: array
items:
- $ref: '#/components/schemas/DocumentVisibilityOverride'
+ $ref: "#/components/schemas/DocumentVisibilityOverride"
DocumentVisibilityUpdateResult:
allOf:
- - $ref: '#/components/schemas/DocumentVisibilityOverride'
+ - $ref: "#/components/schemas/DocumentVisibilityOverride"
- type: object
properties:
success:
- type: boolean
description: Whether this document was successfully set to its desired visibility state.
+ type: boolean
UpdateDocumentVisibilityOverridesResponse:
properties:
results:
+ description: The documents and whether their visibility was successfully updated.
type: array
items:
- $ref: '#/components/schemas/DocumentVisibilityUpdateResult'
- description: The documents and whether their visibility was successfully updated.
+ $ref: "#/components/schemas/DocumentVisibilityUpdateResult"
DlpSeverity:
type: string
+ description: Severity levels for DLP findings and analyses.
+ x-include-enum-class-prefix: true
enum:
- UNSPECIFIED
- LOW
- MEDIUM
- HIGH
- description: Severity levels for DLP findings and analyses.
- x-include-enum-class-prefix: true
TimeRangeFilter:
properties:
timePeriodType:
type: string
+ description: The type of time period for which to filter findings.
enum:
- PAST_DAY
- PAST_WEEK
- PAST_MONTH
- PAST_YEAR
- CUSTOM
- description: The type of time period for which to filter findings.
customTimeRange:
- $ref: '#/components/schemas/TimeRange'
+ $ref: "#/components/schemas/TimeRange"
DlpFindingFilter:
properties:
infoType:
@@ -13015,28 +13042,28 @@ components:
items:
type: string
severity:
- $ref: '#/components/schemas/DlpSeverity'
+ $ref: "#/components/schemas/DlpSeverity"
documentSeverity:
type: array
items:
- $ref: '#/components/schemas/DlpSeverity'
+ $ref: "#/components/schemas/DlpSeverity"
timeRange:
- $ref: '#/components/schemas/TimeRangeFilter'
+ $ref: "#/components/schemas/TimeRangeFilter"
archived:
type: boolean
ExportInfo:
properties:
createdBy:
- $ref: '#/components/schemas/DlpPerson'
description: person who triggered this export
+ $ref: "#/components/schemas/DlpPerson"
startTime:
+ description: Timestamp at which this export started.
type: string
format: iso-date-time
- description: Timestamp at which this export started.
endTime:
+ description: Timestamp at which this export completed.
type: string
format: iso-date-time
- description: Timestamp at which this export completed.
exportId:
type: string
description: The ID of the export
@@ -13044,15 +13071,15 @@ components:
type: string
description: The name of the file to export the findings to
filter:
- $ref: '#/components/schemas/DlpFindingFilter'
+ $ref: "#/components/schemas/DlpFindingFilter"
description: The filters used to export the findings
status:
type: string
+ description: The status of the export
enum:
- PENDING
- COMPLETED
- FAILED
- description: The status of the export
exportSize:
type: integer
format: int64
@@ -13062,27 +13089,27 @@ components:
exports:
type: array
items:
- $ref: '#/components/schemas/ExportInfo'
+ $ref: "#/components/schemas/ExportInfo"
DlpExportFindingsRequest:
properties:
exportType:
type: string
+ description: The type of export to perform
enum:
- FINDINGS
- DOCUMENTS
- description: The type of export to perform
filter:
- $ref: '#/components/schemas/DlpFindingFilter'
+ $ref: "#/components/schemas/DlpFindingFilter"
fileName:
type: string
description: The name of the file to export the findings to
fieldScope:
type: string
+ description: Controls which fields to include in the export
enum:
- ALL
- EXCLUDE_SENSITIVE
- CUSTOM
- description: Controls which fields to include in the export
fieldsToExclude:
type: array
items:
@@ -13151,37 +13178,37 @@ components:
content:
application/json:
schema:
- $ref: '#/components/schemas/SuccessResponse'
+ $ref: "#/components/schemas/SuccessResponse"
BadRequestError:
description: Bad Request
content:
application/json:
schema:
- $ref: '#/components/schemas/ErrorInfoResponse'
+ $ref: "#/components/schemas/ErrorInfoResponse"
UnauthorizedError:
description: Not Authorized
content:
application/json:
schema:
- $ref: '#/components/schemas/ErrorInfoResponse'
+ $ref: "#/components/schemas/ErrorInfoResponse"
NotFoundError:
description: Not Found
content:
application/json:
schema:
- $ref: '#/components/schemas/ErrorInfoResponse'
+ $ref: "#/components/schemas/ErrorInfoResponse"
TooManyRequestsError:
description: Too Many Requests
content:
application/json:
schema:
- $ref: '#/components/schemas/ErrorInfoResponse'
+ $ref: "#/components/schemas/ErrorInfoResponse"
InternalServerError:
description: Internal Server Error
content:
application/json:
schema:
- $ref: '#/components/schemas/ErrorInfoResponse'
+ $ref: "#/components/schemas/ErrorInfoResponse"
x-tagGroups:
- name: Search & Generative AI
tags:
diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
index 7039c9f4..df51514a 100644
--- a/.speakeasy/workflow.lock
+++ b/.speakeasy/workflow.lock
@@ -1,12 +1,12 @@
-speakeasyVersion: 1.709.1
+speakeasyVersion: 1.709.3
sources:
Glean API:
sourceNamespace: glean-api-specs
- sourceRevisionDigest: sha256:011913f7e901f7c623d56dfdf5f95f3b29824936ff03757e1c669dc3015c3b6b
- sourceBlobDigest: sha256:ffbbaad589ea039da483fccec2854d4ca5a969a8b04248aab046e375d38c1b63
+ sourceRevisionDigest: sha256:b38bf1e37aa8bc265550ac0ed69b88b02d98050a576d5bb6a4546b74e5e4210f
+ sourceBlobDigest: sha256:8928c68b5880fc0f36058b4dfbb5e3743558b9592e72fbfeeafc536b70f77a24
tags:
- latest
- - speakeasy-sdk-regen-1770658561
+ - speakeasy-sdk-regen-1770674812
Glean Client API:
sourceNamespace: glean-client-api
sourceRevisionDigest: sha256:4edc63ad559e4f2c9fb9ebf5edaaaaa9269f1874d271cfd84b441d6dacac43d2
@@ -17,10 +17,10 @@ targets:
glean:
source: Glean API
sourceNamespace: glean-api-specs
- sourceRevisionDigest: sha256:011913f7e901f7c623d56dfdf5f95f3b29824936ff03757e1c669dc3015c3b6b
- sourceBlobDigest: sha256:ffbbaad589ea039da483fccec2854d4ca5a969a8b04248aab046e375d38c1b63
+ sourceRevisionDigest: sha256:b38bf1e37aa8bc265550ac0ed69b88b02d98050a576d5bb6a4546b74e5e4210f
+ sourceBlobDigest: sha256:8928c68b5880fc0f36058b4dfbb5e3743558b9592e72fbfeeafc536b70f77a24
codeSamplesNamespace: glean-api-specs-python-code-samples
- codeSamplesRevisionDigest: sha256:b135bc74bb69129c6a91287f3452f058686bb9af39a7a858a00628f0817fe284
+ codeSamplesRevisionDigest: sha256:75e14b884c26471c57c3c0a7682a2758923de3693e55017ee727e9b6bd9802ee
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
diff --git a/RELEASES.md b/RELEASES.md
index c56f2d41..ad35696c 100644
--- a/RELEASES.md
+++ b/RELEASES.md
@@ -548,4 +548,14 @@ Based on:
### Generated
- [python v0.12.4] .
### Releases
-- [PyPI v0.12.4] https://pypi.org/project/glean-api-client/0.12.4 - .
\ No newline at end of file
+- [PyPI v0.12.4] https://pypi.org/project/glean-api-client/0.12.4 - .
+
+## 2026-02-10 17:09:12
+### Changes
+Based on:
+- OpenAPI Doc
+- Speakeasy CLI 1.709.3 (2.814.0) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [python v0.12.5] .
+### Releases
+- [PyPI v0.12.5] https://pypi.org/project/glean-api-client/0.12.5 - .
\ No newline at end of file
diff --git a/docs/models/documentinteractions.md b/docs/models/documentinteractions.md
index 42713431..6c5eb1a1 100644
--- a/docs/models/documentinteractions.md
+++ b/docs/models/documentinteractions.md
@@ -3,11 +3,11 @@
## Fields
-| Field | Type | Required | Description |
-| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `num_comments` | *Optional[int]* | :heavy_minus_sign: | The count of comments (thread replies in the case of slack). |
-| `num_reactions` | *Optional[int]* | :heavy_minus_sign: | The count of reactions on the document. |
-| ~~`reactions`~~ | List[*str*] | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.
To be deprecated in favor of reacts. A (potentially non-exhaustive) list of reactions for the document. |
-| `reacts` | List[[models.Reaction](../models/reaction.md)] | :heavy_minus_sign: | N/A |
-| `shares` | List[[models.Share](../models/share.md)] | :heavy_minus_sign: | Describes instances of someone posting a link to this document in one of our indexed datasources. |
-| `visitor_count` | [Optional[models.CountInfo]](../models/countinfo.md) | :heavy_minus_sign: | N/A |
\ No newline at end of file
+| Field | Type | Required | Description |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `num_comments` | *Optional[int]* | :heavy_minus_sign: | The count of comments (thread replies in the case of slack). |
+| `num_reactions` | *Optional[int]* | :heavy_minus_sign: | The count of reactions on the document. |
+| ~~`reactions`~~ | List[*str*] | :heavy_minus_sign: | : warning: ** DEPRECATED **: Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Use reacts instead.
To be deprecated in favor of reacts. A (potentially non-exhaustive) list of reactions for the document. |
+| `reacts` | List[[models.Reaction](../models/reaction.md)] | :heavy_minus_sign: | N/A |
+| `shares` | List[[models.Share](../models/share.md)] | :heavy_minus_sign: | Describes instances of someone posting a link to this document in one of our indexed datasources. |
+| `visitor_count` | [Optional[models.CountInfo]](../models/countinfo.md) | :heavy_minus_sign: | N/A |
\ No newline at end of file
diff --git a/docs/models/event.md b/docs/models/event.md
index 399107aa..cddb621e 100644
--- a/docs/models/event.md
+++ b/docs/models/event.md
@@ -21,6 +21,7 @@ The action the user took within a Glean client with respect to the object referr
| `LAST_TOKEN` | LAST_TOKEN |
| `MANUAL_FEEDBACK` | MANUAL_FEEDBACK |
| `MANUAL_FEEDBACK_SIDE_BY_SIDE` | MANUAL_FEEDBACK_SIDE_BY_SIDE |
+| `FEEDBACK_TIME_SAVED` | FEEDBACK_TIME_SAVED |
| `MARK_AS_READ` | MARK_AS_READ |
| `MESSAGE` | MESSAGE |
| `MIDDLE_CLICK` | MIDDLE_CLICK |
diff --git a/docs/models/facetfiltervalue.md b/docs/models/facetfiltervalue.md
index 74ab3a85..84c21704 100644
--- a/docs/models/facetfiltervalue.md
+++ b/docs/models/facetfiltervalue.md
@@ -3,8 +3,8 @@
## Fields
-| Field | Type | Required | Description | Example |
-| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `value` | *Optional[str]* | :heavy_minus_sign: | N/A | Spreadsheet |
-| `relation_type` | [Optional[models.RelationType]](../models/relationtype.md) | :heavy_minus_sign: | N/A | EQUALS |
-| ~~`is_negated`~~ | *Optional[bool]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.
DEPRECATED - please use relationType instead | |
\ No newline at end of file
+| Field | Type | Required | Description | Example |
+| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `value` | *Optional[str]* | :heavy_minus_sign: | N/A | Spreadsheet |
+| `relation_type` | [Optional[models.RelationType]](../models/relationtype.md) | :heavy_minus_sign: | N/A | EQUALS |
+| ~~`is_negated`~~ | *Optional[bool]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Use relationType instead.
DEPRECATED - please use relationType instead | |
\ No newline at end of file
diff --git a/docs/models/relateddocuments.md b/docs/models/relateddocuments.md
index 62296266..0002a5a9 100644
--- a/docs/models/relateddocuments.md
+++ b/docs/models/relateddocuments.md
@@ -3,10 +3,10 @@
## Fields
-| Field | Type | Required | Description | Example |
-| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `relation` | [Optional[models.Relation]](../models/relation.md) | :heavy_minus_sign: | How this document relates to the including entity. | |
-| `associated_entity_id` | *Optional[str]* | :heavy_minus_sign: | Which entity in the response that this entity relates to. Relevant when there are multiple entities associated with the response (such as merged customers) | |
-| `query_suggestion` | [Optional[models.QuerySuggestion]](../models/querysuggestion.md) | :heavy_minus_sign: | N/A | {
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
} |
-| ~~`documents`~~ | List[[models.Document](../models/document.md)] | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.
A truncated list of documents with this relation. TO BE DEPRECATED. | |
-| `results` | List[[models.SearchResult](../models/searchresult.md)] | :heavy_minus_sign: | A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. | |
\ No newline at end of file
+| Field | Type | Required | Description | Example |
+| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `relation` | [Optional[models.Relation]](../models/relation.md) | :heavy_minus_sign: | How this document relates to the including entity. | |
+| `associated_entity_id` | *Optional[str]* | :heavy_minus_sign: | Which entity in the response that this entity relates to. Relevant when there are multiple entities associated with the response (such as merged customers) | |
+| `query_suggestion` | [Optional[models.QuerySuggestion]](../models/querysuggestion.md) | :heavy_minus_sign: | N/A | {
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
} |
+| ~~`documents`~~ | List[[models.Document](../models/document.md)] | :heavy_minus_sign: | : warning: ** DEPRECATED **: Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Field is deprecated.
A truncated list of documents with this relation. TO BE DEPRECATED. | |
+| `results` | List[[models.SearchResult](../models/searchresult.md)] | :heavy_minus_sign: | A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. | |
\ No newline at end of file
diff --git a/docs/models/role.md b/docs/models/role.md
index 3a788dbf..8176a687 100644
--- a/docs/models/role.md
+++ b/docs/models/role.md
@@ -2,7 +2,7 @@
DEPRECATED - use permissions instead. Viewer's role on the specific document.
-> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible.
+> :warning: **DEPRECATED**: Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Use permissions instead.
## Values
diff --git a/docs/models/sensitiveinfotype.md b/docs/models/sensitiveinfotype.md
index 1a643b05..cce44d49 100644
--- a/docs/models/sensitiveinfotype.md
+++ b/docs/models/sensitiveinfotype.md
@@ -3,7 +3,7 @@
## Fields
-| Field | Type | Required | Description |
-| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
-| ~~`likelihood_threshold`~~ | [Optional[models.SensitiveInfoTypeLikelihoodThreshold]](../models/sensitiveinfotypelikelihoodthreshold.md) | :heavy_minus_sign: | : warning: ** DEPRECATED **: Deprecated on undefined, removal scheduled for undefined. |
-| `info_type` | *Optional[str]* | :heavy_minus_sign: | Text representation of an info-type to scan for. |
\ No newline at end of file
+| Field | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
+| ~~`likelihood_threshold`~~ | [Optional[models.SensitiveInfoTypeLikelihoodThreshold]](../models/sensitiveinfotypelikelihoodthreshold.md) | :heavy_minus_sign: | : warning: ** DEPRECATED **: Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Field is deprecated. |
+| `info_type` | *Optional[str]* | :heavy_minus_sign: | Text representation of an info-type to scan for. |
\ No newline at end of file
diff --git a/docs/models/sensitiveinfotypelikelihoodthreshold.md b/docs/models/sensitiveinfotypelikelihoodthreshold.md
index df75e2b0..e6435582 100644
--- a/docs/models/sensitiveinfotypelikelihoodthreshold.md
+++ b/docs/models/sensitiveinfotypelikelihoodthreshold.md
@@ -1,6 +1,6 @@
# ~~SensitiveInfoTypeLikelihoodThreshold~~
-> :warning: **DEPRECATED**: Deprecated on undefined, removal scheduled for undefined.
+> :warning: **DEPRECATED**: Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Field is deprecated.
## Values
diff --git a/docs/models/viewerinfo.md b/docs/models/viewerinfo.md
index 17e7a6fa..13f5dde9 100644
--- a/docs/models/viewerinfo.md
+++ b/docs/models/viewerinfo.md
@@ -3,7 +3,7 @@
## Fields
-| Field | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| ~~`role`~~ | [Optional[models.Role]](../models/role.md) | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.
DEPRECATED - use permissions instead. Viewer's role on the specific document. |
-| `last_viewed_time` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A |
\ No newline at end of file
+| Field | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| ~~`role`~~ | [Optional[models.Role]](../models/role.md) | :heavy_minus_sign: | : warning: ** DEPRECATED **: Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Use permissions instead.
DEPRECATED - use permissions instead. Viewer's role on the specific document. |
+| `last_viewed_time` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A |
\ No newline at end of file
diff --git a/pyproject.toml b/pyproject.toml
index 85256d91..9c50e794 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,7 +1,7 @@
[project]
name = "glean-api-client"
-version = "0.12.4"
+version = "0.12.5"
description = "Python Client SDK Generated by Speakeasy."
authors = [{ name = "Glean Technologies, Inc." },]
readme = "README-PYPI.md"
diff --git a/src/glean/api_client/_version.py b/src/glean/api_client/_version.py
index d9149385..93779ca3 100644
--- a/src/glean/api_client/_version.py
+++ b/src/glean/api_client/_version.py
@@ -3,10 +3,10 @@
import importlib.metadata
__title__: str = "glean-api-client"
-__version__: str = "0.12.4"
+__version__: str = "0.12.5"
__openapi_doc_version__: str = "0.9.0"
-__gen_version__: str = "2.812.2"
-__user_agent__: str = "speakeasy-sdk/python 0.12.4 2.812.2 0.9.0 glean-api-client"
+__gen_version__: str = "2.814.0"
+__user_agent__: str = "speakeasy-sdk/python 0.12.5 2.814.0 0.9.0 glean-api-client"
try:
if __package__ is not None:
diff --git a/src/glean/api_client/models/documentinteractions.py b/src/glean/api_client/models/documentinteractions.py
index 159a5dfa..bf70b403 100644
--- a/src/glean/api_client/models/documentinteractions.py
+++ b/src/glean/api_client/models/documentinteractions.py
@@ -36,7 +36,7 @@ class DocumentInteractions(BaseModel):
reactions: Annotated[
Optional[List[str]],
pydantic.Field(
- deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
+ deprecated="warning: ** DEPRECATED ** - Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Use reacts instead."
),
] = None
r"""To be deprecated in favor of reacts. A (potentially non-exhaustive) list of reactions for the document."""
diff --git a/src/glean/api_client/models/facetfiltervalue.py b/src/glean/api_client/models/facetfiltervalue.py
index b1f4c89e..83ed0638 100644
--- a/src/glean/api_client/models/facetfiltervalue.py
+++ b/src/glean/api_client/models/facetfiltervalue.py
@@ -39,7 +39,7 @@ class FacetFilterValue(BaseModel):
is_negated: Annotated[
Optional[bool],
pydantic.Field(
- deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible.",
+ deprecated="warning: ** DEPRECATED ** - Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Use relationType instead.",
alias="isNegated",
),
] = None
diff --git a/src/glean/api_client/models/feedback.py b/src/glean/api_client/models/feedback.py
index faaeefd6..cd39afb8 100644
--- a/src/glean/api_client/models/feedback.py
+++ b/src/glean/api_client/models/feedback.py
@@ -68,6 +68,8 @@ class Event(str, Enum):
MANUAL_FEEDBACK = "MANUAL_FEEDBACK"
# The user submitted comparative feedback for multiple side-by-side implementations.
MANUAL_FEEDBACK_SIDE_BY_SIDE = "MANUAL_FEEDBACK_SIDE_BY_SIDE"
+ # The user submitted feedback about time saved by an agent or workflow.
+ FEEDBACK_TIME_SAVED = "FEEDBACK_TIME_SAVED"
# The user explicitly marked the content as read.
MARK_AS_READ = "MARK_AS_READ"
# The user attempted to send a message using their default messaing app.
diff --git a/src/glean/api_client/models/relateddocuments.py b/src/glean/api_client/models/relateddocuments.py
index d19b3c35..a6d1efe7 100644
--- a/src/glean/api_client/models/relateddocuments.py
+++ b/src/glean/api_client/models/relateddocuments.py
@@ -64,7 +64,7 @@ class RelatedDocuments(BaseModel):
documents: Annotated[
Optional[List["Document"]],
pydantic.Field(
- deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
+ deprecated="warning: ** DEPRECATED ** - Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Field is deprecated."
),
] = None
r"""A truncated list of documents with this relation. TO BE DEPRECATED."""
diff --git a/src/glean/api_client/models/sensitiveinfotype.py b/src/glean/api_client/models/sensitiveinfotype.py
index b4f12073..7f0a68e4 100644
--- a/src/glean/api_client/models/sensitiveinfotype.py
+++ b/src/glean/api_client/models/sensitiveinfotype.py
@@ -10,7 +10,7 @@
@deprecated(
- "warning: ** DEPRECATED ** - Deprecated on undefined, removal scheduled for undefined."
+ "warning: ** DEPRECATED ** - Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Field is deprecated."
)
class SensitiveInfoTypeLikelihoodThreshold(str, Enum):
LIKELY = "LIKELY"
@@ -30,7 +30,7 @@ class SensitiveInfoType(BaseModel):
likelihood_threshold: Annotated[
Optional[SensitiveInfoTypeLikelihoodThreshold],
pydantic.Field(
- deprecated="warning: ** DEPRECATED ** - Deprecated on undefined, removal scheduled for undefined.",
+ deprecated="warning: ** DEPRECATED ** - Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Field is deprecated.",
alias="likelihoodThreshold",
),
] = None
diff --git a/src/glean/api_client/models/viewerinfo.py b/src/glean/api_client/models/viewerinfo.py
index dffc8d94..b7a6c1f8 100644
--- a/src/glean/api_client/models/viewerinfo.py
+++ b/src/glean/api_client/models/viewerinfo.py
@@ -11,7 +11,7 @@
@deprecated(
- "warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
+ "warning: ** DEPRECATED ** - Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Use permissions instead."
)
class Role(str, Enum):
r"""DEPRECATED - use permissions instead. Viewer's role on the specific document."""
@@ -31,7 +31,7 @@ class ViewerInfo(BaseModel):
role: Annotated[
Optional[Role],
pydantic.Field(
- deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
+ deprecated="warning: ** DEPRECATED ** - Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Use permissions instead."
),
] = None
r"""DEPRECATED - use permissions instead. Viewer's role on the specific document."""
diff --git a/tests/mockserver/internal/sdk/models/components/documentinteractions.go b/tests/mockserver/internal/sdk/models/components/documentinteractions.go
index 28bb3af0..5b5e215d 100644
--- a/tests/mockserver/internal/sdk/models/components/documentinteractions.go
+++ b/tests/mockserver/internal/sdk/models/components/documentinteractions.go
@@ -13,7 +13,7 @@ type DocumentInteractions struct {
NumReactions *int64 `json:"numReactions,omitempty"`
// To be deprecated in favor of reacts. A (potentially non-exhaustive) list of reactions for the document.
//
- // Deprecated: This will be removed in a future release, please migrate away from it as soon as possible.
+ // Deprecated: Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Use reacts instead.
Reactions []string `json:"reactions,omitempty"`
Reacts []Reaction `json:"reacts,omitempty"`
// Describes instances of someone posting a link to this document in one of our indexed datasources.
diff --git a/tests/mockserver/internal/sdk/models/components/facetfiltervalue.go b/tests/mockserver/internal/sdk/models/components/facetfiltervalue.go
index 68ba77de..6fa0e3a3 100644
--- a/tests/mockserver/internal/sdk/models/components/facetfiltervalue.go
+++ b/tests/mockserver/internal/sdk/models/components/facetfiltervalue.go
@@ -48,7 +48,7 @@ type FacetFilterValue struct {
RelationType *RelationType `json:"relationType,omitempty"`
// DEPRECATED - please use relationType instead
//
- // Deprecated: This will be removed in a future release, please migrate away from it as soon as possible.
+ // Deprecated: Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Use relationType instead.
IsNegated *bool `json:"isNegated,omitempty"`
}
diff --git a/tests/mockserver/internal/sdk/models/components/feedback.go b/tests/mockserver/internal/sdk/models/components/feedback.go
index c7e66678..2f916b07 100644
--- a/tests/mockserver/internal/sdk/models/components/feedback.go
+++ b/tests/mockserver/internal/sdk/models/components/feedback.go
@@ -84,6 +84,7 @@ const (
EventLastToken Event = "LAST_TOKEN"
EventManualFeedback Event = "MANUAL_FEEDBACK"
EventManualFeedbackSideBySide Event = "MANUAL_FEEDBACK_SIDE_BY_SIDE"
+ EventFeedbackTimeSaved Event = "FEEDBACK_TIME_SAVED"
EventMarkAsRead Event = "MARK_AS_READ"
EventMessage Event = "MESSAGE"
EventMiddleClick Event = "MIDDLE_CLICK"
@@ -140,6 +141,8 @@ func (e *Event) UnmarshalJSON(data []byte) error {
fallthrough
case "MANUAL_FEEDBACK_SIDE_BY_SIDE":
fallthrough
+ case "FEEDBACK_TIME_SAVED":
+ fallthrough
case "MARK_AS_READ":
fallthrough
case "MESSAGE":
diff --git a/tests/mockserver/internal/sdk/models/components/relateddocuments.go b/tests/mockserver/internal/sdk/models/components/relateddocuments.go
index b31d3fba..b7981fb2 100644
--- a/tests/mockserver/internal/sdk/models/components/relateddocuments.go
+++ b/tests/mockserver/internal/sdk/models/components/relateddocuments.go
@@ -85,7 +85,7 @@ type RelatedDocuments struct {
QuerySuggestion *QuerySuggestion `json:"querySuggestion,omitempty"`
// A truncated list of documents with this relation. TO BE DEPRECATED.
//
- // Deprecated: This will be removed in a future release, please migrate away from it as soon as possible.
+ // Deprecated: Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Field is deprecated.
Documents []Document `json:"documents,omitempty"`
// A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken.
Results []SearchResult `json:"results,omitempty"`
diff --git a/tests/mockserver/internal/sdk/models/components/sensitiveinfotype.go b/tests/mockserver/internal/sdk/models/components/sensitiveinfotype.go
index f8295caf..20765377 100644
--- a/tests/mockserver/internal/sdk/models/components/sensitiveinfotype.go
+++ b/tests/mockserver/internal/sdk/models/components/sensitiveinfotype.go
@@ -9,7 +9,7 @@ import (
// SensitiveInfoTypeLikelihoodThreshold
//
-// Deprecated: Deprecated on undefined, removal scheduled for undefined.
+// Deprecated: Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Field is deprecated.
type SensitiveInfoTypeLikelihoodThreshold string
const (
@@ -46,7 +46,7 @@ func (e *SensitiveInfoTypeLikelihoodThreshold) UnmarshalJSON(data []byte) error
}
type SensitiveInfoType struct {
- // Deprecated: Deprecated on undefined, removal scheduled for undefined.
+ // Deprecated: Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Field is deprecated.
LikelihoodThreshold *SensitiveInfoTypeLikelihoodThreshold `json:"likelihoodThreshold,omitempty"`
// Text representation of an info-type to scan for.
InfoType *string `json:"infoType,omitempty"`
diff --git a/tests/mockserver/internal/sdk/models/components/viewerinfo.go b/tests/mockserver/internal/sdk/models/components/viewerinfo.go
index 1f310364..5abdc47f 100644
--- a/tests/mockserver/internal/sdk/models/components/viewerinfo.go
+++ b/tests/mockserver/internal/sdk/models/components/viewerinfo.go
@@ -11,7 +11,7 @@ import (
// Role - DEPRECATED - use permissions instead. Viewer's role on the specific document.
//
-// Deprecated: This will be removed in a future release, please migrate away from it as soon as possible.
+// Deprecated: Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Use permissions instead.
type Role string
const (
@@ -44,7 +44,7 @@ func (e *Role) UnmarshalJSON(data []byte) error {
type ViewerInfo struct {
// DEPRECATED - use permissions instead. Viewer's role on the specific document.
//
- // Deprecated: This will be removed in a future release, please migrate away from it as soon as possible.
+ // Deprecated: Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Use permissions instead.
Role *Role `json:"role,omitempty"`
LastViewedTime *time.Time `json:"lastViewedTime,omitempty"`
}