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
{{ message }}
Repository navigation
Commit 9b8e4f6
Browse filesBrowse the repository at this point in the historyBrowse files
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.
@@ -2575,7 +2575,7 @@ paths:
2575
2575
- Departments
2576
2576
summary: List departments
2577
2577
description: |
2578
-
List the departments in the Glean directory, ordered by display_name and then by department_id. The list includes every department that at least one user belongs to or that a usage limit names, so a caller can show the name of a department that a usage limit still names after its users leave it. Department names are exact, so names that differ only by case are different departments.
2578
+
List the departments in the Glean directory, ordered by display_name and then by department_id. The list includes every department that at least one user belongs to or that a usage limit names, so a caller can show the name of a department that a usage limit still names after its users leave it. Department names are exact, so names that differ only by case are different departments. Send a name filter to return only the departments whose display_name contains a value.
2579
2579
operationId: platform-departments-list
2580
2580
x-glean-scopes:
2581
2581
legacy:
@@ -2598,11 +2598,34 @@ paths:
2598
2598
default: 50
2599
2599
- in: query
2600
2600
name: cursor
2601
-
description: Opaque pagination cursor from a previous response.
2601
+
description: |
2602
+
Opaque pagination cursor from a previous response. Send the same filters that the previous request used.
2602
2603
required: false
2603
2604
schema:
2604
2605
type: string
2605
2606
minLength: 1
2607
+
- in: query
2608
+
name: filters
2609
+
description: |
2610
+
JSON-encoded filters that choose which departments are returned. The only supported field is name, with the operator EQUALS. Multiple values OR within a filter. The field may appear in only one filter. A value that matches no department returns no departments rather than an error.
2611
+
required: false
2612
+
content:
2613
+
application/json:
2614
+
schema:
2615
+
type: array
2616
+
minItems: 1
2617
+
maxItems: 10
2618
+
description: Filters on department fields, combined with AND.
summary: Departments whose display name contains "engineering"
2625
+
value:
2626
+
- field: name
2627
+
values:
2628
+
- engineering
2606
2629
responses:
2607
2630
"200":
2608
2631
description: Successful response.
@@ -12553,6 +12576,36 @@ components:
12553
12576
request_id:
12554
12577
type: string
12555
12578
description: Request identifier for correlating this response.
12579
+
PlatformDepartmentFilter:
12580
+
type: object
12581
+
additionalProperties: false
12582
+
required:
12583
+
- field
12584
+
- values
12585
+
description: A filter on one department field.
12586
+
properties:
12587
+
field:
12588
+
type: string
12589
+
pattern: ^name$
12590
+
description: |
12591
+
The department field to filter on. The only supported field is name, which matches departments whose display_name contains the value, ignoring case and surrounding whitespace. Each value is at most 256 characters. To find the department with an exact name, such as a department_name from a usage limit response, filter by the name and compare display_name exactly.
12592
+
values:
12593
+
type: array
12594
+
minItems: 1
12595
+
maxItems: 100
12596
+
description: The values to match. A department matches when any value matches.
12597
+
items:
12598
+
type: string
12599
+
minLength: 1
12600
+
description: A value to match. Blank values are rejected.
description: The only supported operator is EQUALS. Defaults to EQUALS.
12556
12609
PlatformDepartmentReference:
12557
12610
type: object
12558
12611
description: A reference to a department in the Glean directory.
@@ -18809,6 +18862,10 @@ components:
18809
18862
- type
18810
18863
title: Content
18811
18864
description: The content of the message.
18865
+
messageTrackingToken:
18866
+
type: string
18867
+
description: 'An opaque token that represents this particular agent message. Populated only on `GLEAN_AI` messages in responses. To record feedback, pass the token of the message being rated (typically the final `GLEAN_AI` message of the run) as the single entry in `trackingTokens` to `/feedback`, with `category: CHAT`.'
0 commit comments