[PR #116] [MERGED] docs(errors): attribute the detail[] validation shape to FastAPI #118

New issue

Closed

opened 2026-10-31 22:04:43 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-31 22:04:43 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/Comfy-Org/comfy-typescript-sdk/pull/116
Author: @mattmillerai
Created: 9/1/2026
Status: ✅ Merged
Merged: 9/1/2026
Merged by: @mattmillerai

Base: main ← Head: matt/router-error-detail-comment

📝 Commits (1)

60f8250 docs(errors): attribute the detail[] validation shape to FastAPI

📊 Changes

1 file changed (+1 additions, -1 deletions)

View changed files

📝 src/sdk/routerErrors.ts (+1 -1)

📄 Description

Summary

One comment change, no behaviour.

The ValidationErrorDetail doc comment in src/sdk/routerErrors.ts described the type as the "fal/FastAPI detail[] form". The detail[] body carrying loc / msg / type is FastAPI's own validation error format. Naming a specific third-party API next to it implied the shape originates there, which is both inaccurate and more than this SDK needs to say about where a wire format came from.

Dropping the vendor name leaves the attribution correct: this is the FastAPI shape, and Router happens to serve it. The rest of the comment, which is the load-bearing part (why type is an open string rather than a union), is unchanged.

Verification

Comment-only, inside a JSDoc block. No type or runtime surface changes.

Summary by CodeRabbit

Documentation
- Updated validation-failure guidance to reference FastAPI’s detail[] response format.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/Comfy-Org/comfy-typescript-sdk/pull/116 **Author:** [@mattmillerai](https://github.com/mattmillerai) **Created:** 9/1/2026 **Status:** ✅ Merged **Merged:** 9/1/2026 **Merged by:** [@mattmillerai](https://github.com/mattmillerai) **Base:** `main` ← **Head:** `matt/router-error-detail-comment` --- ### 📝 Commits (1) - [`60f8250`](https://github.com/Comfy-Org/comfy-typescript-sdk/commit/60f8250bddb32c154e2a26b3c927400151b8af09) docs(errors): attribute the detail[] validation shape to FastAPI ### 📊 Changes **1 file changed** (+1 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `src/sdk/routerErrors.ts` (+1 -1) </details> ### 📄 Description ## Summary One comment change, no behaviour. The `ValidationErrorDetail` doc comment in `src/sdk/routerErrors.ts` described the type as the "fal/FastAPI `detail[]` form". The `detail[]` body carrying `loc` / `msg` / `type` is FastAPI's own validation error format. Naming a specific third-party API next to it implied the shape originates there, which is both inaccurate and more than this SDK needs to say about where a wire format came from. Dropping the vendor name leaves the attribution correct: this is the FastAPI shape, and Router happens to serve it. The rest of the comment, which is the load-bearing part (why `type` is an open string rather than a union), is unchanged. ## Verification Comment-only, inside a JSDoc block. No type or runtime surface changes.  ## Summary by CodeRabbit * **Documentation** * Updated validation-failure guidance to reference FastAPI’s `detail[]` response format.  --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-31 22:04:43 +00:00