From 52f8a60be94548e724f089d8c03efcabe87eff6c Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Tue, 20 Jan 2026 01:54:41 +0000 Subject: [PATCH 1/2] ## Python SDK Changes: * `glean.client.messages.retrieve()`: `response.search_response.glean_data_error.federated_search_rate_limit_error` **Added** * `glean.client.search.query_as_admin()`: * `response.glean_data_error.federated_search_rate_limit_error` **Added** * `error.federated_search_rate_limit_error` **Added** * `glean.client.search.autocomplete()`: `response.glean_data_error.federated_search_rate_limit_error` **Added** * `glean.client.search.recommendations()`: `response.glean_data_error.federated_search_rate_limit_error` **Added** * `glean.client.search.query()`: * `response.glean_data_error.federated_search_rate_limit_error` **Added** * `error.federated_search_rate_limit_error` **Added** --- .speakeasy/gen.lock | 49 +- .speakeasy/gen.yaml | 2 +- .speakeasy/glean-merged-spec.yaml | 982 +++++++++--------- .speakeasy/workflow.lock | 14 +- RELEASES.md | 12 +- docs/errors/gleandataerror.md | 13 +- docs/models/gleandataerror.md | 13 +- pyproject.toml | 2 +- src/glean/api_client/_version.py | 6 +- src/glean/api_client/errors/gleandataerror.py | 4 + src/glean/api_client/models/gleandataerror.py | 15 +- .../sdk/models/components/gleandataerror.go | 9 + .../sdk/models/sdkerrors/gleandataerror.go | 4 +- tests/test_summarize.py | 8 +- 14 files changed, 590 insertions(+), 543 deletions(-) diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index 1b4f5481..64c87eba 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: 91d38b9d4b28ef9b1b98e10a0b5a7371 + docChecksum: 8b62f83d578cce2f15f6e6554f41bcb3 docVersion: 0.9.0 - speakeasyVersion: 1.686.0 - generationVersion: 2.796.1 - releaseVersion: 0.11.27 - configChecksum: 37e1926f5925719f705610da6ba7d40e + speakeasyVersion: 1.689.0 + generationVersion: 2.796.4 + releaseVersion: 0.11.28 + configChecksum: 03e7fbb96c493ad4660d4b3db19252bc repoURL: https://github.com/gleanwork/api-client-python.git installationURL: https://github.com/gleanwork/api-client-python.git published: true persistentEdits: - generation_id: 8295e5cc-3cba-4720-b40b-d377a32f9ce7 - pristine_commit_hash: ec8d0cb548d884b034e3aa08460751054ec7dca1 - pristine_tree_hash: f2f4799cb7a7f9af40b1a07a81904fe71f4a3e37 + generation_id: f71b5147-88bc-4510-8dfb-732940d8273d + pristine_commit_hash: 23939934ac5e458ecec78172ee24527d4ebace70 + pristine_tree_hash: 8e699c244362d6802b441ac3b353668db651987e features: python: additionalDependencies: 1.0.0 @@ -75,8 +75,8 @@ trackedFiles: pristine_git_object: a6800fed5ba94f25934cdd5b8fe3fa6832f51239 docs/errors/gleandataerror.md: id: d8679ae13234 - last_write_checksum: sha1:bc595bf0967592999c683a4e3a43fa69783bbd10 - pristine_git_object: f1df02d4e5daa03df8e8c1b5684fcc91bcabc8a7 + last_write_checksum: sha1:a6567c83c6c0bf8eaed55f50af08001869d6a5de + pristine_git_object: 7c4c0d90fd0a2de3e48b99ce691c1e9a6ab03041 docs/models/activity.md: id: 78c9fe854b65 last_write_checksum: sha1:2bb3d1005124784d416910cff9777277facaebb2 @@ -1391,8 +1391,8 @@ trackedFiles: pristine_git_object: 51f7027a16bc10bb4effbdd438eab18581703421 docs/models/gleandataerror.md: id: feb7c60631e4 - last_write_checksum: sha1:bc595bf0967592999c683a4e3a43fa69783bbd10 - pristine_git_object: f1df02d4e5daa03df8e8c1b5684fcc91bcabc8a7 + last_write_checksum: sha1:a6567c83c6c0bf8eaed55f50af08001869d6a5de + pristine_git_object: 7c4c0d90fd0a2de3e48b99ce691c1e9a6ab03041 docs/models/grantpermission.md: id: 740a53de1e0a last_write_checksum: sha1:6f0d12e70708144b4978da20cccda528785c9e0d @@ -2607,8 +2607,8 @@ trackedFiles: pristine_git_object: 8e34b78a71b8bb97bad6dea99d0f791beb134e5b pyproject.toml: id: 5d07e7d72637 - last_write_checksum: sha1:e74ee3184e376810b0ad328b5c651c9c3cc31cd0 - pristine_git_object: a92333900a6aabd7e86b21f5b1cc0e4c5a232b11 + last_write_checksum: sha1:64ad0265b35e1f7b8e4b1e63978a4a5682155fc2 + pristine_git_object: 0907c294cdfd5063c422800361e711b026cb226a scripts/prepare_readme.py: id: e0c5957a6035 last_write_checksum: sha1:c2c83f71dea61eb50c9e05da83b16d18b4da8794 @@ -2635,8 +2635,8 @@ trackedFiles: pristine_git_object: 58c4d70ac1797b86ff5c4237cafbc344c42d8f64 src/glean/api_client/_version.py: id: 0ce22b26136b - last_write_checksum: sha1:188529d678c18f5c3fb9c35fc9cd1e0f75e4297e - pristine_git_object: 64da52a597a1b036329005760a371e97949a7eb6 + last_write_checksum: sha1:e66b2d7825e786577b70cd553e44fba834649ba5 + pristine_git_object: 99716d7607a70660995e74d7fd6708c658dd5659 src/glean/api_client/agents.py: id: b925701a9217 last_write_checksum: sha1:56f1329fbf799ea92ed30229d4ed2404666d455d @@ -2715,8 +2715,8 @@ trackedFiles: pristine_git_object: b2f7acde3c293f63d1af370cf1bd4266048c3834 src/glean/api_client/errors/gleandataerror.py: id: 8bae5389c0bf - last_write_checksum: sha1:29d39ccabff4905216e98b25d1d265a71d731785 - pristine_git_object: 978b0be0e85d64351fd71c8cfe765dbd341cf5ee + last_write_checksum: sha1:d9db844614059154744d99927a7468306de298c2 + pristine_git_object: 754c85de70a38e982ea6368b9c4f922883a9a040 src/glean/api_client/errors/gleanerror.py: id: 9f1d85652f59 last_write_checksum: sha1:a7a2bc1335123c6bd8c9f945a9c653f061e14167 @@ -3831,8 +3831,8 @@ trackedFiles: pristine_git_object: 9bd865818900f5e18df747e941b941d023d9cd92 src/glean/api_client/models/gleandataerror.py: id: 86e8dc6c1eb5 - last_write_checksum: sha1:e6f673d62bb9e46c48d64bc562439a86192d2f58 - pristine_git_object: 49567e8d31ff0e8224f5bf2da0e0cd615f209c80 + last_write_checksum: sha1:965386c5e2bc833aa410ea407dd114ae2172cc00 + pristine_git_object: 953126e2faefa6d9b050921194fb22953b1a6b8e src/glean/api_client/models/grantpermission.py: id: 0cfd67112b08 last_write_checksum: sha1:55769b361ff0127e010631f8523cffdf20e47fd2 @@ -5476,7 +5476,7 @@ trackedFiles: tests/mockserver/internal/sdk/models/components/gleanassistinsightsresponse.go: last_write_checksum: sha1:5b8a4fdefd05ed9e53cbee94c32b0a428175ad22 tests/mockserver/internal/sdk/models/components/gleandataerror.go: - last_write_checksum: sha1:e2ba36c9aeaebae5a4f57509af9597481a809f8b + last_write_checksum: sha1:fa6d4a5917a90f72a97628ba20e31dd31b02af0c tests/mockserver/internal/sdk/models/components/grantpermission.go: last_write_checksum: sha1:83d69c5a502306994095bc1a515d6c52798fa696 tests/mockserver/internal/sdk/models/components/greenlistusersrequest.go: @@ -6096,7 +6096,7 @@ trackedFiles: tests/mockserver/internal/sdk/models/sdkerrors/collectionerror.go: last_write_checksum: sha1:a8ce08145cf00a84487714f875ba1d3a8d84be1d tests/mockserver/internal/sdk/models/sdkerrors/gleandataerror.go: - last_write_checksum: sha1:8b2cb972da36ace2356aac3c81b133626315fd6c + last_write_checksum: sha1:ee697c8e2807f2b86c3de73bcbc013bbaf4ee2e9 tests/mockserver/internal/sdk/types/bigint.go: last_write_checksum: sha1:49b004005d0461fb04b846eca062b070b0360b31 tests/mockserver/internal/sdk/types/date.go: @@ -6249,8 +6249,8 @@ trackedFiles: pristine_git_object: df2944ebda36db652b2770dd1c23be83df90fc99 tests/test_summarize.py: id: a255d8a6f627 - last_write_checksum: sha1:4f50b660d414adea1d509dfc957eb74a12654ee4 - pristine_git_object: 63b4eb8541c2b110dab6dda746fef9ac074611f1 + last_write_checksum: sha1:6383d6969c6f1bf1832e5ace511e5c2ffaa6d86f + pristine_git_object: cac8e9788f25fda1ff78bd2e3e36917319145e82 tests/test_tools.py: id: 70889bdf7321 last_write_checksum: sha1:3c0c220f8975b050c322f6475e95f7af4e65b995 @@ -7138,6 +7138,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.messages.retrieve()`: `response.search_response.glean_data_error.federated_search_rate_limit_error` **Added**\n* `glean.client.search.query_as_admin()`: \n * `response.glean_data_error.federated_search_rate_limit_error` **Added**\n * `error.federated_search_rate_limit_error` **Added**\n* `glean.client.search.autocomplete()`: `response.glean_data_error.federated_search_rate_limit_error` **Added**\n* `glean.client.search.recommendations()`: `response.glean_data_error.federated_search_rate_limit_error` **Added**\n* `glean.client.search.query()`: \n * `response.glean_data_error.federated_search_rate_limit_error` **Added**\n * `error.federated_search_rate_limit_error` **Added**\n" generatedFiles: - .devcontainer/README.md - .devcontainer/devcontainer.json diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index 5194a521..00ac7d6b 100644 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -32,7 +32,7 @@ generation: generateNewTests: true skipResponseBodyAssertions: true python: - version: 0.11.27 + version: 0.11.28 additionalDependencies: dev: {} main: {} diff --git a/.speakeasy/glean-merged-spec.yaml b/.speakeasy/glean-merged-spec.yaml index f8520c95..5f8a91ea 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: 17a84cfc3e3f0e0a3eec1792cf57a65f444d613e + x-source-commit-sha: c781b892ed396d6a0aee04a9e85097ebaa81ae76 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: 3bb1859df9ba2cff7a43d5b1c336bb826a766b4c + x-open-api-commit-sha: 6953a9517f6f59a9eb9c7857521819a2298dabee x-speakeasy-name: 'Glean API' servers: - url: https://{instance}-be.glean.com @@ -2229,7 +2229,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/IndexDocumentRequest" + $ref: '#/components/schemas/IndexDocumentRequest' required: true x-exportParamName: IndexDocumentRequest responses: @@ -2255,7 +2255,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/IndexDocumentsRequest" + $ref: '#/components/schemas/IndexDocumentsRequest' required: true x-exportParamName: IndexDocumentsRequest responses: @@ -2281,7 +2281,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/BulkIndexDocumentsRequest" + $ref: '#/components/schemas/BulkIndexDocumentsRequest' required: true x-exportParamName: BulkIndexDocumentsRequest responses: @@ -2305,7 +2305,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/UpdatePermissionsRequest" + $ref: '#/components/schemas/UpdatePermissionsRequest' required: true x-exportParamName: UpdatePermissionsRequest responses: @@ -2342,7 +2342,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/ProcessAllDocumentsRequest" + $ref: '#/components/schemas/ProcessAllDocumentsRequest' x-exportParamName: ProcessAllDocumentsRequest responses: "200": @@ -2365,7 +2365,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/DeleteDocumentRequest" + $ref: '#/components/schemas/DeleteDocumentRequest' required: true x-exportParamName: DeleteDocumentRequest responses: @@ -2389,7 +2389,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/IndexUserRequest" + $ref: '#/components/schemas/IndexUserRequest' required: true x-exportParamName: IndexUserRequest responses: @@ -2415,7 +2415,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/BulkIndexUsersRequest" + $ref: '#/components/schemas/BulkIndexUsersRequest' required: true x-exportParamName: BulkIndexUsersRequest responses: @@ -2439,7 +2439,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/IndexGroupRequest" + $ref: '#/components/schemas/IndexGroupRequest' required: true x-exportParamName: IndexGroupRequest responses: @@ -2465,7 +2465,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/BulkIndexGroupsRequest" + $ref: '#/components/schemas/BulkIndexGroupsRequest' required: true x-exportParamName: BulkIndexGroupsRequest responses: @@ -2489,7 +2489,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/IndexMembershipRequest" + $ref: '#/components/schemas/IndexMembershipRequest' required: true x-exportParamName: IndexMembershipRequest responses: @@ -2513,7 +2513,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/BulkIndexMembershipsRequest" + $ref: '#/components/schemas/BulkIndexMembershipsRequest' required: true x-exportParamName: BulkIndexMembershipsRequest responses: @@ -2538,7 +2538,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/ProcessAllMembershipsRequest" + $ref: '#/components/schemas/ProcessAllMembershipsRequest' x-exportParamName: ProcessAllMembershipsRequest responses: "200": @@ -2561,7 +2561,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/DeleteUserRequest" + $ref: '#/components/schemas/DeleteUserRequest' required: true x-exportParamName: DeleteUserRequest responses: @@ -2587,7 +2587,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/DeleteGroupRequest" + $ref: '#/components/schemas/DeleteGroupRequest' required: true x-exportParamName: DeleteGroupRequest responses: @@ -2611,7 +2611,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/DeleteMembershipRequest" + $ref: '#/components/schemas/DeleteMembershipRequest' required: true x-exportParamName: DeleteMembershipRequest responses: @@ -2627,7 +2627,6 @@ paths: x-speakeasy-group: indexing.permissions /api/index/v1/debug/{datasource}/status: post: - x-beta: true summary: | Beta: Get datasource status description: | @@ -2649,16 +2648,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: | @@ -2678,7 +2677,7 @@ paths: content: application/json; charset=UTF-8: schema: - $ref: "#/components/schemas/DebugDocumentRequest" + $ref: '#/components/schemas/DebugDocumentRequest' required: true x-exportParamName: DebugDocumentRequest responses: @@ -2687,16 +2686,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: | @@ -2716,7 +2715,7 @@ paths: content: application/json; charset=UTF-8: schema: - $ref: "#/components/schemas/DebugDocumentsRequest" + $ref: '#/components/schemas/DebugDocumentsRequest' required: true x-exportParamName: DebugDocumentsRequest responses: @@ -2725,16 +2724,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: | @@ -2754,7 +2753,7 @@ paths: content: application/json; charset=UTF-8: schema: - $ref: "#/components/schemas/DebugUserRequest" + $ref: '#/components/schemas/DebugUserRequest' required: true x-exportParamName: DebugUserRequest responses: @@ -2763,11 +2762,12 @@ 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: @@ -2783,7 +2783,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/CheckDocumentAccessRequest" + $ref: '#/components/schemas/CheckDocumentAccessRequest' required: true x-exportParamName: CheckDocumentAccessRequest responses: @@ -2792,7 +2792,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/CheckDocumentAccessResponse" + $ref: '#/components/schemas/CheckDocumentAccessResponse' "400": description: Bad Request "401": @@ -2803,7 +2803,6 @@ 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. @@ -2815,7 +2814,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/GetDocumentStatusRequest" + $ref: '#/components/schemas/GetDocumentStatusRequest' required: true x-exportParamName: GetDocumentStatusRequest responses: @@ -2824,18 +2823,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. @@ -2847,7 +2846,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/GetDocumentCountRequest" + $ref: '#/components/schemas/GetDocumentCountRequest' required: true x-exportParamName: GetDocumentCountRequest responses: @@ -2856,18 +2855,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. @@ -2879,7 +2878,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/GetUserCountRequest" + $ref: '#/components/schemas/GetUserCountRequest' required: true x-exportParamName: GetUserCountRequest responses: @@ -2888,13 +2887,14 @@ 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: @@ -2907,7 +2907,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/GreenlistUsersRequest" + $ref: '#/components/schemas/GreenlistUsersRequest' required: true x-exportParamName: GreenlistUsersRequest responses: @@ -2931,7 +2931,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/CustomDatasourceConfig" + $ref: '#/components/schemas/CustomDatasourceConfig' required: true x-exportParamName: DatasourceConfig responses: @@ -2953,7 +2953,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/GetDatasourceConfigRequest" + $ref: '#/components/schemas/GetDatasourceConfigRequest' required: true x-exportParamName: GetDatasourceConfigRequest responses: @@ -2962,7 +2962,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/CustomDatasourceConfig" + $ref: '#/components/schemas/CustomDatasourceConfig' "400": description: Bad Request "401": @@ -2983,7 +2983,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/RotateTokenResponse" + $ref: '#/components/schemas/RotateTokenResponse' "400": description: Bad Request "401": @@ -3000,7 +3000,7 @@ paths: content: application/json; charset=UTF-8: schema: - $ref: "#/components/schemas/IndexEmployeeRequest" + $ref: '#/components/schemas/IndexEmployeeRequest' required: true x-exportParamName: IndexEmployeeRequest responses: @@ -3024,7 +3024,7 @@ paths: content: application/json; charset=UTF-8: schema: - $ref: "#/components/schemas/BulkIndexEmployeesRequest" + $ref: '#/components/schemas/BulkIndexEmployeesRequest' required: true x-exportParamName: BulkIndexEmployeesRequest responses: @@ -3067,7 +3067,7 @@ paths: content: application/json; charset=UTF-8: schema: - $ref: "#/components/schemas/DeleteEmployeeRequest" + $ref: '#/components/schemas/DeleteEmployeeRequest' required: true x-exportParamName: DeleteEmployeeRequest responses: @@ -3091,7 +3091,7 @@ paths: content: application/json; charset=UTF-8: schema: - $ref: "#/components/schemas/IndexTeamRequest" + $ref: '#/components/schemas/IndexTeamRequest' required: true x-exportParamName: IndexTeamRequest responses: @@ -3115,7 +3115,7 @@ paths: content: application/json; charset=UTF-8: schema: - $ref: "#/components/schemas/DeleteTeamRequest" + $ref: '#/components/schemas/DeleteTeamRequest' required: true x-exportParamName: DeleteTeamRequest responses: @@ -3139,7 +3139,7 @@ paths: content: application/json; charset=UTF-8: schema: - $ref: "#/components/schemas/BulkIndexTeamsRequest" + $ref: '#/components/schemas/BulkIndexTeamsRequest' required: true x-exportParamName: BulkIndexTeamsRequest responses: @@ -3163,7 +3163,7 @@ paths: content: application/json; charset=UTF-8: schema: - $ref: "#/components/schemas/BulkIndexShortcutsRequest" + $ref: '#/components/schemas/BulkIndexShortcutsRequest' required: true x-exportParamName: BulkIndexShortcutsRequest responses: @@ -3187,7 +3187,7 @@ paths: content: application/json; charset=UTF-8: schema: - $ref: "#/components/schemas/UploadShortcutsRequest" + $ref: '#/components/schemas/UploadShortcutsRequest' required: true x-exportParamName: UploadShortcutsRequest responses: @@ -3203,10 +3203,9 @@ paths: x-speakeasy-group: indexing.shortcuts /rest/api/v1/governance/data/policies/{id}: get: - description: Fetches the specified policy version, or the latest if no version is provided. - summary: Gets specified policy operationId: getpolicy - x-visibility: Public + summary: Gets specified policy + description: Fetches the specified policy version, or the latest if no version is provided. tags: - Governance parameters: @@ -3229,17 +3228,18 @@ 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: - description: Updates an existing policy. - summary: Updates an existing policy operationId: updatepolicy + summary: Updates an existing policy + description: Updates an existing policy. tags: - Governance parameters: @@ -3253,7 +3253,7 @@ paths: content: application/json; charset=UTF-8: schema: - $ref: "#/components/schemas/UpdateDlpReportRequest" + $ref: '#/components/schemas/UpdateDlpReportRequest' required: true responses: "200": @@ -3261,7 +3261,7 @@ paths: content: application/json; charset=UTF-8: schema: - $ref: "#/components/schemas/UpdateDlpReportResponse" + $ref: '#/components/schemas/UpdateDlpReportResponse' "403": description: Permissions error "500": @@ -3270,10 +3270,9 @@ paths: x-speakeasy-name-override: update /rest/api/v1/governance/data/policies: get: - description: Lists policies with filtering. - summary: Lists policies operationId: listpolicies - x-visibility: Public + summary: Lists policies + description: Lists policies with filtering. tags: - Governance parameters: @@ -3295,25 +3294,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: - description: Creates a new policy with specified specifications and returns its id. - summary: Creates new policy operationId: createpolicy - x-visibility: Public + summary: Creates new policy + description: Creates a new policy with specified specifications and returns its id. tags: - Governance requestBody: content: application/json; charset=UTF-8: schema: - $ref: "#/components/schemas/CreateDlpReportRequest" + $ref: '#/components/schemas/CreateDlpReportRequest' required: true responses: "200": @@ -3321,19 +3320,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: - 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 + summary: Downloads violations CSV for policy + description: Downloads CSV violations report for a specific policy id. This does not support continuous policies. tags: - Governance parameters: @@ -3349,29 +3348,29 @@ paths: content: text/csv; charset=UTF-8: schema: - description: CSV of all the violations found for this policy. type: string + description: CSV of all the violations found for this policy. "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: - description: Creates a new one-time report and executes its batch job. - summary: Creates new one-time report operationId: createreport - x-visibility: Public + summary: Creates new one-time report + description: Creates a new one-time report and executes its batch job. tags: - Governance requestBody: content: application/json; charset=UTF-8: schema: - $ref: "#/components/schemas/UpdateDlpConfigRequest" + $ref: '#/components/schemas/UpdateDlpConfigRequest' required: true responses: "200": @@ -3379,19 +3378,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: - description: Downloads CSV violations report for a specific report id. - summary: Downloads violations CSV for report operationId: downloadreportcsv - x-visibility: Public + summary: Downloads violations CSV for report + description: Downloads CSV violations report for a specific report id. tags: - Governance parameters: @@ -3407,20 +3406,20 @@ paths: content: text/csv; charset=UTF-8: schema: - description: CSV of all the violations found for this report. type: string + description: CSV of all the violations found for this report. "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: - description: Fetches the status of the run corresponding to the report-id. - summary: Fetches report run status operationId: getreportstatus - x-visibility: Public + summary: Fetches report run status + description: Fetches the status of the run corresponding to the report-id. tags: - Governance parameters: @@ -3436,19 +3435,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: - description: Fetches the visibility override status of the documents passed. - summary: Fetches documents visibility operationId: getdocvisibility - x-visibility: Public + summary: Fetches documents visibility + description: Fetches the visibility override status of the documents passed. tags: - Governance parameters: @@ -3465,25 +3464,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: - 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 + summary: Hide or unhide docs + description: Sets the visibility-override state of the documents specified, effectively hiding or un-hiding documents. tags: - Governance requestBody: content: application/json; charset=UTF-8: schema: - $ref: "#/components/schemas/UpdateDocumentVisibilityOverridesRequest" + $ref: '#/components/schemas/UpdateDocumentVisibilityOverridesRequest' required: true responses: "200": @@ -3491,26 +3490,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: - description: Creates a new DLP findings export job. - summary: Creates findings export operationId: createfindingsexport - x-visibility: Private + summary: Creates findings export + description: Creates a new DLP findings export job. tags: - Governance requestBody: content: application/json; charset=UTF-8: schema: - $ref: "#/components/schemas/DlpExportFindingsRequest" + $ref: '#/components/schemas/DlpExportFindingsRequest' required: true responses: "200": @@ -3518,16 +3517,16 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/ExportInfo" + $ref: '#/components/schemas/ExportInfo' "403": description: Permissions error "500": description: Internal error + x-visibility: Private get: - description: Lists all DLP findings exports. - summary: Lists findings exports operationId: listfindingsexports - x-visibility: Private + summary: Lists findings exports + description: Lists all DLP findings exports. tags: - Governance responses: @@ -3536,17 +3535,17 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/ListDlpFindingsExportsResponse" + $ref: '#/components/schemas/ListDlpFindingsExportsResponse' "403": description: Permissions error "500": description: Internal error + x-visibility: Private /rest/api/v1/governance/data/findings/exports/{id}: get: - description: Downloads a DLP findings export as a CSV file. - summary: Downloads findings export operationId: downloadfindingsexport - x-visibility: Private + summary: Downloads findings export + description: Downloads a DLP findings export as a CSV file. tags: - Governance parameters: @@ -3562,17 +3561,17 @@ paths: content: text/csv; charset=UTF-8: schema: - description: CSV of all the exported findings. type: string + description: CSV of all the exported findings. "403": description: Permissions error "500": description: Internal error + x-visibility: Private delete: - description: Deletes a DLP findings export. - summary: Deletes findings export operationId: deletefindingsexport - x-visibility: Private + summary: Deletes findings export + description: Deletes a DLP findings export. tags: - Governance parameters: @@ -3590,6 +3589,7 @@ paths: description: Permissions error "500": description: Internal error + x-visibility: Private /rest/api/v1/chat#stream: post: tags: @@ -4845,8 +4845,6 @@ 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 @@ -4854,11 +4852,13 @@ components: description: An email address type: type: string - description: An enum of `PRIMARY`, `SECONDARY`, `ONCALL`, `OTHER` default: OTHER + description: An enum of `PRIMARY`, `SECONDARY`, `ONCALL`, `OTHER` + type: object required: - email - type + description: Information about a team's email CustomFieldValueStr: properties: strText: @@ -9025,6 +9025,9 @@ components: type: array items: $ref: "#/components/schemas/ErrorMessage" + federatedSearchRateLimitError: + type: boolean + description: Indicates the federated search results could not be fetched due to rate limiting. x-speakeasy-name-override: GleanDataError ResultsResponse: properties: @@ -10827,20 +10830,19 @@ 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 @@ -10849,16 +10851,16 @@ components: type: string description: Datasource of the documents documents: - description: Batch of documents being added/updated type: array items: - $ref: "#/components/schemas/DocumentDefinition" + $ref: '#/components/schemas/DocumentDefinition' + description: Batch of documents being added/updated 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 @@ -10873,30 +10875,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 @@ -10911,9 +10913,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 @@ -10929,11 +10931,9 @@ 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 @@ -10947,68 +10947,70 @@ 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" + $ref: '#/components/schemas/TeamInfoDefinition' + description: Batch of team information 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" + $ref: '#/components/schemas/EmployeeInfoDefinition' + description: Batch of employee information 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" + $ref: '#/components/schemas/DocumentDefinition' + description: Batch of documents for the datasource 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 @@ -11027,9 +11029,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 @@ -11039,30 +11041,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 @@ -11080,10 +11082,10 @@ components: type: string description: datasource of the users users: - description: batch of users for the datasource type: array items: - $ref: "#/components/schemas/DatasourceUserDefinition" + $ref: '#/components/schemas/DatasourceUserDefinition' + description: batch of users for the datasource 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` @@ -11091,31 +11093,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: - description: To be supplied if the user id in the datasource is not the email type: string + description: To be supplied if the user id in the datasource is not the email name: type: string isActive: @@ -11124,9 +11126,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 @@ -11136,14 +11138,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 @@ -11161,10 +11163,10 @@ components: type: string description: datasource of the groups groups: - description: batch of groups for the datasource type: array items: - $ref: "#/components/schemas/DatasourceGroupDefinition" + $ref: '#/components/schemas/DatasourceGroupDefinition' + description: batch of groups for the datasource 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` @@ -11172,18 +11174,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 @@ -11193,14 +11195,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 @@ -11221,49 +11223,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" + $ref: '#/components/schemas/DatasourceBulkMembershipDefinition' + description: batch of memberships for the group 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: - description: The group for which the membership is specified type: string + description: The group for which the membership is specified memberUserId: - description: If the member is a user, then the email or datasource id for the user type: string + description: If the member is a user, then the email or datasource id for the user memberGroupName: - description: If the member is a group, then the name of the member group type: string + description: If the member is a group, then the name of the member group 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: - description: If the member is a user, then the email or datasource id for the user type: string + description: If the member is a user, then the email or datasource id for the user memberGroupName: - description: If the member is a group, then the name of the member group type: string + 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. DeleteUserRequest: type: object - description: Describes the request body of the /deleteuser API call properties: version: type: integer @@ -11273,14 +11275,14 @@ components: type: string description: The datasource for which the user is removed email: - description: The email of the user to be deleted type: string + description: The email of the user to be deleted 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 @@ -11290,14 +11292,14 @@ components: type: string description: The datasource for which the group is removed groupName: - description: the name of the group to be deleted type: string + description: the name of the group to be deleted 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 @@ -11307,36 +11309,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: - description: The deleted employee's email type: string + description: The deleted employee's email 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: - description: The deleted team's id type: string + description: The deleted team's id required: - id + description: Describes the request body of the /deleteteam API call DocumentDefinition: type: object - description: Indexable document structure properties: title: type: string @@ -11367,16 +11369,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 @@ -11387,14 +11389,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: @@ -11405,27 +11407,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 @@ -11436,13 +11438,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 @@ -11454,9 +11456,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 @@ -11465,42 +11467,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" + $ref: '#/components/schemas/UserReferenceDefinition' + description: List of users who can view the document 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" + $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 ... allowAnonymousAccess: - description: If true, then any Glean user can view the document type: boolean + description: If true, then any Glean user can view the document allowAllDatasourceUsersAccess: - description: If true, then any user who has an account in the datasource can view the document. type: boolean + 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 DocumentInteractionsDefinition: type: object - description: describes the interactions on the document properties: numViews: type: integer @@ -11508,9 +11510,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 @@ -11529,44 +11531,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 - description: Datasource configuration. items: - $ref: "#/components/schemas/SharedDatasourceConfig" + $ref: '#/components/schemas/SharedDatasourceConfig' + description: Datasource configuration. + required: + - datasourceConfig + description: List of datasource configurations. RotateTokenResponse: - description: Describes the response body of the /rotatetoken API call properties: rawSecret: type: string @@ -11579,31 +11581,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" + $ref: '#/components/schemas/IndexEmployeeRequest' + description: List of employee info and version. + description: Describes the request body of the /indexemployeelist API call SocialNetworkDefinition: type: object - description: Employee's social network profile properties: name: type: string @@ -11614,15 +11616,18 @@ 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. @@ -11639,9 +11644,7 @@ 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. - items: - type: object - description: Either a string or HypertextField. When OpenAPI Generator supports oneOf, we can semantically enforce this in the docs. + description: Additional information about the employee or team. HypertextField: type: object properties: @@ -11653,7 +11656,6 @@ components: description: URL for the hypertext field. EmployeeInfoDefinition: type: object - description: Describes employee info properties: email: type: string @@ -11681,8 +11683,8 @@ components: description: The employee's location (city/office name etc). deprecated: true 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. @@ -11698,14 +11700,14 @@ components: description: An organizational unit where everyone has a similar task, e.g. `Engineering`. datasourceProfiles: type: array - description: The datasource profiles of the employee, e.g. `Slack`,`Github`. items: - $ref: "#/components/schemas/DatasourceProfile" + $ref: '#/components/schemas/DatasourceProfile' + description: The datasource profiles of the employee, e.g. `Slack`,`Github`. teams: type: array - description: Info about the employee's team(s) items: - $ref: "#/components/schemas/EmployeeTeamInfo" + $ref: '#/components/schemas/EmployeeTeamInfo' + description: Info about the employee's team(s) startDate: type: string format: date @@ -11722,17 +11724,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 - description: List of social network profiles. items: - $ref: "#/components/schemas/SocialNetworkDefinition" + $ref: '#/components/schemas/SocialNetworkDefinition' + description: List of social network profiles. managerEmail: type: string description: The email of the employee's manager @@ -11746,37 +11748,37 @@ components: default: FULL_TIME relationships: type: array - 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" + $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. status: type: string description: The status of the employee, an enum of `CURRENT`, `FUTURE`, `EX` default: CURRENT additionalFields: type: array - description: List of additional fields with more information about the employee. items: - $ref: "#/components/schemas/AdditionalFieldDefinition" + $ref: '#/components/schemas/AdditionalFieldDefinition' + description: List of additional fields with more information about the employee. 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 @@ -11788,12 +11790,9 @@ 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 @@ -11801,14 +11800,17 @@ 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 - description: The member's email format: email + description: The member's email relationship: type: string description: The member's relationship to the team, an enum of `MEMBER`, `MANAGER`, `LEAD`, `POINT_OF_CONTACT`, `OTHER` @@ -11819,9 +11821,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 @@ -11849,120 +11851,121 @@ components: A link to an external team page. If set, team results will link to it. emails: type: array - description: The emails of the team items: - $ref: "#/components/schemas/TeamEmail" + $ref: '#/components/schemas/TeamEmail' + description: The emails of the team datasourceProfiles: type: array - description: The datasource profiles of the team, e.g. `Slack`,`Github`. items: - $ref: "#/components/schemas/DatasourceProfile" + $ref: '#/components/schemas/DatasourceProfile' + description: The datasource profiles of the team, e.g. `Slack`,`Github`. members: type: array - description: The members of the team items: - $ref: "#/components/schemas/TeamMember" + $ref: '#/components/schemas/TeamMember' + description: The members of the team additionalFields: type: array - description: List of additional fields with more information about the team. items: - $ref: "#/components/schemas/AdditionalFieldDefinition" + $ref: '#/components/schemas/AdditionalFieldDefinition' + description: List of additional fields with more information about the team. 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" + $ref: '#/components/schemas/ExternalShortcut' + description: Batch of shortcuts information 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" + $ref: '#/components/schemas/IndexingShortcut' + description: Batch of shortcuts information 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 - description: The number of documents indexed, grouped by objectType items: - $ref: "#/components/schemas/DatasourceObjectTypeDocumentCountEntry" + $ref: '#/components/schemas/DatasourceObjectTypeDocumentCountEntry' + description: The number of documents indexed, grouped by objectType 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: @@ -11983,7 +11986,6 @@ components: example: 15 BulkUploadHistoryEvent: type: object - description: Information about a successful bulk upload properties: uploadId: type: string @@ -11999,14 +12001,13 @@ 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 @@ -12014,15 +12015,16 @@ 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" + $ref: '#/components/schemas/BulkUploadHistoryEvent' + description: Information about active and recent successful uploads for the datasource DebugDocumentRequest: type: object - description: Describes the request body of the /debug/{datasource}/document API call. properties: objectType: type: string @@ -12035,30 +12037,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" + $ref: '#/components/schemas/DocumentPermissionsDefinition' + description: Describes the response body of the /debug/{datasource}/document API call DebugDocumentsRequest: type: object - description: Describes the request body of the /debug/{datasource}/documents API call. properties: debugDocuments: type: array - description: Documents to fetch debug information for items: - $ref: "#/components/schemas/DebugDocumentRequest" + $ref: '#/components/schemas/DebugDocumentRequest' + description: Documents to fetch debug information for 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 @@ -12067,21 +12069,21 @@ components: type: string description: objectType of the document debugInfo: + $ref: '#/components/schemas/DebugDocumentResponse' type: object description: Debug information of the document - $ref: "#/components/schemas/DebugDocumentResponse" + description: Describes the response body of a single document in the /debug/{datasource}/documents API call DebugDocumentsResponse: type: object - description: Describes the response body of a single document in the /debug/{datasource}/documents API call properties: documentStatuses: type: array - description: List of document ids/urls and their debug information items: - $ref: "#/components/schemas/DebugDocumentsResponseItem" + $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 DocumentStatusResponse: type: object - description: Describes the document status response body properties: uploadStatus: type: string @@ -12103,17 +12105,18 @@ 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 @@ -12121,7 +12124,6 @@ components: example: "2021-08-06T17:58:01.000Z" ProcessingHistoryEvent: type: object - description: Processing history event for a datasource properties: startTime: type: string @@ -12131,14 +12133,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" + $ref: '#/components/schemas/ProcessingHistoryEvent' + description: Information about processing history for the datasource DebugUserRequest: type: object - description: Describes the request body of the /debug/{datasource}/user API call properties: email: type: string @@ -12146,44 +12148,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 - description: List of groups the user is a member of, as uploaded via permissions API. items: - $ref: "#/components/schemas/DatasourceGroupDefinition" + $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 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 @@ -12204,26 +12206,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 - description: List of lifecycle events corresponding to the document items: - $ref: "#/components/schemas/LifeCycleEvent" + $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 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 @@ -12233,6 +12235,7 @@ components: description: Additional details about the error required: - error + description: Error response for custom metadata operations PropertyDefinition: properties: name: @@ -12274,7 +12277,6 @@ 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 @@ -12282,8 +12284,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 @@ -12316,17 +12318,17 @@ components: propertyDefinitions: type: array items: - $ref: "#/components/schemas/PropertyDefinition" + $ref: '#/components/schemas/PropertyDefinition' propertyGroups: type: array - 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" + $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. summarizable: - description: Whether or not the object is summarizable type: boolean + description: Whether or not the object is summarizable + description: The definition for an `DocumentMetadata.objectType` within a datasource. CanonicalizingRegexType: - description: Regular expression to apply to an arbitrary string to transform it into a canonical string. properties: matchRegex: type: string @@ -12334,11 +12336,9 @@ 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 @@ -12367,20 +12367,20 @@ components: - ENTITY - CALENDAR - AGENTS - 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. + default: UNCATEGORIZED 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 - description: The list of top-level `objectType`s for the datasource. items: - $ref: "#/components/schemas/ObjectDefinition" + $ref: '#/components/schemas/ObjectDefinition' + description: The list of top-level `objectType`s for the datasource. suggestionText: type: string description: Example text for what to search for in this datasource @@ -12389,15 +12389,14 @@ 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: @@ -12405,54 +12404,58 @@ components: - TAG - AUTHOR - OWNER + description: List of built-in facet types that should be hidden for the datasource. canonicalizingURLRegex: type: array - 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" + $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. canonicalizingTitleRegex: type: array - 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" + $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 redlistTitleRegex: type: string description: A regex that identifies titles that should not be indexed connectorType: - allOf: - - $ref: "#/components/schemas/ConnectorType" type: string + allOf: + - $ref: '#/components/schemas/ConnectorType' + deprecated: false quicklinks: type: array - 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" + $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 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 - 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. + default: true 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 - default: true 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. CustomDatasourceConfig: - description: Structure describing config properties of a custom datasource allOf: - - $ref: "#/components/schemas/SharedDatasourceConfigNoInstance" + - $ref: '#/components/schemas/SharedDatasourceConfigNoInstance' - type: object properties: identityDatasourceName: @@ -12466,12 +12469,13 @@ components: description: whether email is used to reference users in document ACLs and in group memberships. isEntityDatasource: type: boolean - default: false description: True if this datasource is used to push custom entities. + default: false isTestDatasource: type: boolean - default: false 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 ShortcutProperties: properties: inputAlias: @@ -12500,7 +12504,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 @@ -12524,9 +12528,8 @@ 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: @@ -12538,9 +12541,10 @@ 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 @@ -12556,7 +12560,6 @@ components: SensitiveInfoType: properties: likelihoodThreshold: - deprecated: true type: string enum: - LIKELY @@ -12564,98 +12567,99 @@ components: - POSSIBLE - UNLIKELY - VERY_UNLIKELY + deprecated: true infoType: - description: Text representation of an info-type to scan for. type: string + description: Text representation of an info-type to scan for. TimeRange: properties: startTime: type: string - description: start time of the time range, applicable for the CUSTOM type. format: date-time + description: start time of the time range, applicable for the CUSTOM type. endTime: type: string - description: end time of the time range, applicable for the CUSTOM type. format: date-time + description: end time of the time range, applicable for the CUSTOM type. lastNDaysValue: type: integer - description: The number of days to look back from the current time, applicable for the LAST_N_DAYS type. format: int64 + description: The number of days to look back from the current time, applicable for the LAST_N_DAYS type. 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 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 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' + 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: - deprecated: true type: boolean + deprecated: true threshold: - description: The minimum number of users the document is shared with. type: integer + description: The minimum number of users the document is shared with. thresholdEnabled: - description: Documents will be filtered based on how many people have access to it. type: boolean + description: Documents will be filtered based on how many people have access to it. anyoneWithLinkEnabled: - deprecated: true type: boolean + deprecated: true anyoneInternalEnabled: - description: Only users within the organization can access the document. type: boolean + description: Only users within the organization can access the document. anonymousAccessEnabled: - description: Anyone on the internet can access the document. type: boolean + description: Anyone on the internet can access the document. userAccessEnabled: - description: Enable user access check type: boolean + description: Enable user access check 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: - deprecated: true allOf: - description: DEPRECATED - use `broadSharingOptions` instead. - - $ref: "#/components/schemas/SharingOptions" + - $ref: '#/components/schemas/SharingOptions' - type: object properties: domainAccessEnabled: type: boolean + deprecated: true HotwordProximity: properties: windowBefore: @@ -12667,36 +12671,35 @@ components: regex: type: string proximity: - $ref: "#/components/schemas/HotwordProximity" + $ref: '#/components/schemas/HotwordProximity' SensitiveExpression: properties: expression: - description: Sensitive word, phrase, or regular expression. type: string + description: Sensitive word, phrase, or regular expression. hotwords: - description: Zero to three proximate regular expressions necessary to consider an expression as sensitive content. type: array items: - $ref: "#/components/schemas/Hotword" + $ref: '#/components/schemas/Hotword' + description: Zero to three proximate regular expressions necessary to consider an expression as sensitive content. 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: - description: Identifier for the custom sensitive expression. type: string + description: Identifier for the custom sensitive expression. 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 @@ -12704,43 +12707,44 @@ 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: - description: Identifier for the custom sensitive expression. type: string + description: Identifier for the custom sensitive expression. keyword: + $ref: '#/components/schemas/CustomSensitiveRule' description: The keyword to match against. - $ref: "#/components/schemas/CustomSensitiveRule" evaluationExpression: - description: The expression to evaluate the keyword match. type: string + description: The expression to evaluate the keyword match. 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" - sensitiveTerms: - deprecated: true + $ref: '#/components/schemas/SensitiveInfoType' description: DEPRECATED - use 'customSensitiveExpressions' instead. + deprecated: true + sensitiveTerms: type: array items: - $ref: "#/components/schemas/SensitiveExpression" - sensitiveRegexes: - deprecated: true + $ref: '#/components/schemas/SensitiveExpression' description: DEPRECATED - use 'customSensitiveExpressions' instead. + deprecated: true + sensitiveRegexes: type: array items: - $ref: "#/components/schemas/SensitiveExpression" + $ref: '#/components/schemas/SensitiveExpression' + description: DEPRECATED - use 'customSensitiveExpressions' instead. + deprecated: true customSensitiveExpressions: - description: list of custom sensitive expressions to consider as sensitive content type: array items: - $ref: "#/components/schemas/CustomSensitiveExpression" + $ref: '#/components/schemas/CustomSensitiveExpression' + description: list of custom sensitive expressions to consider as sensitive content + description: Options for defining sensitive content within scanned documents. DlpPersonMetadata: properties: firstName: @@ -12750,10 +12754,6 @@ 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 @@ -12762,111 +12762,114 @@ components: type: string description: An opaque identifier that can be used to request metadata for a Person. metadata: - $ref: "#/components/schemas/DlpPersonMetadata" + $ref: '#/components/schemas/DlpPersonMetadata' + required: + - name + - obfuscatedId + description: Details about the person who created this report/policy. 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" + $ref: '#/components/schemas/SensitiveInfoType' + description: DEPRECATED - use `sensitiveContentOptions` instead. + deprecated: true inputOptions: + $ref: '#/components/schemas/InputOptions' description: Options for documents to include or exclude in a report - $ref: "#/components/schemas/InputOptions" externalSharingOptions: - deprecated: true + $ref: '#/components/schemas/ExternalSharingOptions' description: DEPRECATED - use `broadSharingOptions` instead. - $ref: "#/components/schemas/ExternalSharingOptions" + deprecated: true 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: - description: Interval between scans. type: string + description: Interval between scans. 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: - description: redact quote in findings of the report type: boolean + description: redact quote in findings of the report autoHideDocs: - description: auto hide documents with findings in the report type: boolean + description: auto hide documents with findings in the report allowlistOptions: + $ref: '#/components/schemas/AllowlistOptions' description: Options for defining whitelisting content within scanned documents - $ref: "#/components/schemas/AllowlistOptions" + description: Detailed configuration of what documents and sensitive content will be scanned. 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: - description: Auto hide documents with findings in the policy. type: boolean + description: Auto hide documents with findings in the policy. lastScanStatus: type: string enum: @@ -12877,33 +12880,34 @@ 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. - $ref: "#/components/schemas/DlpPerson" + description: Full policy information that will be used for scans. 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: - description: The new autoHideDoc boolean the policy will be updated to if provided. type: boolean + description: The new autoHideDoc boolean the policy will be updated to if provided. reportName: - description: The new name of the policy if provided. type: string + description: The new name of the policy if provided. DlpSimpleResult: type: string enum: @@ -12912,45 +12916,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: - description: Name of the policy being created. type: string + description: Name of the policy being created. 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: - description: Controls whether the policy should hide documents with violations. type: boolean + description: Controls whether the policy should hide documents with violations. CreateDlpReportResponse: properties: report: - $ref: "#/components/schemas/DlpReport" + $ref: '#/components/schemas/DlpReport' UpdateDlpConfigRequest: properties: config: - $ref: "#/components/schemas/DlpConfig" + $ref: '#/components/schemas/DlpConfig' frequency: - description: Only "ONCE" is supported for reports. type: string + description: Only "ONCE" is supported for reports. UpdateDlpConfigResponse: properties: result: - $ref: "#/components/schemas/DlpSimpleResult" + $ref: '#/components/schemas/DlpSimpleResult' reportId: - description: The id of the report that was just created and run. type: string + description: The id of the report that was just created and run. ReportStatusResponse: properties: status: @@ -12963,70 +12967,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: - description: Whether this document was successfully set to its desired visibility state. type: boolean + description: Whether this document was successfully set to its desired visibility state. UpdateDocumentVisibilityOverridesResponse: properties: results: - description: The documents and whether their visibility was successfully updated. type: array items: - $ref: "#/components/schemas/DocumentVisibilityUpdateResult" + $ref: '#/components/schemas/DocumentVisibilityUpdateResult' + description: The documents and whether their visibility was successfully updated. 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: @@ -13044,28 +13048,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 @@ -13073,15 +13077,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 @@ -13091,27 +13095,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: @@ -13173,37 +13177,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 7163a0bc..fe9f02ef 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,12 +1,12 @@ -speakeasyVersion: 1.686.0 +speakeasyVersion: 1.689.0 sources: Glean API: sourceNamespace: glean-api-specs - sourceRevisionDigest: sha256:fcb56a3a1b355cdff7e63a0b76385f81472ce01a748f25a409b13b70d89436cc - sourceBlobDigest: sha256:01a8dbd2649712ab871b1799b6c76f92f4edb070c675738cac74685c81879a37 + sourceRevisionDigest: sha256:0a2baf3259912e43545f6783ac220939e45e8462976c489869b094b8335c36d8 + sourceBlobDigest: sha256:b713f33b1365ee1a46b1bd0ab8afa3f44c64f8dd156cd0921e45110f55fe15b0 tags: - latest - - speakeasy-sdk-regen-1768441819 + - speakeasy-sdk-regen-1768614376 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:fcb56a3a1b355cdff7e63a0b76385f81472ce01a748f25a409b13b70d89436cc - sourceBlobDigest: sha256:01a8dbd2649712ab871b1799b6c76f92f4edb070c675738cac74685c81879a37 + sourceRevisionDigest: sha256:0a2baf3259912e43545f6783ac220939e45e8462976c489869b094b8335c36d8 + sourceBlobDigest: sha256:b713f33b1365ee1a46b1bd0ab8afa3f44c64f8dd156cd0921e45110f55fe15b0 codeSamplesNamespace: glean-api-specs-python-code-samples - codeSamplesRevisionDigest: sha256:77edd92d12a6f8e9e87bc2578f8369e25dba1060192ba455304996c267701c6a + codeSamplesRevisionDigest: sha256:33309b0a12ef7143fac9644b24cb1001e4e1d67ee1c7f428133866823345f5cc workflow: workflowVersion: 1.0.0 speakeasyVersion: latest diff --git a/RELEASES.md b/RELEASES.md index 96a2a717..466b7f0d 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -498,4 +498,14 @@ Based on: ### Generated - [python v0.11.27] . ### Releases -- [PyPI v0.11.27] https://pypi.org/project/glean-api-client/0.11.27 - . \ No newline at end of file +- [PyPI v0.11.27] https://pypi.org/project/glean-api-client/0.11.27 - . + +## 2026-01-20 01:51:08 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.689.0 (2.796.4) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v0.11.28] . +### Releases +- [PyPI v0.11.28] https://pypi.org/project/glean-api-client/0.11.28 - . \ No newline at end of file diff --git a/docs/errors/gleandataerror.md b/docs/errors/gleandataerror.md index f1df02d4..7c4c0d90 100644 --- a/docs/errors/gleandataerror.md +++ b/docs/errors/gleandataerror.md @@ -3,9 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `bad_gmail_token` | *Optional[bool]* | :heavy_minus_sign: | Indicates the gmail results could not be fetched due to bad token. | -| `bad_outlook_token` | *Optional[bool]* | :heavy_minus_sign: | Indicates the outlook results could not be fetched due to bad token. | -| `invalid_operators` | List[[models.InvalidOperatorValueError](../models/invalidoperatorvalueerror.md)] | :heavy_minus_sign: | Indicates results could not be fetched due to invalid operators in the query. | -| `error_messages` | List[[models.ErrorMessage](../models/errormessage.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| `bad_gmail_token` | *Optional[bool]* | :heavy_minus_sign: | Indicates the gmail results could not be fetched due to bad token. | +| `bad_outlook_token` | *Optional[bool]* | :heavy_minus_sign: | Indicates the outlook results could not be fetched due to bad token. | +| `invalid_operators` | List[[models.InvalidOperatorValueError](../models/invalidoperatorvalueerror.md)] | :heavy_minus_sign: | Indicates results could not be fetched due to invalid operators in the query. | +| `error_messages` | List[[models.ErrorMessage](../models/errormessage.md)] | :heavy_minus_sign: | N/A | +| `federated_search_rate_limit_error` | *Optional[bool]* | :heavy_minus_sign: | Indicates the federated search results could not be fetched due to rate limiting. | \ No newline at end of file diff --git a/docs/models/gleandataerror.md b/docs/models/gleandataerror.md index f1df02d4..7c4c0d90 100644 --- a/docs/models/gleandataerror.md +++ b/docs/models/gleandataerror.md @@ -3,9 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `bad_gmail_token` | *Optional[bool]* | :heavy_minus_sign: | Indicates the gmail results could not be fetched due to bad token. | -| `bad_outlook_token` | *Optional[bool]* | :heavy_minus_sign: | Indicates the outlook results could not be fetched due to bad token. | -| `invalid_operators` | List[[models.InvalidOperatorValueError](../models/invalidoperatorvalueerror.md)] | :heavy_minus_sign: | Indicates results could not be fetched due to invalid operators in the query. | -| `error_messages` | List[[models.ErrorMessage](../models/errormessage.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| `bad_gmail_token` | *Optional[bool]* | :heavy_minus_sign: | Indicates the gmail results could not be fetched due to bad token. | +| `bad_outlook_token` | *Optional[bool]* | :heavy_minus_sign: | Indicates the outlook results could not be fetched due to bad token. | +| `invalid_operators` | List[[models.InvalidOperatorValueError](../models/invalidoperatorvalueerror.md)] | :heavy_minus_sign: | Indicates results could not be fetched due to invalid operators in the query. | +| `error_messages` | List[[models.ErrorMessage](../models/errormessage.md)] | :heavy_minus_sign: | N/A | +| `federated_search_rate_limit_error` | *Optional[bool]* | :heavy_minus_sign: | Indicates the federated search results could not be fetched due to rate limiting. | \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index a9233390..0907c294 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,7 +1,7 @@ [project] name = "glean-api-client" -version = "0.11.27" +version = "0.11.28" 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 64da52a5..99716d76 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.11.27" +__version__: str = "0.11.28" __openapi_doc_version__: str = "0.9.0" -__gen_version__: str = "2.796.1" -__user_agent__: str = "speakeasy-sdk/python 0.11.27 2.796.1 0.9.0 glean-api-client" +__gen_version__: str = "2.796.4" +__user_agent__: str = "speakeasy-sdk/python 0.11.28 2.796.4 0.9.0 glean-api-client" try: if __package__ is not None: diff --git a/src/glean/api_client/errors/gleandataerror.py b/src/glean/api_client/errors/gleandataerror.py index 978b0be0..754c85de 100644 --- a/src/glean/api_client/errors/gleandataerror.py +++ b/src/glean/api_client/errors/gleandataerror.py @@ -32,6 +32,10 @@ class GleanDataErrorData(BaseModel): Optional[List[models_errormessage.ErrorMessage]], pydantic.Field(alias="errorMessages"), ] = None + federated_search_rate_limit_error: Annotated[ + Optional[bool], pydantic.Field(alias="federatedSearchRateLimitError") + ] = None + r"""Indicates the federated search results could not be fetched due to rate limiting.""" @dataclass(unsafe_hash=True) diff --git a/src/glean/api_client/models/gleandataerror.py b/src/glean/api_client/models/gleandataerror.py index 49567e8d..953126e2 100644 --- a/src/glean/api_client/models/gleandataerror.py +++ b/src/glean/api_client/models/gleandataerror.py @@ -21,6 +21,8 @@ class GleanDataErrorTypedDict(TypedDict): invalid_operators: NotRequired[List[InvalidOperatorValueErrorTypedDict]] r"""Indicates results could not be fetched due to invalid operators in the query.""" error_messages: NotRequired[List[ErrorMessageTypedDict]] + federated_search_rate_limit_error: NotRequired[bool] + r"""Indicates the federated search results could not be fetched due to rate limiting.""" class GleanDataError(BaseModel): @@ -44,10 +46,21 @@ class GleanDataError(BaseModel): Optional[List[ErrorMessage]], pydantic.Field(alias="errorMessages") ] = None + federated_search_rate_limit_error: Annotated[ + Optional[bool], pydantic.Field(alias="federatedSearchRateLimitError") + ] = None + r"""Indicates the federated search results could not be fetched due to rate limiting.""" + @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = set( - ["badGmailToken", "badOutlookToken", "invalidOperators", "errorMessages"] + [ + "badGmailToken", + "badOutlookToken", + "invalidOperators", + "errorMessages", + "federatedSearchRateLimitError", + ] ) serialized = handler(self) m = {} diff --git a/tests/mockserver/internal/sdk/models/components/gleandataerror.go b/tests/mockserver/internal/sdk/models/components/gleandataerror.go index 12eecd2e..d549ead5 100644 --- a/tests/mockserver/internal/sdk/models/components/gleandataerror.go +++ b/tests/mockserver/internal/sdk/models/components/gleandataerror.go @@ -10,6 +10,8 @@ type GleanDataError struct { // Indicates results could not be fetched due to invalid operators in the query. InvalidOperators []InvalidOperatorValueError `json:"invalidOperators,omitempty"` ErrorMessages []ErrorMessage `json:"errorMessages,omitempty"` + // Indicates the federated search results could not be fetched due to rate limiting. + FederatedSearchRateLimitError *bool `json:"federatedSearchRateLimitError,omitempty"` } func (o *GleanDataError) GetBadGmailToken() *bool { @@ -39,3 +41,10 @@ func (o *GleanDataError) GetErrorMessages() []ErrorMessage { } return o.ErrorMessages } + +func (o *GleanDataError) GetFederatedSearchRateLimitError() *bool { + if o == nil { + return nil + } + return o.FederatedSearchRateLimitError +} diff --git a/tests/mockserver/internal/sdk/models/sdkerrors/gleandataerror.go b/tests/mockserver/internal/sdk/models/sdkerrors/gleandataerror.go index 5870c8ac..05af2574 100644 --- a/tests/mockserver/internal/sdk/models/sdkerrors/gleandataerror.go +++ b/tests/mockserver/internal/sdk/models/sdkerrors/gleandataerror.go @@ -15,7 +15,9 @@ type GleanDataError struct { // Indicates results could not be fetched due to invalid operators in the query. InvalidOperators []components.InvalidOperatorValueError `json:"invalidOperators,omitempty"` ErrorMessages []components.ErrorMessage `json:"errorMessages,omitempty"` - HTTPMeta components.HTTPMetadata `json:"-"` + // Indicates the federated search results could not be fetched due to rate limiting. + FederatedSearchRateLimitError *bool `json:"federatedSearchRateLimitError,omitempty"` + HTTPMeta components.HTTPMetadata `json:"-"` } var _ error = &GleanDataError{} diff --git a/tests/test_summarize.py b/tests/test_summarize.py index 63b4eb85..cac8e978 100644 --- a/tests/test_summarize.py +++ b/tests/test_summarize.py @@ -1,6 +1,6 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" -from glean.api_client import Glean +from glean.api_client import Glean, models import os from tests.test_client import create_test_http_client @@ -18,10 +18,12 @@ def test_summarize_summarize(): res = glean.client.documents.summarize( document_specs=[ { - "url": "https://dim-glider.com/", + "ugc_type": models.DocumentSpecUgcType1.SHORTCUTS, + "content_id": 602763, }, { - "id": "", + "ugc_type": models.DocumentSpecUgcType1.SHORTCUTS, + "content_id": 602763, }, ] ) From 6065cac148388e813a13c1e7123b430116aa5f51 Mon Sep 17 00:00:00 2001 From: "speakeasy-github[bot]" <128539517+speakeasy-github[bot]@users.noreply.github.com> Date: Tue, 20 Jan 2026 01:54:50 +0000 Subject: [PATCH 2/2] empty commit to trigger [run-tests] workflow