Skip to content

Commit fa031be

Browse files
Updating README.md
1 parent 8c863fa commit fa031be

File tree

1 file changed

+1
-12
lines changed

1 file changed

+1
-12
lines changed

README.md

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,9 @@
11
# Glean TypeScript API Client
22

3-
<!-- no [summary] -->
3+
<!-- No Summary [summary] -->
44

55
The Glean TypeScript SDK provides convenient access to the Glean REST API in both browser and Node.js environments. It offers full TypeScript types, modern async/await support, and uses the [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) API under the hood.
66

7-
<!-- Start Summary [summary] -->
8-
## Summary
9-
10-
Glean API: # Introduction
11-
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.
12-
13-
# Usage guidelines
14-
This API is evolving fast. Glean will provide advance notice of any planned backwards incompatible changes along
15-
with a 6-month sunset period for anything that requires developers to adopt the new versions.
16-
<!-- End Summary [summary] -->
17-
187
<!-- Start Table of Contents [toc] -->
198
## Table of Contents
209
<!-- $toc-max-depth=2 -->

0 commit comments

Comments
 (0)