Update Weave reference documentation (Weave 0.52.16) #1888

github-actions · 2025-11-18T20:14:49Z

This PR updates the reference documentation for Weave.

Let's not merge this. Let's merge the fixes in #1889, then close this PR and try again. Waiting for @dbrian57 to review this draft PR too so we can see if more fixes need to be made.

Version: 0.52.16
Generated on: 2025-11-18 20:13:43 UTC
Source code: wandb/[email protected]

Changes

Synced OpenAPI specification from remote service
Updated Service API landing page with current endpoints list
Regenerated Python SDK documentation using lazydocs (dynamically discovers all public modules)
Regenerated TypeScript SDK documentation using typedoc
Updated docs.json navigation with any new or removed modules
Fixed file casing for consistency
Fixed internal cross-reference links
Converted Service API endpoint links to fully qualified URLs

github-actions · 2025-11-18T20:17:25Z

📚 Mintlify Preview Links

🔗 View Full Preview

🔄 Renamed/Moved (15 total)

📄 Pages (15)

Old Path → New Path	Preview
`models/ref/python/public-api/artifactcollection.mdx` → `models/ref/python/public-api/ArtifactCollection.mdx`	ArtifactCollection
`models/ref/python/public-api/artifactcollections.mdx` → `models/ref/python/public-api/ArtifactCollections.mdx`	ArtifactCollections
`models/ref/python/public-api/artifactfiles.mdx` → `models/ref/python/public-api/ArtifactFiles.mdx`	ArtifactFiles
`models/ref/python/public-api/artifacttype.mdx` → `models/ref/python/public-api/ArtifactType.mdx`	ArtifactType
`models/ref/python/public-api/artifacttypes.mdx` → `models/ref/python/public-api/ArtifactTypes.mdx`	ArtifactTypes
`models/ref/python/public-api/betareport.mdx` → `models/ref/python/public-api/BetaReport.mdx`	BetaReport
`models/ref/python/public-api/file.mdx` → `models/ref/python/public-api/File.mdx`	File
`models/ref/python/public-api/member.mdx` → `models/ref/python/public-api/Member.mdx`	Member
`models/ref/python/public-api/project.mdx` → `models/ref/python/public-api/Project.mdx`	Project
`models/ref/python/public-api/registry.mdx` → `models/ref/python/public-api/Registry.mdx`	Registry
... and 5 more pages

✨ Added (2 total)

📄 Pages (2)

File	Preview
`weave/reference/service-api/index.mdx`	Service Api
`weave/reference/typescript-sdk/classes/ObjectRef.mdx`	ObjectRef

📝 Changed (32 total)

📄 Pages (31)

File	Preview
`weave/reference/python-sdk.mdx`	Python Sdk
`weave/reference/python-sdk/trace/feedback.mdx`	Feedback
`weave/reference/python-sdk/trace/op.mdx`	Op
`weave/reference/python-sdk/trace/util.mdx`	Util
`weave/reference/python-sdk/trace/weave_client.mdx`	Weave Client
`weave/reference/python-sdk/trace_server/trace_server_interface.mdx`	Trace Server Interface
`weave/reference/python-sdk/trace_server_bindings/remote_http_trace_server.mdx`	Remote Http Trace Server
`weave/reference/service-api.mdx`	Service Api
`weave/reference/typescript-sdk.mdx`	Typescript Sdk
`weave/reference/typescript-sdk/classes/Dataset.mdx`	Dataset
... and 21 more files

⚙️ Other (1)

File
`docs.json`

🤖 Generated automatically when Mintlify deployment succeeds
📍 Deployment: e0aea74 at 2025-11-18 20:17:24 UTC

mdlinville · 2025-11-18T21:03:24Z

docs.json

-                      "weave/reference/python-sdk",
                      {
-                        "group": "Core",
+                        "group": "Other",


Fixed locally in the scripts

mdlinville · 2025-11-18T21:03:48Z

docs.json

-                      "source": "weave/reference/service-api/openapi.json",
-                      "directory": "weave/reference/service-api"
-                    }
+                    "openapi": "https://raw.githubusercontent.com/wandb/weave/v0.52.16/sdks/node/weave.openapi.json"


Fixed locally in the scripts

mdlinville · 2025-11-18T21:04:05Z

models/ref/python/public-api/ArtifactCollection.mdx

Revert these casing changes

Fixed locally in the scripts

mdlinville · 2025-11-18T21:05:13Z

weave/reference/python-sdk.mdx

Revert this deletion? @dbrian57 please confirm.

@dbrian57 It looks like something changed about the Weave module between v0.52.10 (last generation) and v0.52.16 (this PR) that is removing all of the generated content from this file. The Python references are generated from Lazydocs, and it doesn't look like Lazydocs itself has a bug, and it doesn't look like the generation scripts themselves have a bug. So maybe this is intended.

mdlinville · 2025-11-18T21:08:03Z

weave/reference/python-sdk/trace/weave_client.mdx

@dbrian57 PTAL, these look like major changes that could break existing code examples, like it looks like the call method got changed to create_call maybe.

From local investigation, this is not a bug in the generation scripts - these are legitimate breaking API changes in Weave 0.52.16!
Here's what changed:
Methods REMOVED in Weave 0.52.16:
call() - This is what the comment is concerned about!
calls()
apply_scorer()
children()
delete()
feedback()
remove_display_name()
set_display_name()
to_dict()
Methods ADDED in Weave 0.52.16:
clear_wandb_run_context()
set_wandb_run_context()
The call() method still exists (it's just deprecated), but calls() is completely gone. The removal of these methods is a breaking change in the Weave API itself.

Perfect! This is API cleanup/refactoring in Weave 0.52.16, not a generation bug. Here's what happened:
The Changes Are Intentional API Improvements
call() → get_call()
The old call(call_id, include_costs) method was removed
It was redundant with get_call() which has the same signature
get_call() exists in both versions with identical signatures
This is just removing a deprecated alias
calls() → get_calls()The calls() method was removed
The functionality exists in get_calls() (which was already there)
feedback() method removed
This was likely moved or renamed
New context methods added:
set_wandb_run_context()
clear_wandb_run_context()
Summary
These are legitimate breaking API changes in Weave 0.52.16 as part of API cleanup. The Weave team:
Removed redundant/deprecated methods (call → get_call, calls → get_calls)
Added new functionality (wandb context management)
Removed other deprecated methods
This will break existing code that uses the old method names, but that's an intentional breaking change by the Weave team, not a documentation generation bug.
Recommendation: These changes should be documented in Weave's changelog/migration guide so users know to update their code from client.call() to client.get_call().

weave/reference/python-sdk/trace/weave_client.mdx

mdlinville · 2025-11-18T21:09:50Z

weave/reference/python-sdk/trace_server/trace_server_interface.mdx


------
+---------


This looks like a bug?

Fixed locally in the scripts

mdlinville · 2025-11-18T21:12:27Z

weave/reference/service-api.mdx

 ## Available Endpoints


 ### Calls


Is it correct that this has two H3s called Calls?

Fixed locally in the scripts

mdlinville · 2025-11-18T21:13:41Z

weave/reference/service-api/index.mdx

+description: "REST API endpoints for the Weave service"
+---
+
+# Weave Service API


Remove H1 in favor of title frontmatter

Fixed locally in the scripts

mdlinville · 2025-11-18T21:14:40Z

weave/reference/typescript-sdk/classes/Dataset.mdx

Update to lowercase filenames

Fixed locally in the scripts

Observed in #1888

* Fix Weave reference generation bugs Observed in wandb#1888 * Temporarily include fixes summary report

chore: Update reference documentation (Weave 0.52.16)

e0aea74

github-actions bot added automated documentation Improvements or additions to documentation weave labels Nov 18, 2025

mintlify bot deployed to staging November 18, 2025 20:16 View deployment

mdlinville reviewed Nov 18, 2025

View reviewed changes

mdlinville added a commit that referenced this pull request Nov 18, 2025

Fix Weave reference generation bugs

224344e

Observed in #1888

mdlinville mentioned this pull request Nov 18, 2025

Weave generated reference improvements #1889

Draft

4 tasks

mdlinville added the DO-NOT-MERGE For PRs that should not be merged yet label Nov 18, 2025

mdlinville requested a review from dbrian57 November 18, 2025 22:52

mdlinville added a commit to mdlinville/docs that referenced this pull request Nov 18, 2025

Weave generated reference improvements (#48)

c44b9f0

* Fix Weave reference generation bugs Observed in wandb#1888 * Temporarily include fixes summary report


		------
		---------

Update Weave reference documentation (Weave 0.52.16) #1888

Are you sure you want to change the base?

Update Weave reference documentation (Weave 0.52.16) #1888

Uh oh!

Conversation

github-actions bot commented Nov 18, 2025 • edited by mdlinville Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Uh oh!

github-actions bot commented Nov 18, 2025

📚 Mintlify Preview Links

🔄 Renamed/Moved (15 total)

📄 Pages (15)

✨ Added (2 total)

📄 Pages (2)

📝 Changed (32 total)

📄 Pages (31)

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

github-actions bot commented Nov 18, 2025 •

edited by mdlinville

Loading