Skip to content

Commit fac9b40

Browse files
tothandrasclaude
andcommitted
docs(sdk): trim verbose spec comments
Comment-only: shorten the @FriendlyName note on the meter CSV op and the strip-name-prefixes comment in tspconfig.yaml. No generated-output change. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent bc8594b commit fac9b40

2 files changed

Lines changed: 1 addition & 8 deletions

File tree

api/spec/packages/aip/src/meters/operations.tsp

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -161,9 +161,6 @@ interface MetersQueryOperations {
161161
},
162162
#{ title: "Grouped by customer and dimensions" }
163163
)
164-
// `@friendlyName` gives this `@sharedRoute` sibling a distinct client SDK
165-
// method name (`queryMeterCsv`) without changing the shared OpenAPI
166-
// `operationId`; otherwise it would collide with `query` as `queryMeter_2`.
167164
@friendlyName("queryMeterCsv")
168165
@post
169166
@operationId("query-meter")

api/spec/packages/aip/tspconfig.yaml

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,7 @@ options:
1919
# emitter, but only OpenMeter gets a generated TypeScript client.
2020
include-services:
2121
- 'OpenMeter'
22-
# Strip these prefixes from generated type and sub-client class names so the
23-
# SDK surface reads `PriceType` / `FeaturesClient` instead of
24-
# `BillingPriceType` / `OpenMeterFeaturesClient`. Collision-guarded: e.g.
25-
# `BillingAddress` keeps its prefix because a distinct `Address` exists. The
26-
# root `OpenMeterClient` is never stripped.
22+
# Strip prefixes from generated types
2723
strip-name-prefixes:
2824
- 'Billing'
2925
- 'OpenMeter'

0 commit comments

Comments
 (0)