Skip to content

Commit f81902d

Browse files
authored
detailed out the spec differences (#10)
1 parent eb3aee5 commit f81902d

2 files changed

Lines changed: 14 additions & 0 deletions

File tree

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ glean_code/__pycache__/
77
git/
88

99
# Build output (zipapp staging dir and the .pyz artifact)
10+
# .noindex suffix keeps macOS Spotlight from indexing the artifact
1011
build/
12+
build.noindex/
1113

1214
# Never commit secrets (tokens may match GLEAN_* or glean_tok_* patterns)
1315
.env

‎incompat_report.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,18 @@ Diffed the client against Glean's published OpenAPI specifications rather than d
1010
-`https://gleanwork.github.io/open-api/specs/final/client_rest.yaml`
1111
-`https://gleanwork.github.io/open-api/specs/final/indexing.yaml`
1212

13+
**Spec version diffed against:**
14+
15+
| Field | Value |
16+
| --- | --- |
17+
|`info.version`|**0.9.0** (identical in both specs) |
18+
|`openapi`| 3.0.0 |
19+
|`x-source-commit-sha`|`b923d85b9eec5decd44211937ba04c915306821a`|
20+
| Verified current | 2026-08-16 — re-fetched and byte-identical to the copy diffed |
21+
22+
The same 0.9.0 contract is what the official `glean-api-client` SDK is generated from, so
23+
every finding below applies to the SDK surface as well.
24+
1325
Both specs were parsed and every path, HTTP method, and required request field was compared to what the client actually sends. The notable findings were independently confirmed against the developer portal (`developers.glean.com/api/client-api/*/overview`).
1426

1527
## Summary

0 commit comments

Comments
 (0)