Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 37 additions & 40 deletions .speakeasy/gen.lock

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion .speakeasy/gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ generation:
maintainOpenAPIOrder: true
usageSnippets:
optionalPropertyRendering: withExample
sdkInitStyle: constructor
useClassNamesForArrayFields: true
fixes:
nameResolutionDec2023: true
Expand All @@ -16,7 +17,7 @@ generation:
oAuth2ClientCredentialsEnabled: true
oAuth2PasswordEnabled: true
java:
version: 0.4.4
version: 0.5.0
additionalDependencies: []
additionalPlugins: []
artifactID: glean-api-client
Expand Down
37 changes: 20 additions & 17 deletions .speakeasy/glean-merged-spec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@ openapi: 3.0.0
info:
version: 0.9.0
title: Glean API
contact:
email: support@glean.com
description: |
# Introduction
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.
Expand All @@ -23,7 +21,7 @@ info:
These API clients provide type-safe, idiomatic interfaces for working with Glean IndexingAPIs in your language of choice.
x-logo:
url: https://app.glean.com/images/glean-text2.svg
x-speakeasy-name: "Glean API"
x-speakeasy-name: 'Glean API'
servers:
- url: https://{instance}-be.glean.com
variables:
Expand Down Expand Up @@ -414,7 +412,7 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/ChatResponse"
$ref: '#/components/schemas/ChatResponse'
examples:
defaultExample:
value:
Expand Down Expand Up @@ -477,10 +475,10 @@ paths:
agent: DEFAULT
mode: DEFAULT
fragments:
- text: "**Reading:**"
- text: '**Reading:**'
- structuredResults:
- document:
id: "123"
id: '123'
title: Company Handbook
citationResponse:
value:
Expand All @@ -492,7 +490,7 @@ paths:
mode: DEFAULT
citations:
- sourceDocument:
id: "123"
id: '123'
title: Company Handbook
referenceRanges:
- textRange:
Expand Down Expand Up @@ -3179,7 +3177,7 @@ paths:
/rest/api/v1/governance/data/policies/{id}:
get:
description: Fetches the specified policy version, or the latest if no version is provided.
summary: Gets specified Policy.
summary: Gets specified policy
operationId: getpolicy
x-visibility: Public
tags:
Expand Down Expand Up @@ -3213,7 +3211,7 @@ paths:
x-speakeasy-name-override: retrieve
post:
description: Updates an existing policy.
summary: Updates an existing policy.
summary: Updates an existing policy
operationId: updatepolicy
tags:
- Governance
Expand Down Expand Up @@ -3246,7 +3244,7 @@ paths:
/rest/api/v1/governance/data/policies:
get:
description: Lists policies with filtering.
summary: Lists policies.
summary: Lists policies
operationId: listpolicies
x-visibility: Public
tags:
Expand Down Expand Up @@ -3279,7 +3277,7 @@ paths:
x-speakeasy-name-override: list
post:
description: Creates a new policy with specified specifications and returns its id.
summary: Creates new policy.
summary: Creates new policy
operationId: createpolicy
x-visibility: Public
tags:
Expand All @@ -3306,7 +3304,7 @@ paths:
/rest/api/v1/governance/data/policies/{id}/download:
get:
description: Downloads CSV violations report for a specific policy id. This does not support continuous policies.
summary: Downloads violations CSV for policy.
summary: Downloads violations CSV for policy
operationId: downloadpolicycsv
x-visibility: Public
tags:
Expand Down Expand Up @@ -3335,7 +3333,7 @@ paths:
/rest/api/v1/governance/data/reports:
post:
description: Creates a new one-time report and executes its batch job.
summary: Creates new one-time report.
summary: Creates new one-time report
operationId: createreport
x-visibility: Public
tags:
Expand All @@ -3362,7 +3360,7 @@ paths:
/rest/api/v1/governance/data/reports/{id}/download:
get:
description: Downloads CSV violations report for a specific report id.
summary: Downloads violations CSV for report.
summary: Downloads violations CSV for report
operationId: downloadreportcsv
x-visibility: Public
tags:
Expand Down Expand Up @@ -3391,7 +3389,7 @@ paths:
/rest/api/v1/governance/data/reports/{id}/status:
get:
description: Fetches the status of the run corresponding to the report-id.
summary: Fetches report run status.
summary: Fetches report run status
operationId: getreportstatus
x-visibility: Public
tags:
Expand Down Expand Up @@ -3419,7 +3417,7 @@ paths:
/rest/api/v1/governance/documents/visibilityoverrides:
get:
description: Fetches the visibility override status of the documents passed.
summary: Fetches documents visibility.
summary: Fetches documents visibility
operationId: getdocvisibility
x-visibility: Public
tags:
Expand Down Expand Up @@ -3447,7 +3445,7 @@ paths:
x-speakeasy-name-override: list
post:
description: Sets the visibility-override state of the documents specified, effectively hiding or un-hiding documents.
summary: Hide/Un-hide docs.
summary: Hide or unhide docs
operationId: setdocvisibility
x-visibility: Public
tags:
Expand Down Expand Up @@ -7244,6 +7242,9 @@ components:
type: integer
description: Timeout in milliseconds for the request. A `408` error will be returned if handling the request takes longer.
example: 30000
sessionInfo:
description: Optional object for tracking the session used by the client and for debugging purposes.
$ref: "#/components/schemas/SessionInfo"
applicationId:
type: string
description: The ID of the application this request originates from, used to determine the configuration of underlying chat processes. This should correspond to the ID set during admin setup. If not specified, the default chat experience will be used.
Expand Down Expand Up @@ -7510,6 +7511,8 @@ components:
AgentRunCreate:
description: Payload for creating a run.
type: object
required:
- agent_id
properties:
agent_id:
type: string
Expand Down
14 changes: 7 additions & 7 deletions .speakeasy/workflow.lock
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
speakeasyVersion: 1.551.0
speakeasyVersion: 1.555.2
sources:
Glean API:
sourceNamespace: glean-api-specs
sourceRevisionDigest: sha256:54c0b7f53a738ea4d896b6041514ca6308f8fad84fb2ce9ca39e5c4cb5f52afc
sourceBlobDigest: sha256:e03e7548ba6cb180d1f94e0a3912501f47f1f9944c0631dd752b396e56513f1f
sourceRevisionDigest: sha256:8fa342ea4c0f50e32d7b0930df581e4f4ec000f1f36a429c40f6ccc3f72c0b6b
sourceBlobDigest: sha256:914ea4a50d56c4ac1ef7a111f11756bfd8c21bd1c652b817b729ca8706a0afc7
tags:
- latest
- speakeasy-sdk-regen-1748051799
- speakeasy-sdk-regen-1748397732
Glean-OAS:
sourceNamespace: glean-oas
sourceRevisionDigest: sha256:8841834dd58ddd4e2dcf98fc90fbd06fbf3626a29df941503cce55b9548a5317
Expand All @@ -18,10 +18,10 @@ targets:
glean:
source: Glean API
sourceNamespace: glean-api-specs
sourceRevisionDigest: sha256:54c0b7f53a738ea4d896b6041514ca6308f8fad84fb2ce9ca39e5c4cb5f52afc
sourceBlobDigest: sha256:e03e7548ba6cb180d1f94e0a3912501f47f1f9944c0631dd752b396e56513f1f
sourceRevisionDigest: sha256:8fa342ea4c0f50e32d7b0930df581e4f4ec000f1f36a429c40f6ccc3f72c0b6b
sourceBlobDigest: sha256:914ea4a50d56c4ac1ef7a111f11756bfd8c21bd1c652b817b729ca8706a0afc7
codeSamplesNamespace: glean-api-specs-java-code-samples
codeSamplesRevisionDigest: sha256:cdad980eaff34947a515e5c323f3f725f6f885ccb27292f152c4f37f34ad741c
codeSamplesRevisionDigest: sha256:25e0dc06c9cfa9a9001c39331f30c0600f04aad5dc0009e5adc6664a36a48716
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
Expand Down
37 changes: 15 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,15 +62,15 @@ The samples below show how a published SDK artifact is used:

Gradle:
```groovy
implementation 'com.glean.api-client:glean-api-client:0.4.4'
implementation 'com.glean.api-client:glean-api-client:0.5.0'
```

Maven:
```xml
<dependency>
<groupId>com.glean.api-client</groupId>
<artifactId>glean-api-client</artifactId>
<version>0.4.4</version>
<version>0.5.0</version>
</dependency>
```

Expand Down Expand Up @@ -199,9 +199,9 @@ public class Application {

This SDK supports the following security scheme globally:

| Name | Type | Scheme |
| ---------- | ---- | ----------- |
| `apiToken` | http | HTTP Bearer |
| Name | Type | Scheme | Environment Variable |
| ---------- | ---- | ----------- | -------------------- |
| `apiToken` | http | HTTP Bearer | `GLEAN_API_TOKEN` |

To authenticate with the API the `apiToken` parameter must be set when initializing the SDK client instance. For example:
```java
Expand Down Expand Up @@ -363,31 +363,24 @@ For more information on obtaining the appropriate token type, please contact you
* [list](docs/sdks/entities/README.md#list) - List entities
* [readPeople](docs/sdks/entities/README.md#readpeople) - Read people


#### [client().governance().data()](docs/sdks/data/README.md)


#### [client().governance().data().policies()](docs/sdks/policies/README.md)

* [retrieve](docs/sdks/policies/README.md#retrieve) - Gets specified Policy.
* [update](docs/sdks/policies/README.md#update) - Updates an existing policy.
* [list](docs/sdks/policies/README.md#list) - Lists policies.
* [create](docs/sdks/policies/README.md#create) - Creates new policy.
* [download](docs/sdks/policies/README.md#download) - Downloads violations CSV for policy.
* [retrieve](docs/sdks/policies/README.md#retrieve) - Gets specified policy
* [update](docs/sdks/policies/README.md#update) - Updates an existing policy
* [list](docs/sdks/policies/README.md#list) - Lists policies
* [create](docs/sdks/policies/README.md#create) - Creates new policy
* [download](docs/sdks/policies/README.md#download) - Downloads violations CSV for policy

#### [client().governance().data().reports()](docs/sdks/reports/README.md)

* [create](docs/sdks/reports/README.md#create) - Creates new one-time report.
* [download](docs/sdks/reports/README.md#download) - Downloads violations CSV for report.
* [status](docs/sdks/reports/README.md#status) - Fetches report run status.

#### [client().governance().documents()](docs/sdks/governancedocuments/README.md)

* [create](docs/sdks/reports/README.md#create) - Creates new one-time report
* [download](docs/sdks/reports/README.md#download) - Downloads violations CSV for report
* [status](docs/sdks/reports/README.md#status) - Fetches report run status

#### [client().governance().documents().visibilityoverrides()](docs/sdks/visibilityoverrides/README.md)

* [list](docs/sdks/visibilityoverrides/README.md#list) - Fetches documents visibility.
* [create](docs/sdks/visibilityoverrides/README.md#create) - Hide/Un-hide docs.
* [list](docs/sdks/visibilityoverrides/README.md#list) - Fetches documents visibility
* [create](docs/sdks/visibilityoverrides/README.md#create) - Hide or unhide docs

#### [client().insights()](docs/sdks/insights/README.md)

Expand Down
12 changes: 11 additions & 1 deletion RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,4 +88,14 @@ Based on:
### Generated
- [java v0.4.4] .
### Releases
- [Maven Central v0.4.4] https://central.sonatype.com/artifact/com.glean.api-client/glean-api-client/0.4.4 - .
- [Maven Central v0.4.4] https://central.sonatype.com/artifact/com.glean.api-client/glean-api-client/0.4.4 - .

## 2025-06-03 23:28:09
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.555.2 (2.620.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [java v0.5.0] .
### Releases
- [Maven Central v0.5.0] https://central.sonatype.com/artifact/com.glean.api-client/glean-api-client/0.5.0 - .
2 changes: 1 addition & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ publishing {
// https://github.com/gradle/gradle/issues/18619
groupId = "com.glean.api-client"
artifactId = "glean-api-client"
version = "0.4.4"
version = "0.5.0"

from components.java

Expand Down
2 changes: 1 addition & 1 deletion docs/models/components/AgentRun.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Payload for creating a run.

| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| `agentId` | *Optional\<String>* | :heavy_minus_sign: | The ID of the agent to run. |
| `agentId` | *String* | :heavy_check_mark: | The ID of the agent to run. |
| `input` | Map\<String, *Object*> | :heavy_minus_sign: | The input to the agent. |
| `messages` | List\<[Message](../../models/components/Message.md)> | :heavy_minus_sign: | The messages to pass an input to the agent. |
| `status` | [Optional\<AgentExecutionStatus>](../../models/components/AgentExecutionStatus.md) | :heavy_minus_sign: | The status of the run. One of 'error', 'success'. |
2 changes: 1 addition & 1 deletion docs/models/components/AgentRunCreate.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ Payload for creating a run.

| Field | Type | Required | Description |
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
| `agentId` | *Optional\<String>* | :heavy_minus_sign: | The ID of the agent to run. |
| `agentId` | *String* | :heavy_check_mark: | The ID of the agent to run. |
| `input` | Map\<String, *Object*> | :heavy_minus_sign: | The input to the agent. |
| `messages` | List\<[Message](../../models/components/Message.md)> | :heavy_minus_sign: | The messages to pass an input to the agent. |
Loading