Skip to content

Commit 7fc84c4

Browse files
tothandrastothandras
authored
feat(spec): update v3 spec (#4381)
1 parent 7cddb66 commit 7fc84c4

9 files changed

Lines changed: 238 additions & 298 deletions

File tree

‎api/spec/packages/aip/src/events/operations.tsp‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,6 @@ interface EventsOperations {
7272
* List ingested events.
7373
*/
7474
@extension(Shared.UnstableExtension, true)
75-
@extension(Shared.InternalExtension, true)
7675
@get
7776
@operationId("list-metering-events")
7877
@summary("List metering events")

‎api/spec/packages/aip/src/features/operations.tsp‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,6 @@ interface FeatureOperations {
3434
@operationId("list-features")
3535
@summary("List features")
3636
@extension(Shared.UnstableExtension, true)
37-
@extension(Shared.InternalExtension, true)
3837
list(
3938
...Common.PagePaginationQuery,
4039

@@ -69,7 +68,6 @@ interface FeatureOperations {
6968
@operationId("create-feature")
7069
@summary("Create feature")
7170
@extension(Shared.UnstableExtension, true)
72-
@extension(Shared.InternalExtension, true)
7371
create(
7472
@body
7573
feature: Shared.CreateRequest<Feature>,
@@ -83,7 +81,6 @@ interface FeatureOperations {
8381
@operationId("get-feature")
8482
@summary("Get feature")
8583
@extension(Shared.UnstableExtension, true)
86-
@extension(Shared.InternalExtension, true)
8784
get(@path featureId: Shared.ULID):
8885
| Shared.GetResponse<Feature>
8986
| Common.ErrorResponses
@@ -98,7 +95,6 @@ interface FeatureOperations {
9895
@operationId("update-feature")
9996
@summary("Update feature")
10097
@extension(Shared.UnstableExtension, true)
101-
@extension(Shared.InternalExtension, true)
10298
update(
10399
@path featureId: Shared.ULID,
104100
@body feature: FeatureUpdateRequest,
@@ -112,7 +108,6 @@ interface FeatureOperations {
112108
@operationId("delete-feature")
113109
@summary("Delete feature")
114110
@extension(Shared.UnstableExtension, true)
115-
@extension(Shared.InternalExtension, true)
116111
delete(
117112
@path featureId: Shared.ULID,
118113
): Shared.DeleteResponse | Common.ErrorResponses | Common.NotFound;
@@ -123,7 +118,6 @@ interface FeatureCostOperations {
123118
* Query the cost of a feature.
124119
*/
125120
@extension(Shared.UnstableExtension, true)
126-
@extension(Shared.InternalExtension, true)
127121
@post
128122
@route("/query")
129123
@operationId("query-feature-cost")

‎api/spec/packages/aip/src/llmcost/operations.tsp‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,6 @@ interface LLMCostPricesOperations {
5252
* List global LLM cost prices. Returns prices with overrides applied if any.
5353
*/
5454
@extension(Shared.UnstableExtension, true)
55-
@extension(Shared.InternalExtension, true)
5655
@get
5756
@operationId("list-llm-cost-prices")
5857
@summary("List LLM cost prices")
@@ -86,7 +85,6 @@ interface LLMCostPricesOperations {
8685
* any.
8786
*/
8887
@extension(Shared.UnstableExtension, true)
89-
@extension(Shared.InternalExtension, true)
9088
@get
9189
@operationId("get-llm-cost-price")
9290
@summary("Get LLM cost price")
@@ -103,7 +101,6 @@ interface LLMCostOverridesOperations {
103101
* List per-namespace price overrides.
104102
*/
105103
@extension(Shared.UnstableExtension, true)
106-
@extension(Shared.InternalExtension, true)
107104
@get
108105
@operationId("list-llm-cost-overrides")
109106
@summary("List LLM cost overrides")
@@ -118,7 +115,6 @@ interface LLMCostOverridesOperations {
118115
* Create a per-namespace price override.
119116
*/
120117
@extension(Shared.UnstableExtension, true)
121-
@extension(Shared.InternalExtension, true)
122118
@post
123119
@operationId("create-llm-cost-override")
124120
@summary("Create LLM cost override")
@@ -130,7 +126,6 @@ interface LLMCostOverridesOperations {
130126
* Delete a per-namespace price override.
131127
*/
132128
@extension(Shared.UnstableExtension, true)
133-
@extension(Shared.InternalExtension, true)
134129
@delete
135130
@operationId("delete-llm-cost-override")
136131
@summary("Delete LLM cost override")

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

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,6 @@ interface MetersOperations {
8888
* Update a meter.
8989
*/
9090
@extension(Shared.UnstableExtension, true)
91-
@extension(Shared.InternalExtension, true)
9291
@put
9392
@operationId("update-meter")
9493
@summary("Update meter")
@@ -123,7 +122,6 @@ interface MetersQueryOperations {
123122
* when `customer_id` is in the query's `group_by_dimensions`.
124123
*/
125124
@extension(Shared.UnstableExtension, true)
126-
@extension(Shared.InternalExtension, true)
127125
@post
128126
@operationId("query-meter")
129127
@summary("Query meter")
@@ -135,7 +133,6 @@ interface MetersQueryOperations {
135133

136134
#suppress "@openmeter/api-spec-aip/operation-summary" "Avoid duplicating the summary in OpenAPI yaml"
137135
@extension(Shared.UnstableExtension, true)
138-
@extension(Shared.InternalExtension, true)
139136
@opExample(
140137
#{
141138
returnType: #{

‎api/spec/packages/aip/src/openmeter.tsp‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,19 +20,19 @@ using TypeSpec.Http;
2020
using TypeSpec.OpenAPI;
2121

2222
/**
23-
* OpenMeter is a cloud native usage metering and billing service. The OpenMeter
24-
* API allows you to ingest events, query meter usage, and manage resources.
23+
* OpenMeter is a cloud native usage metering and billing service. The API allows
24+
* you to ingest events, query meter usage, and manage resources.
2525
*/
26-
@service(#{ title: "OpenMeter API" })
27-
@info(#{
28-
version: "1.0.0",
29-
license: #{
30-
name: "Apache 2.0",
31-
url: "http://www.apache.org/licenses/LICENSE-2.0.html",
32-
},
33-
termsOfService: "https://openmeter.cloud/terms-of-service",
34-
})
35-
@server("https://openmeter.cloud/api/v3", "Cloud")
26+
@service(#{ title: "OpenMeter and Konnect Metering & Billing API" })
27+
@info(#{ version: "0.0.1" })
28+
@server("https://openmeter.cloud/api/v3", "OpenMeter Cloud")
29+
@server(
30+
"https://{region}.api.konghq.com/v3",
31+
"Production region",
32+
{
33+
region: "us" | "eu" | "au" | "me" | "in" = "us",
34+
}
35+
)
3636
@server(
3737
"http://localhost:{port}/api/v3",
3838
"Local",

‎api/spec/packages/aip/src/productcatalog/operations.tsp‎

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@ interface PlanOperations {
3838
@operationId("list-plans")
3939
@summary("List plans")
4040
@extension(Shared.UnstableExtension, true)
41-
@extension(Shared.InternalExtension, true)
4241
listPlans(
4342
...Common.PagePaginationQuery,
4443

@@ -68,7 +67,6 @@ interface PlanOperations {
6867
@operationId("create-plan")
6968
@summary("Create plan")
7069
@extension(Shared.UnstableExtension, true)
71-
@extension(Shared.InternalExtension, true)
7270
createPlan(
7371
@body plan: Shared.CreateRequest<Plan>,
7472
): Shared.CreateResponse<Plan> | Common.ErrorResponses;
@@ -81,7 +79,6 @@ interface PlanOperations {
8179
@operationId("update-plan")
8280
@summary("Update plan")
8381
@extension(Shared.UnstableExtension, true)
84-
@extension(Shared.InternalExtension, true)
8582
updatePlan(
8683
@path planId: Shared.ULID,
8784
@body plan: Shared.UpsertRequest<Plan>,
@@ -99,7 +96,6 @@ interface PlanOperations {
9996
@operationId("get-plan")
10097
@summary("Get plan")
10198
@extension(Shared.UnstableExtension, true)
102-
@extension(Shared.InternalExtension, true)
10399
getPlan(@path planId: Shared.ULID):
104100
| Shared.GetResponse<Plan>
105101
| Common.ErrorResponses
@@ -114,7 +110,6 @@ interface PlanOperations {
114110
@operationId("delete-plan")
115111
@summary("Delete plan")
116112
@extension(Shared.UnstableExtension, true)
117-
@extension(Shared.InternalExtension, true)
118113
deletePlan(
119114
@path planId: Shared.ULID,
120115
): Shared.DeleteResponse | Common.ErrorResponses | Common.NotFound;
@@ -127,7 +122,6 @@ interface PlanOperations {
127122
@operationId("archive-plan")
128123
@summary("Archive plan version")
129124
@extension(Shared.UnstableExtension, true)
130-
@extension(Shared.InternalExtension, true)
131125
archivePlan(
132126
@path planId: Shared.ULID,
133127
): Shared.UpdateResponse<Plan> | Common.ErrorResponses | Common.NotFound;
@@ -140,7 +134,6 @@ interface PlanOperations {
140134
@operationId("publish-plan")
141135
@summary("Publish plan version")
142136
@extension(Shared.UnstableExtension, true)
143-
@extension(Shared.InternalExtension, true)
144137
publishPlan(
145138
@path planId: Shared.ULID,
146139
): Shared.UpdateResponse<Plan> | Common.ErrorResponses | Common.NotFound;
@@ -171,7 +164,6 @@ interface AddonOperations {
171164
@operationId("list-addons")
172165
@summary("List add-ons")
173166
@extension(Shared.UnstableExtension, true)
174-
@extension(Shared.InternalExtension, true)
175167
listAddons(
176168
...Common.PagePaginationQuery,
177169

@@ -204,7 +196,6 @@ interface AddonOperations {
204196
@operationId("create-addon")
205197
@summary("Create add-on")
206198
@extension(Shared.UnstableExtension, true)
207-
@extension(Shared.InternalExtension, true)
208199
createAddon(
209200
@body addon: Shared.CreateRequest<Addon>,
210201
): Shared.CreateResponse<Addon> | Common.ErrorResponses;
@@ -217,7 +208,6 @@ interface AddonOperations {
217208
@operationId("update-addon")
218209
@summary("Update add-on")
219210
@extension(Shared.UnstableExtension, true)
220-
@extension(Shared.InternalExtension, true)
221211
updateAddon(
222212
@path addonId: Shared.ULID,
223213
@body addon: Shared.UpsertRequest<Addon>,
@@ -235,7 +225,6 @@ interface AddonOperations {
235225
@operationId("get-addon")
236226
@summary("Get add-on")
237227
@extension(Shared.UnstableExtension, true)
238-
@extension(Shared.InternalExtension, true)
239228
getAddon(@path addonId: Shared.ULID):
240229
| Shared.GetResponse<Addon>
241230
| Common.ErrorResponses
@@ -250,7 +239,6 @@ interface AddonOperations {
250239
@operationId("delete-addon")
251240
@summary("Soft delete add-on")
252241
@extension(Shared.UnstableExtension, true)
253-
@extension(Shared.InternalExtension, true)
254242
deleteAddon(
255243
@path addonId: Shared.ULID,
256244
): Shared.DeleteResponse | Common.ErrorResponses | Common.NotFound;
@@ -263,7 +251,6 @@ interface AddonOperations {
263251
@operationId("archive-addon")
264252
@summary("Archive add-on version")
265253
@extension(Shared.UnstableExtension, true)
266-
@extension(Shared.InternalExtension, true)
267254
archiveAddon(
268255
@path addonId: Shared.ULID,
269256
): Shared.UpdateResponse<Addon> | Common.ErrorResponses | Common.NotFound;
@@ -276,7 +263,6 @@ interface AddonOperations {
276263
@operationId("publish-addon")
277264
@summary("Publish add-on version")
278265
@extension(Shared.UnstableExtension, true)
279-
@extension(Shared.InternalExtension, true)
280266
publishAddon(
281267
@path addonId: Shared.ULID,
282268
): Shared.UpdateResponse<Addon> | Common.ErrorResponses | Common.NotFound;
@@ -290,7 +276,6 @@ interface PlanAddonOperations {
290276
@operationId("list-plan-addons")
291277
@summary("List add-ons for plan")
292278
@extension(Shared.UnstableExtension, true)
293-
@extension(Shared.InternalExtension, true)
294279
listPlanAddons(
295280
@path planId: Shared.ULID,
296281
...Common.PagePaginationQuery,
@@ -303,7 +288,6 @@ interface PlanAddonOperations {
303288
@operationId("create-plan-addon")
304289
@summary("Add add-on to plan")
305290
@extension(Shared.UnstableExtension, true)
306-
@extension(Shared.InternalExtension, true)
307291
createPlanAddon(
308292
@path planId: Shared.ULID,
309293
@body plan_addon: Shared.CreateRequest<PlanAddon>,
@@ -317,7 +301,6 @@ interface PlanAddonOperations {
317301
@operationId("get-plan-addon")
318302
@summary("Get add-on association for plan")
319303
@extension(Shared.UnstableExtension, true)
320-
@extension(Shared.InternalExtension, true)
321304
getPlanAddon(
322305
@path planId: Shared.ULID,
323306
@path planAddonId: Shared.ULID,
@@ -331,7 +314,6 @@ interface PlanAddonOperations {
331314
@operationId("update-plan-addon")
332315
@summary("Update add-on association for plan")
333316
@extension(Shared.UnstableExtension, true)
334-
@extension(Shared.InternalExtension, true)
335317
updatePlanAddon(
336318
@path planId: Shared.ULID,
337319
@path planAddonId: Shared.ULID,
@@ -346,7 +328,6 @@ interface PlanAddonOperations {
346328
@operationId("delete-plan-addon")
347329
@summary("Remove add-on from plan")
348330
@extension(Shared.UnstableExtension, true)
349-
@extension(Shared.InternalExtension, true)
350331
deletePlanAddon(
351332
@path planId: Shared.ULID,
352333
@path planAddonId: Shared.ULID,

‎api/spec/packages/aip/src/subscriptions/operations.tsp‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,7 @@ interface SubscriptionAddonOperations {
167167
@get
168168
@operationId("list-subscription-addons")
169169
@summary("List subscription addons")
170+
@extension(Shared.UnstableExtension, true)
170171
list(
171172
@path subscriptionId: Shared.ULID,
172173
...Common.PagePaginationQuery,
@@ -183,7 +184,6 @@ interface SubscriptionAddonOperations {
183184
@operationId("get-subscription-addon")
184185
@summary("Get add-on association for subscription")
185186
@extension(Shared.UnstableExtension, true)
186-
@extension(Shared.InternalExtension, true)
187187
getAddon(
188188
@path subscriptionId: Shared.ULID,
189189
@path subscriptionAddonId: Shared.ULID,

0 commit comments

Comments
 (0)