Skip to content

Commit 79c88f3

Browse files
authored
feat(api): update spec (#4610)
1 parent d04b21d commit 79c88f3

5 files changed

Lines changed: 295 additions & 283 deletions

File tree

api/spec/Makefile

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,12 @@ generate: ## Generate OpenAPI spec
1313
REF_VAL="$$AIP_REF/$$schema" SCHEMA="$$schema" yq -i '.components.schemas[strenv(SCHEMA)] = {"$$ref": strenv(REF_VAL)}' "$$FILE"; \
1414
fi; \
1515
done
16+
# Prefix addon operationIds with `product-catalog-` for the v3 MeteringAndBilling output
17+
@FILE="packages/aip/output/definitions/metering-and-billing/v3/openapi.MeteringAndBilling.yaml"; \
18+
for op in list-addons create-addon update-addon get-addon delete-addon archive-addon publish-addon; do \
19+
new_op="$${op/-addon/-product-catalog-addon}"; \
20+
OLD_OP="$$op" NEW_OP="$$new_op" yq -i '(.paths[][] | select(.operationId == strenv(OLD_OP)) | .operationId) = strenv(NEW_OP)' "$$FILE"; \
21+
done
1622
pnpm --filter @openmeter/api-spec-aip exec openapi bundle output/definitions/metering-and-billing/v3/openapi.OpenMeter.yaml -o ../../../v3/openapi.yaml
1723
cp packages/legacy/output/openapi.OpenMeter.yaml ../openapi.yaml
1824
cp packages/legacy/output/openapi.OpenMeterCloud.yaml ../openapi.cloud.yaml

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ interface InvoicesOperations {
2727
@get
2828
@operationId("get-invoice")
2929
@summary("Get a billing invoice")
30+
@extension(Shared.UnstableExtension, true)
31+
@extension(Shared.InternalExtension, true)
32+
@extension(Shared.PrivateExtension, true)
3033
get(@path invoiceId: Shared.ULID):
3134
| Shared.GetResponse<Invoice>
3235
| Common.NotFound

api/spec/packages/aip/src/konnect.tsp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ using TypeSpec.OpenAPI;
2424
*/
2525
@service(#{ title: "Konnect ${Shared.MeteringAndBillingTitle}" })
2626
@info(#{
27-
version: "0.0.1",
27+
version: "1.0.0",
2828
contact: #{ name: "Kong", url: "https://cloud.konghq.com" },
2929
})
3030
@server("https://us.api.konghq.com/v3", "United-States Production region")

0 commit comments

Comments
 (0)