Skip to content

feat(api): generate and migrate Dataset REST resources#703

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Abhijeet Prasad (AbhiPrasad) merged 1 commit into from
Aug 19, 2026
Merged

feat(api): generate and migrate Dataset REST resources #703

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
46 changes: 25 additions & 21 deletions openapi/README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,46 @@
# Pinned Braintrust OpenAPI specification

`spec.json` is a committed snapshot of the public specification from
`spec.json` is a committed snapshot of
[`braintrustdata/braintrust-openapi`](https://github.com/braintrustdata/braintrust-openapi).
`config.json` pins the full upstream commit, snapshot SHA-256, generator tools, generator flags, and
selected endpoint tags. The generator scripts live in `py/scripts/`. Builds and package installation
use the committed generated source and never fetch or run code generation.
`config.json` pins the upstream commit, snapshot hash, generator versions and flags, selected endpoint
tags, and retry-policy allowlists. Builds use committed generated source and never fetch the spec or
run code generation.

From `py/`, validate and regenerate the private models offline with:
## Generate and check

Run from `py/`:

```bash
make generate-api-client
make check-api-client-codegen
```

The check regenerates into a temporary directory and does not modify the worktree. Endpoint bindings
are rolled out explicitly through `endpoint_generator.generated_tags`. The current rollout supports
the Projects and Experiments tags and emits one operation registry/resource class per tag. Reachable
models used by one resource live in that resource's model module; models shared by multiple resources
live once in `models/common.py` and are imported explicitly. Unreachable models are omitted. Public
resource method and inline response type names are derived mechanically from each `operationId`, and
generated methods forward request fields and parameters without implicit defaults. Logical POST reads
that are safe to retry are listed in `endpoint_generator.safe_reads`, while verified idempotent writes
are listed in `endpoint_generator.idempotent_writes`; GET/HEAD reads and all other writes use
mechanical retry defaults.
The check regenerates in a temporary directory and reports drift without changing the worktree.
Currently selected tags are Projects, Experiments, and Datasets. Each tag produces one resource and
operation registry. Models used by one resource stay in that resource's model module; shared models
live in `models/common.py`; unreachable models are omitted.

Method and inline-response names come directly from normalized OpenAPI `operationId` values. Generated
models preserve exact wire keys, including leading underscores, and methods do not add implicit request
defaults. GET and HEAD operations use the safe-read retry policy.
Logical POST reads and verified idempotent writes must be listed explicitly in `safe_reads` and
`idempotent_writes`; all other writes are non-retrying.

## Refresh the snapshot

To fetch the configured upstream commit explicitly:
Fetch the configured upstream commit:

```bash
make fetch-openapi-spec
```

For an existing local checkout, set `BRAINTRUST_OPENAPI_ROOT` to its root. The checkout must be at the
commit pinned in `config.json`, and its specification must have the pinned hash:
To fetch from a local checkout instead:

```bash
BRAINTRUST_OPENAPI_ROOT=../../braintrust-openapi make fetch-openapi-spec
```

To update the snapshot, first update the commit and SHA-256 in `config.json`, then fetch, regenerate,
and review both the upstream spec diff and generated model diff. Only operations selected through
`endpoint_generator.generated_tags` and their reachable schemas are validated and generated.
The checkout must be at the commit pinned in `config.json`, and its spec must match the pinned hash.
To update the snapshot, update the commit and hash in `config.json`, fetch, regenerate, and review both
the upstream spec diff and generated-source diff. Validation and generation apply only to selected tags
and their transitively reachable schemas.
9 changes: 6 additions & 3 deletions openapi/config.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,13 +31,16 @@
"schema_version": 1,
"generated_tags": [
"Projects",
"Experiments"
"Experiments",
"Datasets"
],
"safe_reads": [
"postExperimentIdFetch"
"postExperimentIdFetch",
"postDatasetIdFetch"
],
"idempotent_writes": [
"postProject"
"postProject",
"postDataset"
],
"supported_success_statuses": [
"200",
Expand Down
22 changes: 22 additions & 0 deletions py/scripts/openapi_codegen.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -508,9 +508,30 @@ def _prune_empty_directories(root: Path) -> None:
shutil.rmtree(directory)


def _leading_underscore_field_aliases(value: Any) -> Dict[str, str]:
aliases: Dict[str, str] = {}

def visit(node: Any) -> None:
if isinstance(node, dict):
properties = node.get("properties")
if isinstance(properties, dict):
for name in properties:
if isinstance(name, str) and name.startswith("_") and name.isidentifier():
aliases[name] = name
for child in node.values():
visit(child)
elif isinstance(node, list):
for child in node:
visit(child)

visit(value)
return dict(sorted(aliases.items()))


def _generate_models(spec_path: Path, output_path: Path, config: Mapping[str, Any]) -> None:
output_path.parent.mkdir(parents=True, exist_ok=True)
header = _generated_header(config, "CONTENT_HASH_PLACEHOLDER").rstrip()
aliases = _leading_underscore_field_aliases(json.loads(spec_path.read_text(encoding="utf-8")))
command = [
sys.executable,
"-m",
Expand All@@ -520,6 +541,7 @@ def _generate_models(spec_path: Path, output_path: Path, config: Mapping[str, An
"--output",
str(output_path),
*_model_flags(config),
*(["--aliases", json.dumps(aliases, sort_keys=True)] if aliases else []),
"--custom-file-header",
header,
]
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
feat(api): generate and migrate Dataset REST resources by AbhiPrasad · Pull Request #703 · braintrustdata/braintrust-sdk-python · GitHub
Skip to content
feat(api): generate and migrate Dataset REST resources#703

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Abhijeet Prasad (AbhiPrasad)
merged 1 commit into

from

Aug 19, 2026
 Merged


feat(api): generate and migrate Dataset REST resources
#703
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


46 changes: 25 additions & 21 deletions
openapi/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,42 +1,46 @@
# Pinned Braintrust OpenAPI specification

`spec.json` is a committed snapshot of the public specification from
`spec.json` is a committed snapshot of
[`braintrustdata/braintrust-openapi`](https://github.com/braintrustdata/braintrust-openapi).
`config.json` pins the full upstream commit, snapshot SHA-256, generator tools, generator flags, and
selected endpoint tags. The generator scripts live in `py/scripts/`. Builds and package installation
use the committed generated source and never fetch or run code generation.
`config.json` pins the upstream commit, snapshot hash, generator versions and flags, selected endpoint
tags, and retry-policy allowlists. Builds use committed generated source and never fetch the spec or
run code generation.

From `py/`, validate and regenerate the private models offline with:
## Generate and check

Run from `py/`:

```bash
make generate-api-client
make check-api-client-codegen
```

The check regenerates into a temporary directory and does not modify the worktree. Endpoint bindings
are rolled out explicitly through `endpoint_generator.generated_tags`. The current rollout supports
the Projects and Experiments tags and emits one operation registry/resource class per tag. Reachable
models used by one resource live in that resource's model module; models shared by multiple resources
live once in `models/common.py` and are imported explicitly. Unreachable models are omitted. Public
resource method and inline response type names are derived mechanically from each `operationId`, and
generated methods forward request fields and parameters without implicit defaults. Logical POST reads
that are safe to retry are listed in `endpoint_generator.safe_reads`, while verified idempotent writes
are listed in `endpoint_generator.idempotent_writes`; GET/HEAD reads and all other writes use
mechanical retry defaults.
The check regenerates in a temporary directory and reports drift without changing the worktree.
Currently selected tags are Projects, Experiments, and Datasets. Each tag produces one resource and
operation registry. Models used by one resource stay in that resource's model module; shared models
live in `models/common.py`; unreachable models are omitted.

Method and inline-response names come directly from normalized OpenAPI `operationId` values. Generated
models preserve exact wire keys, including leading underscores, and methods do not add implicit request
defaults. GET and HEAD operations use the safe-read retry policy.
Logical POST reads and verified idempotent writes must be listed explicitly in `safe_reads` and
`idempotent_writes`; all other writes are non-retrying.

## Refresh the snapshot

To fetch the configured upstream commit explicitly:
Fetch the configured upstream commit:

```bash
make fetch-openapi-spec
```

For an existing local checkout, set `BRAINTRUST_OPENAPI_ROOT` to its root. The checkout must be at the
commit pinned in `config.json`, and its specification must have the pinned hash:
To fetch from a local checkout instead:

```bash
BRAINTRUST_OPENAPI_ROOT=../../braintrust-openapi make fetch-openapi-spec
```

To update the snapshot, first update the commit and SHA-256 in `config.json`, then fetch, regenerate,
and review both the upstream spec diff and generated model diff. Only operations selected through
`endpoint_generator.generated_tags` and their reachable schemas are validated and generated.
The checkout must be at the commit pinned in `config.json`, and its spec must match the pinned hash.
To update the snapshot, update the commit and hash in `config.json`, fetch, regenerate, and review both
the upstream spec diff and generated-source diff. Validation and generation apply only to selected tags
and their transitively reachable schemas.

9 changes: 6 additions & 3 deletions
openapi/config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,13 +31,16 @@
 "schema_version": 1,
 "generated_tags": [
 "Projects",
 "Experiments"
 "Experiments",
 "Datasets"
 ],
 "safe_reads": [
 "postExperimentIdFetch"
 "postExperimentIdFetch",
 "postDatasetIdFetch"
 ],
 "idempotent_writes": [
 "postProject"
 "postProject",
 "postDataset"
 ],
 "supported_success_statuses": [
 "200",
Expand Down

22 changes: 22 additions & 0 deletions
py/scripts/openapi_codegen.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -508,9 +508,30 @@ def _prune_empty_directories(root: Path) -> None:
 shutil.rmtree(directory)


def _leading_underscore_field_aliases(value: Any) -> Dict[str, str]:
 aliases: Dict[str, str] = {}

 def visit(node: Any) -> None:
 if isinstance(node, dict):
 properties = node.get("properties")
 if isinstance(properties, dict):
 for name in properties:
 if isinstance(name, str) and name.startswith("_") and name.isidentifier():
 aliases[name] = name
 for child in node.values():
 visit(child)
 elif isinstance(node, list):
 for child in node:
 visit(child)

 visit(value)
 return dict(sorted(aliases.items()))


def _generate_models(spec_path: Path, output_path: Path, config: Mapping[str, Any]) -> None:
 output_path.parent.mkdir(parents=True, exist_ok=True)
 header = _generated_header(config, "CONTENT_HASH_PLACEHOLDER").rstrip()
 aliases = _leading_underscore_field_aliases(json.loads(spec_path.read_text(encoding="utf-8")))
 command = [
 sys.executable,
 "-m",
Expand All@@ -520,6 +541,7 @@ def _generate_models(spec_path: Path, output_path: Path, config: Mapping[str, An
 "--output",
 str(output_path),
 *_model_flags(config),
 *(["--aliases", json.dumps(aliases, sort_keys=True)] if aliases else []),
 "--custom-file-header",
 header,
 ]
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(api): generate and migrate Dataset REST resources by AbhiPrasad · Pull Request #703 · braintrustdata/braintrust-sdk-python · GitHub
Skip to content
feat(api): generate and migrate Dataset REST resources#703

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Abhijeet Prasad (AbhiPrasad)
merged 1 commit into

from

Aug 19, 2026
 Merged


feat(api): generate and migrate Dataset REST resources
#703
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


46 changes: 25 additions & 21 deletions
openapi/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,42 +1,46 @@
# Pinned Braintrust OpenAPI specification

`spec.json` is a committed snapshot of the public specification from
`spec.json` is a committed snapshot of
[`braintrustdata/braintrust-openapi`](https://github.com/braintrustdata/braintrust-openapi).
`config.json` pins the full upstream commit, snapshot SHA-256, generator tools, generator flags, and
selected endpoint tags. The generator scripts live in `py/scripts/`. Builds and package installation
use the committed generated source and never fetch or run code generation.
`config.json` pins the upstream commit, snapshot hash, generator versions and flags, selected endpoint
tags, and retry-policy allowlists. Builds use committed generated source and never fetch the spec or
run code generation.

From `py/`, validate and regenerate the private models offline with:
## Generate and check

Run from `py/`:

```bash
make generate-api-client
make check-api-client-codegen
```

The check regenerates into a temporary directory and does not modify the worktree. Endpoint bindings
are rolled out explicitly through `endpoint_generator.generated_tags`. The current rollout supports
the Projects and Experiments tags and emits one operation registry/resource class per tag. Reachable
models used by one resource live in that resource's model module; models shared by multiple resources
live once in `models/common.py` and are imported explicitly. Unreachable models are omitted. Public
resource method and inline response type names are derived mechanically from each `operationId`, and
generated methods forward request fields and parameters without implicit defaults. Logical POST reads
that are safe to retry are listed in `endpoint_generator.safe_reads`, while verified idempotent writes
are listed in `endpoint_generator.idempotent_writes`; GET/HEAD reads and all other writes use
mechanical retry defaults.
The check regenerates in a temporary directory and reports drift without changing the worktree.
Currently selected tags are Projects, Experiments, and Datasets. Each tag produces one resource and
operation registry. Models used by one resource stay in that resource's model module; shared models
live in `models/common.py`; unreachable models are omitted.

Method and inline-response names come directly from normalized OpenAPI `operationId` values. Generated
models preserve exact wire keys, including leading underscores, and methods do not add implicit request
defaults. GET and HEAD operations use the safe-read retry policy.
Logical POST reads and verified idempotent writes must be listed explicitly in `safe_reads` and
`idempotent_writes`; all other writes are non-retrying.

## Refresh the snapshot

To fetch the configured upstream commit explicitly:
Fetch the configured upstream commit:

```bash
make fetch-openapi-spec
```

For an existing local checkout, set `BRAINTRUST_OPENAPI_ROOT` to its root. The checkout must be at the
commit pinned in `config.json`, and its specification must have the pinned hash:
To fetch from a local checkout instead:

```bash
BRAINTRUST_OPENAPI_ROOT=../../braintrust-openapi make fetch-openapi-spec
```

To update the snapshot, first update the commit and SHA-256 in `config.json`, then fetch, regenerate,
and review both the upstream spec diff and generated model diff. Only operations selected through
`endpoint_generator.generated_tags` and their reachable schemas are validated and generated.
The checkout must be at the commit pinned in `config.json`, and its spec must match the pinned hash.
To update the snapshot, update the commit and hash in `config.json`, fetch, regenerate, and review both
the upstream spec diff and generated-source diff. Validation and generation apply only to selected tags
and their transitively reachable schemas.

9 changes: 6 additions & 3 deletions
openapi/config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,13 +31,16 @@
 "schema_version": 1,
 "generated_tags": [
 "Projects",
 "Experiments"
 "Experiments",
 "Datasets"
 ],
 "safe_reads": [
 "postExperimentIdFetch"
 "postExperimentIdFetch",
 "postDatasetIdFetch"
 ],
 "idempotent_writes": [
 "postProject"
 "postProject",
 "postDataset"
 ],
 "supported_success_statuses": [
 "200",
Expand Down

22 changes: 22 additions & 0 deletions
py/scripts/openapi_codegen.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -508,9 +508,30 @@ def _prune_empty_directories(root: Path) -> None:
 shutil.rmtree(directory)


def _leading_underscore_field_aliases(value: Any) -> Dict[str, str]:
 aliases: Dict[str, str] = {}

 def visit(node: Any) -> None:
 if isinstance(node, dict):
 properties = node.get("properties")
 if isinstance(properties, dict):
 for name in properties:
 if isinstance(name, str) and name.startswith("_") and name.isidentifier():
 aliases[name] = name
 for child in node.values():
 visit(child)
 elif isinstance(node, list):
 for child in node:
 visit(child)

 visit(value)
 return dict(sorted(aliases.items()))


def _generate_models(spec_path: Path, output_path: Path, config: Mapping[str, Any]) -> None:
 output_path.parent.mkdir(parents=True, exist_ok=True)
 header = _generated_header(config, "CONTENT_HASH_PLACEHOLDER").rstrip()
 aliases = _leading_underscore_field_aliases(json.loads(spec_path.read_text(encoding="utf-8")))
 command = [
 sys.executable,
 "-m",
Expand All@@ -520,6 +541,7 @@ def _generate_models(spec_path: Path, output_path: Path, config: Mapping[str, An
 "--output",
 str(output_path),
 *_model_flags(config),
 *(["--aliases", json.dumps(aliases, sort_keys=True)] if aliases else []),
 "--custom-file-header",
 header,
 ]
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(api): generate and migrate Dataset REST resources by AbhiPrasad · Pull Request #703 · braintrustdata/braintrust-sdk-python · GitHub
Skip to content
feat(api): generate and migrate Dataset REST resources#703

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Abhijeet Prasad (AbhiPrasad)
merged 1 commit into

from

Aug 19, 2026
 Merged


feat(api): generate and migrate Dataset REST resources
#703
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


46 changes: 25 additions & 21 deletions
openapi/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,42 +1,46 @@
# Pinned Braintrust OpenAPI specification

`spec.json` is a committed snapshot of the public specification from
`spec.json` is a committed snapshot of
[`braintrustdata/braintrust-openapi`](https://github.com/braintrustdata/braintrust-openapi).
`config.json` pins the full upstream commit, snapshot SHA-256, generator tools, generator flags, and
selected endpoint tags. The generator scripts live in `py/scripts/`. Builds and package installation
use the committed generated source and never fetch or run code generation.
`config.json` pins the upstream commit, snapshot hash, generator versions and flags, selected endpoint
tags, and retry-policy allowlists. Builds use committed generated source and never fetch the spec or
run code generation.

From `py/`, validate and regenerate the private models offline with:
## Generate and check

Run from `py/`:

```bash
make generate-api-client
make check-api-client-codegen
```

The check regenerates into a temporary directory and does not modify the worktree. Endpoint bindings
are rolled out explicitly through `endpoint_generator.generated_tags`. The current rollout supports
the Projects and Experiments tags and emits one operation registry/resource class per tag. Reachable
models used by one resource live in that resource's model module; models shared by multiple resources
live once in `models/common.py` and are imported explicitly. Unreachable models are omitted. Public
resource method and inline response type names are derived mechanically from each `operationId`, and
generated methods forward request fields and parameters without implicit defaults. Logical POST reads
that are safe to retry are listed in `endpoint_generator.safe_reads`, while verified idempotent writes
are listed in `endpoint_generator.idempotent_writes`; GET/HEAD reads and all other writes use
mechanical retry defaults.
The check regenerates in a temporary directory and reports drift without changing the worktree.
Currently selected tags are Projects, Experiments, and Datasets. Each tag produces one resource and
operation registry. Models used by one resource stay in that resource's model module; shared models
live in `models/common.py`; unreachable models are omitted.

Method and inline-response names come directly from normalized OpenAPI `operationId` values. Generated
models preserve exact wire keys, including leading underscores, and methods do not add implicit request
defaults. GET and HEAD operations use the safe-read retry policy.
Logical POST reads and verified idempotent writes must be listed explicitly in `safe_reads` and
`idempotent_writes`; all other writes are non-retrying.

## Refresh the snapshot

To fetch the configured upstream commit explicitly:
Fetch the configured upstream commit:

```bash
make fetch-openapi-spec
```

For an existing local checkout, set `BRAINTRUST_OPENAPI_ROOT` to its root. The checkout must be at the
commit pinned in `config.json`, and its specification must have the pinned hash:
To fetch from a local checkout instead:

```bash
BRAINTRUST_OPENAPI_ROOT=../../braintrust-openapi make fetch-openapi-spec
```

To update the snapshot, first update the commit and SHA-256 in `config.json`, then fetch, regenerate,
and review both the upstream spec diff and generated model diff. Only operations selected through
`endpoint_generator.generated_tags` and their reachable schemas are validated and generated.
The checkout must be at the commit pinned in `config.json`, and its spec must match the pinned hash.
To update the snapshot, update the commit and hash in `config.json`, fetch, regenerate, and review both
the upstream spec diff and generated-source diff. Validation and generation apply only to selected tags
and their transitively reachable schemas.

9 changes: 6 additions & 3 deletions
openapi/config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,13 +31,16 @@
 "schema_version": 1,
 "generated_tags": [
 "Projects",
 "Experiments"
 "Experiments",
 "Datasets"
 ],
 "safe_reads": [
 "postExperimentIdFetch"
 "postExperimentIdFetch",
 "postDatasetIdFetch"
 ],
 "idempotent_writes": [
 "postProject"
 "postProject",
 "postDataset"
 ],
 "supported_success_statuses": [
 "200",
Expand Down

22 changes: 22 additions & 0 deletions
py/scripts/openapi_codegen.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -508,9 +508,30 @@ def _prune_empty_directories(root: Path) -> None:
 shutil.rmtree(directory)


def _leading_underscore_field_aliases(value: Any) -> Dict[str, str]:
 aliases: Dict[str, str] = {}

 def visit(node: Any) -> None:
 if isinstance(node, dict):
 properties = node.get("properties")
 if isinstance(properties, dict):
 for name in properties:
 if isinstance(name, str) and name.startswith("_") and name.isidentifier():
 aliases[name] = name
 for child in node.values():
 visit(child)
 elif isinstance(node, list):
 for child in node:
 visit(child)

 visit(value)
 return dict(sorted(aliases.items()))


def _generate_models(spec_path: Path, output_path: Path, config: Mapping[str, Any]) -> None:
 output_path.parent.mkdir(parents=True, exist_ok=True)
 header = _generated_header(config, "CONTENT_HASH_PLACEHOLDER").rstrip()
 aliases = _leading_underscore_field_aliases(json.loads(spec_path.read_text(encoding="utf-8")))
 command = [
 sys.executable,
 "-m",
Expand All@@ -520,6 +541,7 @@ def _generate_models(spec_path: Path, output_path: Path, config: Mapping[str, An
 "--output",
 str(output_path),
 *_model_flags(config),
 *(["--aliases", json.dumps(aliases, sort_keys=True)] if aliases else []),
 "--custom-file-header",
 header,
 ]
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
feat(api): generate and migrate Dataset REST resources by AbhiPrasad · Pull Request #703 · braintrustdata/braintrust-sdk-python · GitHub
Skip to content
feat(api): generate and migrate Dataset REST resources#703

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Abhijeet Prasad (AbhiPrasad)
merged 1 commit into

from

Aug 19, 2026
 Merged


feat(api): generate and migrate Dataset REST resources
#703
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


46 changes: 25 additions & 21 deletions
openapi/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,42 +1,46 @@
# Pinned Braintrust OpenAPI specification

`spec.json` is a committed snapshot of the public specification from
`spec.json` is a committed snapshot of
[`braintrustdata/braintrust-openapi`](https://github.com/braintrustdata/braintrust-openapi).
`config.json` pins the full upstream commit, snapshot SHA-256, generator tools, generator flags, and
selected endpoint tags. The generator scripts live in `py/scripts/`. Builds and package installation
use the committed generated source and never fetch or run code generation.
`config.json` pins the upstream commit, snapshot hash, generator versions and flags, selected endpoint
tags, and retry-policy allowlists. Builds use committed generated source and never fetch the spec or
run code generation.

From `py/`, validate and regenerate the private models offline with:
## Generate and check

Run from `py/`:

```bash
make generate-api-client
make check-api-client-codegen
```

The check regenerates into a temporary directory and does not modify the worktree. Endpoint bindings
are rolled out explicitly through `endpoint_generator.generated_tags`. The current rollout supports
the Projects and Experiments tags and emits one operation registry/resource class per tag. Reachable
models used by one resource live in that resource's model module; models shared by multiple resources
live once in `models/common.py` and are imported explicitly. Unreachable models are omitted. Public
resource method and inline response type names are derived mechanically from each `operationId`, and
generated methods forward request fields and parameters without implicit defaults. Logical POST reads
that are safe to retry are listed in `endpoint_generator.safe_reads`, while verified idempotent writes
are listed in `endpoint_generator.idempotent_writes`; GET/HEAD reads and all other writes use
mechanical retry defaults.
The check regenerates in a temporary directory and reports drift without changing the worktree.
Currently selected tags are Projects, Experiments, and Datasets. Each tag produces one resource and
operation registry. Models used by one resource stay in that resource's model module; shared models
live in `models/common.py`; unreachable models are omitted.

Method and inline-response names come directly from normalized OpenAPI `operationId` values. Generated
models preserve exact wire keys, including leading underscores, and methods do not add implicit request
defaults. GET and HEAD operations use the safe-read retry policy.
Logical POST reads and verified idempotent writes must be listed explicitly in `safe_reads` and
`idempotent_writes`; all other writes are non-retrying.

## Refresh the snapshot

To fetch the configured upstream commit explicitly:
Fetch the configured upstream commit:

```bash
make fetch-openapi-spec
```

For an existing local checkout, set `BRAINTRUST_OPENAPI_ROOT` to its root. The checkout must be at the
commit pinned in `config.json`, and its specification must have the pinned hash:
To fetch from a local checkout instead:

```bash
BRAINTRUST_OPENAPI_ROOT=../../braintrust-openapi make fetch-openapi-spec
```

To update the snapshot, first update the commit and SHA-256 in `config.json`, then fetch, regenerate,
and review both the upstream spec diff and generated model diff. Only operations selected through
`endpoint_generator.generated_tags` and their reachable schemas are validated and generated.
The checkout must be at the commit pinned in `config.json`, and its spec must match the pinned hash.
To update the snapshot, update the commit and hash in `config.json`, fetch, regenerate, and review both
the upstream spec diff and generated-source diff. Validation and generation apply only to selected tags
and their transitively reachable schemas.

9 changes: 6 additions & 3 deletions
openapi/config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,13 +31,16 @@
 "schema_version": 1,
 "generated_tags": [
 "Projects",
 "Experiments"
 "Experiments",
 "Datasets"
 ],
 "safe_reads": [
 "postExperimentIdFetch"
 "postExperimentIdFetch",
 "postDatasetIdFetch"
 ],
 "idempotent_writes": [
 "postProject"
 "postProject",
 "postDataset"
 ],
 "supported_success_statuses": [
 "200",
Expand Down

22 changes: 22 additions & 0 deletions
py/scripts/openapi_codegen.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -508,9 +508,30 @@ def _prune_empty_directories(root: Path) -> None:
 shutil.rmtree(directory)


def _leading_underscore_field_aliases(value: Any) -> Dict[str, str]:
 aliases: Dict[str, str] = {}

 def visit(node: Any) -> None:
 if isinstance(node, dict):
 properties = node.get("properties")
 if isinstance(properties, dict):
 for name in properties:
 if isinstance(name, str) and name.startswith("_") and name.isidentifier():
 aliases[name] = name
 for child in node.values():
 visit(child)
 elif isinstance(node, list):
 for child in node:
 visit(child)

 visit(value)
 return dict(sorted(aliases.items()))


def _generate_models(spec_path: Path, output_path: Path, config: Mapping[str, Any]) -> None:
 output_path.parent.mkdir(parents=True, exist_ok=True)
 header = _generated_header(config, "CONTENT_HASH_PLACEHOLDER").rstrip()
 aliases = _leading_underscore_field_aliases(json.loads(spec_path.read_text(encoding="utf-8")))
 command = [
 sys.executable,
 "-m",
Expand All@@ -520,6 +541,7 @@ def _generate_models(spec_path: Path, output_path: Path, config: Mapping[str, An
 "--output",
 str(output_path),
 *_model_flags(config),
 *(["--aliases", json.dumps(aliases, sort_keys=True)] if aliases else []),
 "--custom-file-header",
 header,
 ]
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(api): generate and migrate Dataset REST resources by AbhiPrasad · Pull Request #703 · braintrustdata/braintrust-sdk-python · GitHub
Skip to content
feat(api): generate and migrate Dataset REST resources#703

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Abhijeet Prasad (AbhiPrasad)
merged 1 commit into

from

Aug 19, 2026
 Merged


feat(api): generate and migrate Dataset REST resources
#703
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


46 changes: 25 additions & 21 deletions
openapi/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,42 +1,46 @@
# Pinned Braintrust OpenAPI specification

`spec.json` is a committed snapshot of the public specification from
`spec.json` is a committed snapshot of
[`braintrustdata/braintrust-openapi`](https://github.com/braintrustdata/braintrust-openapi).
`config.json` pins the full upstream commit, snapshot SHA-256, generator tools, generator flags, and
selected endpoint tags. The generator scripts live in `py/scripts/`. Builds and package installation
use the committed generated source and never fetch or run code generation.
`config.json` pins the upstream commit, snapshot hash, generator versions and flags, selected endpoint
tags, and retry-policy allowlists. Builds use committed generated source and never fetch the spec or
run code generation.

From `py/`, validate and regenerate the private models offline with:
## Generate and check

Run from `py/`:

```bash
make generate-api-client
make check-api-client-codegen
```

The check regenerates into a temporary directory and does not modify the worktree. Endpoint bindings
are rolled out explicitly through `endpoint_generator.generated_tags`. The current rollout supports
the Projects and Experiments tags and emits one operation registry/resource class per tag. Reachable
models used by one resource live in that resource's model module; models shared by multiple resources
live once in `models/common.py` and are imported explicitly. Unreachable models are omitted. Public
resource method and inline response type names are derived mechanically from each `operationId`, and
generated methods forward request fields and parameters without implicit defaults. Logical POST reads
that are safe to retry are listed in `endpoint_generator.safe_reads`, while verified idempotent writes
are listed in `endpoint_generator.idempotent_writes`; GET/HEAD reads and all other writes use
mechanical retry defaults.
The check regenerates in a temporary directory and reports drift without changing the worktree.
Currently selected tags are Projects, Experiments, and Datasets. Each tag produces one resource and
operation registry. Models used by one resource stay in that resource's model module; shared models
live in `models/common.py`; unreachable models are omitted.

Method and inline-response names come directly from normalized OpenAPI `operationId` values. Generated
models preserve exact wire keys, including leading underscores, and methods do not add implicit request
defaults. GET and HEAD operations use the safe-read retry policy.
Logical POST reads and verified idempotent writes must be listed explicitly in `safe_reads` and
`idempotent_writes`; all other writes are non-retrying.

## Refresh the snapshot

To fetch the configured upstream commit explicitly:
Fetch the configured upstream commit:

```bash
make fetch-openapi-spec
```

For an existing local checkout, set `BRAINTRUST_OPENAPI_ROOT` to its root. The checkout must be at the
commit pinned in `config.json`, and its specification must have the pinned hash:
To fetch from a local checkout instead:

```bash
BRAINTRUST_OPENAPI_ROOT=../../braintrust-openapi make fetch-openapi-spec
```

To update the snapshot, first update the commit and SHA-256 in `config.json`, then fetch, regenerate,
and review both the upstream spec diff and generated model diff. Only operations selected through
`endpoint_generator.generated_tags` and their reachable schemas are validated and generated.
The checkout must be at the commit pinned in `config.json`, and its spec must match the pinned hash.
To update the snapshot, update the commit and hash in `config.json`, fetch, regenerate, and review both
the upstream spec diff and generated-source diff. Validation and generation apply only to selected tags
and their transitively reachable schemas.

9 changes: 6 additions & 3 deletions
openapi/config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,13 +31,16 @@
 "schema_version": 1,
 "generated_tags": [
 "Projects",
 "Experiments"
 "Experiments",
 "Datasets"
 ],
 "safe_reads": [
 "postExperimentIdFetch"
 "postExperimentIdFetch",
 "postDatasetIdFetch"
 ],
 "idempotent_writes": [
 "postProject"
 "postProject",
 "postDataset"
 ],
 "supported_success_statuses": [
 "200",
Expand Down

22 changes: 22 additions & 0 deletions
py/scripts/openapi_codegen.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -508,9 +508,30 @@ def _prune_empty_directories(root: Path) -> None:
 shutil.rmtree(directory)


def _leading_underscore_field_aliases(value: Any) -> Dict[str, str]:
 aliases: Dict[str, str] = {}

 def visit(node: Any) -> None:
 if isinstance(node, dict):
 properties = node.get("properties")
 if isinstance(properties, dict):
 for name in properties:
 if isinstance(name, str) and name.startswith("_") and name.isidentifier():
 aliases[name] = name
 for child in node.values():
 visit(child)
 elif isinstance(node, list):
 for child in node:
 visit(child)

 visit(value)
 return dict(sorted(aliases.items()))


def _generate_models(spec_path: Path, output_path: Path, config: Mapping[str, Any]) -> None:
 output_path.parent.mkdir(parents=True, exist_ok=True)
 header = _generated_header(config, "CONTENT_HASH_PLACEHOLDER").rstrip()
 aliases = _leading_underscore_field_aliases(json.loads(spec_path.read_text(encoding="utf-8")))
 command = [
 sys.executable,
 "-m",
Expand All@@ -520,6 +541,7 @@ def _generate_models(spec_path: Path, output_path: Path, config: Mapping[str, An
 "--output",
 str(output_path),
 *_model_flags(config),
 *(["--aliases", json.dumps(aliases, sort_keys=True)] if aliases else []),
 "--custom-file-header",
 header,
 ]
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(api): generate and migrate Dataset REST resources by AbhiPrasad · Pull Request #703 · braintrustdata/braintrust-sdk-python · GitHub
Skip to content
feat(api): generate and migrate Dataset REST resources#703

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Abhijeet Prasad (AbhiPrasad)
merged 1 commit into

from

Aug 19, 2026
 Merged


feat(api): generate and migrate Dataset REST resources
#703
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


46 changes: 25 additions & 21 deletions
openapi/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,42 +1,46 @@
# Pinned Braintrust OpenAPI specification

`spec.json` is a committed snapshot of the public specification from
`spec.json` is a committed snapshot of
[`braintrustdata/braintrust-openapi`](https://github.com/braintrustdata/braintrust-openapi).
`config.json` pins the full upstream commit, snapshot SHA-256, generator tools, generator flags, and
selected endpoint tags. The generator scripts live in `py/scripts/`. Builds and package installation
use the committed generated source and never fetch or run code generation.
`config.json` pins the upstream commit, snapshot hash, generator versions and flags, selected endpoint
tags, and retry-policy allowlists. Builds use committed generated source and never fetch the spec or
run code generation.

From `py/`, validate and regenerate the private models offline with:
## Generate and check

Run from `py/`:

```bash
make generate-api-client
make check-api-client-codegen
```

The check regenerates into a temporary directory and does not modify the worktree. Endpoint bindings
are rolled out explicitly through `endpoint_generator.generated_tags`. The current rollout supports
the Projects and Experiments tags and emits one operation registry/resource class per tag. Reachable
models used by one resource live in that resource's model module; models shared by multiple resources
live once in `models/common.py` and are imported explicitly. Unreachable models are omitted. Public
resource method and inline response type names are derived mechanically from each `operationId`, and
generated methods forward request fields and parameters without implicit defaults. Logical POST reads
that are safe to retry are listed in `endpoint_generator.safe_reads`, while verified idempotent writes
are listed in `endpoint_generator.idempotent_writes`; GET/HEAD reads and all other writes use
mechanical retry defaults.
The check regenerates in a temporary directory and reports drift without changing the worktree.
Currently selected tags are Projects, Experiments, and Datasets. Each tag produces one resource and
operation registry. Models used by one resource stay in that resource's model module; shared models
live in `models/common.py`; unreachable models are omitted.

Method and inline-response names come directly from normalized OpenAPI `operationId` values. Generated
models preserve exact wire keys, including leading underscores, and methods do not add implicit request
defaults. GET and HEAD operations use the safe-read retry policy.
Logical POST reads and verified idempotent writes must be listed explicitly in `safe_reads` and
`idempotent_writes`; all other writes are non-retrying.

## Refresh the snapshot

To fetch the configured upstream commit explicitly:
Fetch the configured upstream commit:

```bash
make fetch-openapi-spec
```

For an existing local checkout, set `BRAINTRUST_OPENAPI_ROOT` to its root. The checkout must be at the
commit pinned in `config.json`, and its specification must have the pinned hash:
To fetch from a local checkout instead:

```bash
BRAINTRUST_OPENAPI_ROOT=../../braintrust-openapi make fetch-openapi-spec
```

To update the snapshot, first update the commit and SHA-256 in `config.json`, then fetch, regenerate,
and review both the upstream spec diff and generated model diff. Only operations selected through
`endpoint_generator.generated_tags` and their reachable schemas are validated and generated.
The checkout must be at the commit pinned in `config.json`, and its spec must match the pinned hash.
To update the snapshot, update the commit and hash in `config.json`, fetch, regenerate, and review both
the upstream spec diff and generated-source diff. Validation and generation apply only to selected tags
and their transitively reachable schemas.

9 changes: 6 additions & 3 deletions
openapi/config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,13 +31,16 @@
 "schema_version": 1,
 "generated_tags": [
 "Projects",
 "Experiments"
 "Experiments",
 "Datasets"
 ],
 "safe_reads": [
 "postExperimentIdFetch"
 "postExperimentIdFetch",
 "postDatasetIdFetch"
 ],
 "idempotent_writes": [
 "postProject"
 "postProject",
 "postDataset"
 ],
 "supported_success_statuses": [
 "200",
Expand Down

22 changes: 22 additions & 0 deletions
py/scripts/openapi_codegen.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -508,9 +508,30 @@ def _prune_empty_directories(root: Path) -> None:
 shutil.rmtree(directory)


def _leading_underscore_field_aliases(value: Any) -> Dict[str, str]:
 aliases: Dict[str, str] = {}

 def visit(node: Any) -> None:
 if isinstance(node, dict):
 properties = node.get("properties")
 if isinstance(properties, dict):
 for name in properties:
 if isinstance(name, str) and name.startswith("_") and name.isidentifier():
 aliases[name] = name
 for child in node.values():
 visit(child)
 elif isinstance(node, list):
 for child in node:
 visit(child)

 visit(value)
 return dict(sorted(aliases.items()))


def _generate_models(spec_path: Path, output_path: Path, config: Mapping[str, Any]) -> None:
 output_path.parent.mkdir(parents=True, exist_ok=True)
 header = _generated_header(config, "CONTENT_HASH_PLACEHOLDER").rstrip()
 aliases = _leading_underscore_field_aliases(json.loads(spec_path.read_text(encoding="utf-8")))
 command = [
 sys.executable,
 "-m",
Expand All@@ -520,6 +541,7 @@ def _generate_models(spec_path: Path, output_path: Path, config: Mapping[str, An
 "--output",
 str(output_path),
 *_model_flags(config),
 *(["--aliases", json.dumps(aliases, sort_keys=True)] if aliases else []),
 "--custom-file-header",
 header,
 ]
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
feat(api): generate and migrate Dataset REST resources by AbhiPrasad · Pull Request #703 · braintrustdata/braintrust-sdk-python · GitHub
Skip to content
feat(api): generate and migrate Dataset REST resources#703

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Abhijeet Prasad (AbhiPrasad)
merged 1 commit into

from

Aug 19, 2026
 Merged


feat(api): generate and migrate Dataset REST resources
#703
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


46 changes: 25 additions & 21 deletions
openapi/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,42 +1,46 @@
# Pinned Braintrust OpenAPI specification

`spec.json` is a committed snapshot of the public specification from
`spec.json` is a committed snapshot of
[`braintrustdata/braintrust-openapi`](https://github.com/braintrustdata/braintrust-openapi).
`config.json` pins the full upstream commit, snapshot SHA-256, generator tools, generator flags, and
selected endpoint tags. The generator scripts live in `py/scripts/`. Builds and package installation
use the committed generated source and never fetch or run code generation.
`config.json` pins the upstream commit, snapshot hash, generator versions and flags, selected endpoint
tags, and retry-policy allowlists. Builds use committed generated source and never fetch the spec or
run code generation.

From `py/`, validate and regenerate the private models offline with:
## Generate and check

Run from `py/`:

```bash
make generate-api-client
make check-api-client-codegen
```

The check regenerates into a temporary directory and does not modify the worktree. Endpoint bindings
are rolled out explicitly through `endpoint_generator.generated_tags`. The current rollout supports
the Projects and Experiments tags and emits one operation registry/resource class per tag. Reachable
models used by one resource live in that resource's model module; models shared by multiple resources
live once in `models/common.py` and are imported explicitly. Unreachable models are omitted. Public
resource method and inline response type names are derived mechanically from each `operationId`, and
generated methods forward request fields and parameters without implicit defaults. Logical POST reads
that are safe to retry are listed in `endpoint_generator.safe_reads`, while verified idempotent writes
are listed in `endpoint_generator.idempotent_writes`; GET/HEAD reads and all other writes use
mechanical retry defaults.
The check regenerates in a temporary directory and reports drift without changing the worktree.
Currently selected tags are Projects, Experiments, and Datasets. Each tag produces one resource and
operation registry. Models used by one resource stay in that resource's model module; shared models
live in `models/common.py`; unreachable models are omitted.

Method and inline-response names come directly from normalized OpenAPI `operationId` values. Generated
models preserve exact wire keys, including leading underscores, and methods do not add implicit request
defaults. GET and HEAD operations use the safe-read retry policy.
Logical POST reads and verified idempotent writes must be listed explicitly in `safe_reads` and
`idempotent_writes`; all other writes are non-retrying.

## Refresh the snapshot

To fetch the configured upstream commit explicitly:
Fetch the configured upstream commit:

```bash
make fetch-openapi-spec
```

For an existing local checkout, set `BRAINTRUST_OPENAPI_ROOT` to its root. The checkout must be at the
commit pinned in `config.json`, and its specification must have the pinned hash:
To fetch from a local checkout instead:

```bash
BRAINTRUST_OPENAPI_ROOT=../../braintrust-openapi make fetch-openapi-spec
```

To update the snapshot, first update the commit and SHA-256 in `config.json`, then fetch, regenerate,
and review both the upstream spec diff and generated model diff. Only operations selected through
`endpoint_generator.generated_tags` and their reachable schemas are validated and generated.
The checkout must be at the commit pinned in `config.json`, and its spec must match the pinned hash.
To update the snapshot, update the commit and hash in `config.json`, fetch, regenerate, and review both
the upstream spec diff and generated-source diff. Validation and generation apply only to selected tags
and their transitively reachable schemas.

9 changes: 6 additions & 3 deletions
openapi/config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,13 +31,16 @@
 "schema_version": 1,
 "generated_tags": [
 "Projects",
 "Experiments"
 "Experiments",
 "Datasets"
 ],
 "safe_reads": [
 "postExperimentIdFetch"
 "postExperimentIdFetch",
 "postDatasetIdFetch"
 ],
 "idempotent_writes": [
 "postProject"
 "postProject",
 "postDataset"
 ],
 "supported_success_statuses": [
 "200",
Expand Down

22 changes: 22 additions & 0 deletions
py/scripts/openapi_codegen.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -508,9 +508,30 @@ def _prune_empty_directories(root: Path) -> None:
 shutil.rmtree(directory)


def _leading_underscore_field_aliases(value: Any) -> Dict[str, str]:
 aliases: Dict[str, str] = {}

 def visit(node: Any) -> None:
 if isinstance(node, dict):
 properties = node.get("properties")
 if isinstance(properties, dict):
 for name in properties:
 if isinstance(name, str) and name.startswith("_") and name.isidentifier():
 aliases[name] = name
 for child in node.values():
 visit(child)
 elif isinstance(node, list):
 for child in node:
 visit(child)

 visit(value)
 return dict(sorted(aliases.items()))


def _generate_models(spec_path: Path, output_path: Path, config: Mapping[str, Any]) -> None:
 output_path.parent.mkdir(parents=True, exist_ok=True)
 header = _generated_header(config, "CONTENT_HASH_PLACEHOLDER").rstrip()
 aliases = _leading_underscore_field_aliases(json.loads(spec_path.read_text(encoding="utf-8")))
 command = [
 sys.executable,
 "-m",
Expand All@@ -520,6 +541,7 @@ def _generate_models(spec_path: Path, output_path: Path, config: Mapping[str, An
 "--output",
 str(output_path),
 *_model_flags(config),
 *(["--aliases", json.dumps(aliases, sort_keys=True)] if aliases else []),
 "--custom-file-header",
 header,
 ]
Expand Down
Loading