Remove inaccurate host-routing note from semantic-search docs#324
Open
etbyrd wants to merge 2 commits into
Open
Remove inaccurate host-routing note from semantic-search docs#324etbyrd wants to merge 2 commits into
etbyrd wants to merge 2 commits into
Conversation
The semanticSearch operation description claimed the typed SDKs route the request to a dedicated search host automatically. They do not: the generated client issues the request against the client's configured base URL like every other operation, with no per-operation server override. The paired operation-level servers entry was dead metadata for the same reason. Removing both, and regenerating the derived artifacts.
Confidence Score: 5/5This looks safe to merge.
|
| Filename | Overview |
|---|---|
| openapi/primitive-api.yaml | Removes the semanticSearch host-routing text and operation-level server override from the source OpenAPI contract. |
| openapi/primitive-api.codegen.json | Mirrors the semanticSearch description and server metadata removal in the generated OpenAPI codegen artifact. |
| packages/api-core/src/openapi/openapi.generated.ts | Mirrors the semanticSearch description and server metadata removal in the exported OpenAPI document. |
| packages/api-core/src/openapi/operations.generated.ts | Updates the semanticSearch operation manifest description after removing the host-routing prose. |
| packages/api-core/src/api/sdk.gen.ts | Updates the generated TypeScript semanticSearch documentation without changing the request path. |
| packages/api-core/src/api/types.gen.ts | Updates the generated baseUrl union after the server metadata change. |
| sdk-python/src/primitive/api/api/search/semantic_search.py | Updates generated Python semanticSearch docstrings without changing request construction. |
| sdk-go/api/oas_client_gen.go | Updates generated Go client comments for semanticSearch. |
| sdk-go/api/oas_handlers_gen.go | Updates generated Go handler comments for semanticSearch. |
| sdk-go/api/oas_server_gen.go | Updates generated Go server interface comments for semanticSearch. |
| sdk-go/api/oas_unimplemented_gen.go | Updates generated Go unimplemented handler comments for semanticSearch. |
Reviews (2): Last reviewed commit: "Regenerate Go and Python artifacts for t..." | Re-trigger Greptile
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The
semanticSearchoperation description inopenapi/primitive-api.yamlclaimed:Both sentences are inaccurate. The generated client issues the request as a relative path against the client's configured base URL, exactly like every other operation:
There is no automatic per-operation routing. The paired operation-level
serversoverride was dead metadata for the same reason: the code generator does not emit per-operation servers, so it never affected where the request went.Change
serversoverride.primitive-api.codegen.json,sdk.gen.ts,types.gen.ts,openapi.generated.ts,operations.generated.ts).The rest of the description (modes, scoring, pagination, entitlement) is unchanged and already fully documents the endpoint.
make node-check-generatedpasses on the committed tree.Note
The
/send-mailoperation carries a similar "the typed SDKs route it automatically" phrase, but its situation differs (it genuinely documents a two-host body-size behavior and its default base URL matches), so it is left as-is here. Flagging it in case a follow-up wants to align the wording.