@@ -2,7 +2,7 @@ openapi: 3.0.0
22info:
33 version: 0.9.0
44 title: Glean API
5- x-source-commit-sha: 1c30a2e9466bf278374bd82863042433f7fa8a6d
5+ x-source-commit-sha: 84fda7e37dc3dd8a90598b2da20c5366022bfed3
66 description: |
77 # Introduction
88 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.
2222 These API clients provide type-safe, idiomatic interfaces for working with Glean IndexingAPIs in your language of choice.
2323 x-logo:
2424 url: https://app.glean.com/images/glean-text2.svg
25- x-open-api-commit-sha: bfa098a27c3b8f11087766de34606765c946e305
25+ x-open-api-commit-sha: 05bc888a97be42c619bb50ed437f510fc0eae09b
2626 x-speakeasy-name: 'Glean API'
2727servers:
2828 - url: https://{instance}-be.glean.com
@@ -3200,6 +3200,40 @@ paths:
32003200 description: Conflict
32013201 x-speakeasy-name-override: upload
32023202 x-speakeasy-group: indexing.shortcuts
3203+ /api/index/v1/document/{docId}/custom-metadata/{groupName}:
3204+ servers:
3205+ - url: https://{domain}-be.glean.com/rest/api/index
3206+ variables:
3207+ domain:
3208+ default: domain
3209+ description: Email domain (without extension) that determines the deployment backend.
3210+ parameters:
3211+ - name: docId
3212+ in: path
3213+ description: Unique Glean identifier of the document
3214+ required: true
3215+ schema:
3216+ type: string
3217+ - name: groupName
3218+ in: path
3219+ description: Name of the metadata group as specified while adding schema
3220+ required: true
3221+ schema:
3222+ type: string
3223+ /api/index/v1/custom-metadata/schema/{groupName}:
3224+ servers:
3225+ - url: https://{domain}-be.glean.com/rest/api/index
3226+ variables:
3227+ domain:
3228+ default: domain
3229+ description: Email domain (without extension) that determines the deployment backend.
3230+ parameters:
3231+ - name: groupName
3232+ in: path
3233+ description: Name of the metadata group schema
3234+ required: true
3235+ schema:
3236+ type: string
32033237 /rest/api/v1/governance/data/policies/{id}:
32043238 get:
32053239 description: Fetches the specified policy version, or the latest if no version is provided.
@@ -12092,6 +12126,48 @@ components:
1209212126 description: List of lifecycle events corresponding to the document
1209312127 items:
1209412128 $ref: "#/components/schemas/LifeCycleEvent"
12129+ CustomMetadataPutRequest:
12130+ type: object
12131+ description: Request body for adding or updating custom metadata on a document
12132+ properties:
12133+ customMetadata:
12134+ type: array
12135+ description: Array of custom metadata key-value pairs
12136+ items:
12137+ $ref: "#/components/schemas/CustomProperty"
12138+ required:
12139+ - customMetadata
12140+ CustomMetadataSchema:
12141+ type: object
12142+ description: Schema for custom metadata containing metadata key definitions
12143+ properties:
12144+ metadataKeys:
12145+ type: array
12146+ description: Array of metadata key definitions
12147+ items:
12148+ $ref: "#/components/schemas/PropertyDefinition"
12149+ required:
12150+ - metadataKeys
12151+ SuccessResponse:
12152+ type: object
12153+ description: Success response for custom metadata operations
12154+ properties:
12155+ success:
12156+ type: boolean
12157+ description: Indicates if the operation was successful
12158+ default: true
12159+ ErrorInfoResponse:
12160+ type: object
12161+ description: Error response for custom metadata operations
12162+ properties:
12163+ error:
12164+ type: string
12165+ description: Error message describing what went wrong
12166+ message:
12167+ type: string
12168+ description: Additional details about the error
12169+ required:
12170+ - error
1209512171 PropertyDefinition:
1209612172 properties:
1209712173 name:
@@ -12869,6 +12945,43 @@ components:
1286912945 description: The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC.
1287012946 schema:
1287112947 type: integer
12948+ responses:
12949+ SuccessResponse:
12950+ description: OK
12951+ content:
12952+ application/json:
12953+ schema:
12954+ $ref: "#/components/schemas/SuccessResponse"
12955+ BadRequestError:
12956+ description: Bad Request
12957+ content:
12958+ application/json:
12959+ schema:
12960+ $ref: "#/components/schemas/ErrorInfoResponse"
12961+ UnauthorizedError:
12962+ description: Not Authorized
12963+ content:
12964+ application/json:
12965+ schema:
12966+ $ref: "#/components/schemas/ErrorInfoResponse"
12967+ NotFoundError:
12968+ description: Not Found
12969+ content:
12970+ application/json:
12971+ schema:
12972+ $ref: "#/components/schemas/ErrorInfoResponse"
12973+ TooManyRequestsError:
12974+ description: Too Many Requests
12975+ content:
12976+ application/json:
12977+ schema:
12978+ $ref: "#/components/schemas/ErrorInfoResponse"
12979+ InternalServerError:
12980+ description: Internal Server Error
12981+ content:
12982+ application/json:
12983+ schema:
12984+ $ref: "#/components/schemas/ErrorInfoResponse"
1287212985x-tagGroups:
1287312986 - name: Search & Generative AI
1287412987 tags:
0 commit comments