You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
22
22
These API clients provide type-safe, idiomatic interfaces for working with Glean IndexingAPIs in your language of choice.
description: The server will send a stream of events in server-sent events (SSE) format.
1144
+
description: The server will send a stream of events in server-sent events (SSE) format. If execution fails after the stream has started, the stream may terminate with an error message in a normal `message` event.
1111
1145
example: |
1112
1146
id: 1
1113
1147
event: message
@@ -4675,6 +4709,8 @@ components:
4675
4709
APIToken:
4676
4710
scheme: bearer
4677
4711
type: http
4712
+
description: >-
4713
+
HTTP bearer token. Accepts a Glean-issued API token, an OAuth access token from the Glean OAuth Authorization Server (including Dynamic Client Registration clients), or an OAuth access token issued by an external identity provider. External-IdP OAuth tokens must also include the `X-Glean-Auth-Type: OAUTH` request header. OAuth is supported on the Client API only; the Indexing API requires a Glean-issued token.
4678
4714
schemas:
4679
4715
ActivityEventParams:
4680
4716
properties:
@@ -6019,6 +6055,8 @@ components:
6019
6055
GroupType:
6020
6056
type: string
6021
6057
description: The type of user group
6058
+
x-enumDescriptions:
6059
+
COLLECTION_AUDIENCE: Refers to any viewers of the Collection.
6022
6060
enum:
6023
6061
- DEPARTMENT
6024
6062
- ALL
@@ -6028,6 +6066,9 @@ components:
6028
6066
- LOCATION
6029
6067
- REGION
6030
6068
- EXTERNAL_GROUP
6069
+
- COLLECTION_AUDIENCE
6070
+
x-speakeasy-enum-descriptions:
6071
+
COLLECTION_AUDIENCE: Refers to any viewers of the Collection.
description: When present, indicates this workflow is admin-verified. Set via the dedicated admin settings endpoint, not by regular edits.
9094
+
showOrganizationAsAuthor:
9095
+
type: boolean
9096
+
readOnly: true
9097
+
description: When true, displays organization name instead of author name in agent card. Set via the dedicated admin settings endpoint, not by regular edits.
9098
+
WorkflowResult:
9099
+
type: object
9100
+
required:
9101
+
- workflow
9102
+
properties:
9103
+
workflow:
9104
+
$ref: "#/components/schemas/Workflow"
9105
+
CreateWorkflowResponse:
9106
+
allOf:
9107
+
- $ref: "#/components/schemas/WorkflowResult"
8993
9108
Agent:
8994
9109
title: Agent
8995
9110
type: object
@@ -9042,16 +9157,6 @@ components:
9042
9157
message:
9043
9158
type: string
9044
9159
description: Client-facing error message describing what went wrong
description: This tracks how many times this prompt template was run. If user runs a prompt template after modifying the original one, it still counts as a run for the original template.
11389
-
WorkflowMetadata:
11390
-
allOf:
11391
-
- type: object
11392
-
properties:
11393
-
author:
11394
-
$ref: "#/components/schemas/Person"
11395
-
createTimestamp:
11396
-
type: integer
11397
-
description: Server Unix timestamp of the creation time.
11398
-
lastUpdateTimestamp:
11399
-
type: integer
11400
-
description: Server Unix timestamp of the last update time.
11401
-
lastDraftSavedAt:
11402
-
type: integer
11403
-
description: Server Unix timestamp of the last time the draft was saved.
11404
-
lastDraftSavedBy:
11405
-
description: The person who last saved the draft.
11406
-
$ref: "#/components/schemas/Person"
11407
-
lastDraftGitAuthorId:
11408
-
type: string
11409
-
description: ID of the VCS user (e.g. GitHub username) who last saved the draft. Set only by the draft save path via the external Git integration API.
description: When present, indicates this workflow is admin-verified. Set via the dedicated admin settings endpoint, not by regular edits.
11427
-
showOrganizationAsAuthor:
11428
-
type: boolean
11429
-
readOnly: true
11430
-
description: When true, displays organization name instead of author name in agent card. Set via the dedicated admin settings endpoint, not by regular edits.
11431
-
WorkflowResult:
11432
-
type: object
11433
-
required:
11434
-
- workflow
11435
-
properties:
11436
-
workflow:
11437
-
$ref: "#/components/schemas/Workflow"
11438
11494
UserActivity:
11439
11495
properties:
11440
11496
actor:
@@ -11531,6 +11587,7 @@ components:
11531
11587
- MID_DAY_CATCH_UP
11532
11588
- QUERY_SUGGESTION
11533
11589
- COWORK_CUJ_PROMO
11590
+
- CARD_STACK_PROMO
11534
11591
- WEEKLY_MEETINGS
11535
11592
- FOLLOW_UP
11536
11593
- MILESTONE_TIMELINE_CHECK
@@ -11619,6 +11676,7 @@ components:
11619
11676
- MID_DAY_CATCH_UP
11620
11677
- QUERY_SUGGESTION
11621
11678
- COWORK_CUJ_PROMO
11679
+
- CARD_STACK_PROMO
11622
11680
- WEEKLY_MEETINGS
11623
11681
- FOLLOW_UP
11624
11682
- MILESTONE_TIMELINE_CHECK
@@ -11639,6 +11697,12 @@ components:
11639
11697
rank:
11640
11698
type: integer
11641
11699
description: Rank of the result. Rank is suggested by server. Client side rank may differ.
11700
+
placementReason:
11701
+
type: string
11702
+
enum:
11703
+
- ORGANIC
11704
+
- PROMO
11705
+
description: Placement source for ranked feed results. ORGANIC means the card was emitted by normal feed ranking. PROMO means the card was inserted by the homepage cards promo framework.
11642
11706
FeedResponse:
11643
11707
required:
11644
11708
- serverTimestamp
@@ -14289,7 +14353,12 @@ components:
14289
14353
items:
14290
14354
type: string
14291
14355
description: list of words and phrases to consider as whitelisted content
14292
-
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.
14356
+
regexes:
14357
+
type: array
14358
+
items:
14359
+
type: string
14360
+
description: list of regular expressions whose matches are considered whitelisted content
14361
+
description: Terms and regexes that are allow-listed during the scans. If any finding picked up by a rule exactly matches a term, or matches a regex, in the allow-list, it will not be counted as a violation.
**Inherit from [`GleanError`](./src/main/java/models/errors/GleanError.java)**:
748
-
*[`com.glean.api_client.glean_api_client.models.errors.ErrorResponse`](./src/main/java/models/errors/com.glean.api_client.glean_api_client.models.errors.ErrorResponse.java): Error response returned for failed requests. Applicable to 9 of 129 methods.*
749
-
*[`com.glean.api_client.glean_api_client.models.errors.ErrorInfoResponse`](./src/main/java/models/errors/com.glean.api_client.glean_api_client.models.errors.ErrorInfoResponse.java): Error response for custom metadata operations. Applicable to 5 of 129 methods.*
750
-
*[`com.glean.api_client.glean_api_client.models.errors.CollectionError`](./src/main/java/models/errors/com.glean.api_client.glean_api_client.models.errors.CollectionError.java): Semantic error. Status code `422`. Applicable to 3 of 129 methods.*
751
-
*[`com.glean.api_client.glean_api_client.models.errors.GleanDataError`](./src/main/java/models/errors/com.glean.api_client.glean_api_client.models.errors.GleanDataError.java): Forbidden. Applicable to 2 of 129 methods.*
749
+
*[`com.glean.api_client.glean_api_client.models.errors.ErrorResponse`](./src/main/java/models/errors/com.glean.api_client.glean_api_client.models.errors.ErrorResponse.java): Error response returned for failed requests. Applicable to 9 of 130 methods.*
750
+
*[`com.glean.api_client.glean_api_client.models.errors.ErrorInfoResponse`](./src/main/java/models/errors/com.glean.api_client.glean_api_client.models.errors.ErrorInfoResponse.java): Error response for custom metadata operations. Applicable to 5 of 130 methods.*
751
+
*[`com.glean.api_client.glean_api_client.models.errors.CollectionError`](./src/main/java/models/errors/com.glean.api_client.glean_api_client.models.errors.CollectionError.java): Semantic error. Status code `422`. Applicable to 3 of 130 methods.*
752
+
*[`com.glean.api_client.glean_api_client.models.errors.GleanDataError`](./src/main/java/models/errors/com.glean.api_client.glean_api_client.models.errors.GleanDataError.java): Forbidden. Applicable to 2 of 130 methods.*
0 commit comments