@@ -2,8 +2,8 @@ openapi: 3.0.0
22info:
33 version: "0.9.0"
44 title: Glean API
5- x-source-commit-sha: 750ec3e4db6f2877f191460b47bff807273c68d8
6- x-open-api-commit-sha: 5130487252df59e5fe21a96c4e758609933045da
5+ x-source-commit-sha: 33bf057cf0f948a83126e81582717aebdb622bfa
6+ x-open-api-commit-sha: 4f3a4abf8f003a4edc5522021b22184c76d051ad
77 description: |
88 # Introduction
99 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.
6767 $ref: "#/components/responses/PlatformNotFound"
6868 "408":
6969 $ref: "#/components/responses/PlatformRequestTimeout"
70+ "413":
71+ $ref: "#/components/responses/PlatformRequestTooLarge"
7072 "429":
7173 $ref: "#/components/responses/PlatformTooManyRequests"
7274 "500":
@@ -236,6 +238,8 @@ paths:
236238 $ref: "#/components/responses/PlatformRequestTimeout"
237239 "409":
238240 $ref: "#/components/responses/PlatformConflict"
241+ "413":
242+ $ref: "#/components/responses/PlatformRequestTooLarge"
239243 "429":
240244 $ref: "#/components/responses/PlatformTooManyRequests"
241245 "500":
@@ -282,6 +286,8 @@ paths:
282286 $ref: "#/components/responses/PlatformNotFound"
283287 "408":
284288 $ref: "#/components/responses/PlatformRequestTimeout"
289+ "413":
290+ $ref: "#/components/responses/PlatformRequestTooLarge"
285291 "429":
286292 $ref: "#/components/responses/PlatformTooManyRequests"
287293 "500":
@@ -5078,6 +5084,7 @@ components:
50785084 - resource_not_found
50795085 - method_not_allowed
50805086 - request_timeout
5087+ - request_too_large
50815088 - conflict
50825089 - gone
50835090 - unprocessable_query
@@ -5248,6 +5255,7 @@ components:
52485255 $ref: "#/components/schemas/PlatformMessageRole"
52495256 content:
52505257 type: array
5258+ minItems: 1
52515259 description: Content blocks in the message.
52525260 items:
52535261 $ref: "#/components/schemas/PlatformMessageTextBlock"
@@ -7260,6 +7268,44 @@ components:
72607268 editUrl:
72617269 type: string
72627270 description: The URL using which the user can access the edit page of the shortcut.
7271+ UgcType:
7272+ enum:
7273+ - AGENT_TYPE
7274+ - ANNOUNCEMENTS_TYPE
7275+ - ANSWERS_TYPE
7276+ - CHATS_TYPE
7277+ - COLLECTIONS_TYPE
7278+ - EMAIL_TYPE
7279+ - HTML_CODE_TYPE
7280+ - IMAGE_TYPE
7281+ - MESSAGE_TYPE
7282+ - PAPER_TYPE
7283+ - PRISM_VIEWS_TYPE
7284+ - PROMPT_TEMPLATES_TYPE
7285+ - PINS_TYPE
7286+ - SCRIBES_TYPE
7287+ - SHORTCUTS_TYPE
7288+ - SLIDE_TYPE
7289+ - SPREADSHEET_TYPE
7290+ - INLINE_HTML_TYPE
7291+ - PODCAST_TYPE
7292+ - WORKFLOWS_TYPE
7293+ FavoriteInfo:
7294+ type: object
7295+ properties:
7296+ ugcType:
7297+ $ref: '#/components/schemas/UgcType'
7298+ id:
7299+ type: string
7300+ description: Opaque id of the UGC.
7301+ count:
7302+ type: integer
7303+ description: Number of users this object has been favorited by.
7304+ x-includeEmpty: true
7305+ favoritedByUser:
7306+ type: boolean
7307+ description: If the requesting user has favorited this object.
7308+ x-includeEmpty: true
72637309 Shortcut:
72647310 allOf:
72657311 - $ref: '#/components/schemas/UserGeneratedContentId'
@@ -7279,6 +7325,8 @@ components:
72797325 items:
72807326 $ref: '#/components/schemas/UserRoleSpecification'
72817327 description: A list of user roles for the Go Link.
7328+ favoriteInfo:
7329+ $ref: '#/components/schemas/FavoriteInfo'
72827330 required:
72837331 - inputAlias
72847332 Collection:
@@ -7330,6 +7378,8 @@ components:
73307378 items:
73317379 $ref: '#/components/schemas/UserRoleSpecification'
73327380 description: A list of user roles for the Collection.
7381+ favoriteInfo:
7382+ $ref: '#/components/schemas/FavoriteInfo'
73337383 required:
73347384 - id
73357385 - description
@@ -8144,6 +8194,8 @@ components:
81448194 updateTime:
81458195 type: string
81468196 format: date-time
8197+ favoriteInfo:
8198+ $ref: '#/components/schemas/FavoriteInfo'
81478199 required:
81488200 - documentId
81498201 PersonTeam:
@@ -8969,6 +9021,8 @@ components:
89699021 isPublished:
89709022 type: boolean
89719023 description: Whether or not the announcement is published.
9024+ favoriteInfo:
9025+ $ref: '#/components/schemas/FavoriteInfo'
89729026 DeleteAnnouncementRequest:
89739027 properties:
89749028 id:
@@ -9055,6 +9109,8 @@ components:
90559109 message: Use `answer.trackingToken` instead.
90569110 removal: "2027-01-15"
90579111 x-speakeasy-deprecation-message: "Deprecated on 2026-05-07, removal scheduled for 2027-01-15: Use `answer.trackingToken` instead."
9112+ favoriteInfo:
9113+ $ref: '#/components/schemas/FavoriteInfo'
90589114 required:
90599115 - answer
90609116 GetAnswerError:
@@ -11896,6 +11952,7 @@ components:
1189611952 - ZERO_STATE_WORKFLOW_SUGGESTION
1189711953 - PERSONALIZED_CHAT_SUGGESTION
1189811954 - DAILY_DIGEST
11955+ - PODCAST
1189911956 - TASK
1190011957 - PLAN_MY_DAY
1190111958 - END_MY_DAY
@@ -12239,44 +12296,6 @@ components:
1223912296 items:
1224012297 $ref: '#/components/schemas/UserRoleSpecification'
1224112298 description: A list of roles for this prompt template explicitly granted.
12242- UgcType:
12243- enum:
12244- - AGENT_TYPE
12245- - ANNOUNCEMENTS_TYPE
12246- - ANSWERS_TYPE
12247- - CHATS_TYPE
12248- - COLLECTIONS_TYPE
12249- - EMAIL_TYPE
12250- - HTML_CODE_TYPE
12251- - IMAGE_TYPE
12252- - MESSAGE_TYPE
12253- - PAPER_TYPE
12254- - PRISM_VIEWS_TYPE
12255- - PROMPT_TEMPLATES_TYPE
12256- - PINS_TYPE
12257- - SCRIBES_TYPE
12258- - SHORTCUTS_TYPE
12259- - SLIDE_TYPE
12260- - SPREADSHEET_TYPE
12261- - INLINE_HTML_TYPE
12262- - PODCAST_TYPE
12263- - WORKFLOWS_TYPE
12264- FavoriteInfo:
12265- type: object
12266- properties:
12267- ugcType:
12268- $ref: '#/components/schemas/UgcType'
12269- id:
12270- type: string
12271- description: Opaque id of the UGC.
12272- count:
12273- type: integer
12274- description: Number of users this object has been favorited by.
12275- x-includeEmpty: true
12276- favoritedByUser:
12277- type: boolean
12278- description: If the requesting user has favorited this object.
12279- x-includeEmpty: true
1228012299 PromptTemplateResult:
1228112300 properties:
1228212301 promptTemplate:
@@ -12372,6 +12391,7 @@ components:
1237212391 - ZERO_STATE_AGENT_SUGGESTION
1237312392 - PERSONALIZED_CHAT_SUGGESTION
1237412393 - DAILY_DIGEST
12394+ - PODCAST
1237512395 - TASK
1237612396 - PLAN_MY_DAY
1237712397 - END_MY_DAY
@@ -12464,6 +12484,7 @@ components:
1246412484 - ZERO_STATE_WORKFLOW_SUGGESTION
1246512485 - PERSONALIZED_CHAT_SUGGESTION
1246612486 - DAILY_DIGEST
12487+ - PODCAST
1246712488 - TASK
1246812489 - PLAN_MY_DAY
1246912490 - END_MY_DAY
@@ -15756,6 +15777,12 @@ components:
1575615777 application/problem+json:
1575715778 schema:
1575815779 $ref: "#/components/schemas/PlatformProblemDetail"
15780+ PlatformRequestTooLarge:
15781+ description: Request body exceeds the maximum allowed size.
15782+ content:
15783+ application/problem+json:
15784+ schema:
15785+ $ref: "#/components/schemas/PlatformProblemDetail"
1575915786 PlatformTooManyRequests:
1576015787 description: Rate limit exceeded. Includes Retry-After header.
1576115788 content:
0 commit comments