feat(api): update aip schema (#3636)

Author: tothandras

api/api.gen.go

@@ -178,7 +178,6 @@ paths:
       operationId: createAddon
       summary: Create an add-on
       description: Create a new add-on.
-      parameters: []
       responses:
         '201':
           description: The request has succeeded and a new resource has been created as a result.
@@ -1767,7 +1766,6 @@ paths:
         New pending line items will be created for the period between now() and the next billing cycle's begining date for any metered item.
 
         The call can return multiple invoices if the pending line items are in different currencies.
-      parameters: []
       responses:
         '201':
           description: The request has succeeded and a new resource has been created as a result.
@@ -2611,7 +2609,6 @@ paths:
 
         Billing profiles are representations of a customer's billing information. Customer overrides
         can be applied to a billing profile to customize the billing behavior for a specific customer.
-      parameters: []
       responses:
         '201':
           description: The request has succeeded and a new resource has been created as a result.
@@ -2907,7 +2904,6 @@ paths:
       operationId: createCustomer
       summary: Create customer
       description: Create a new customer.
-      parameters: []
       responses:
         '201':
           description: The request has succeeded and a new resource has been created as a result.
@@ -3925,7 +3921,6 @@ paths:
         Returns debug metrics (in OpenMetrics format) like the number of ingested events since mindnight UTC.
 
         The OpenMetrics Counter(s) reset every day at midnight UTC.
-      parameters: []
       responses:
         '200':
           description: The request has succeeded.
@@ -4323,9 +4318,8 @@ paths:
         - Events
     post:
       operationId: ingestEvents
-      parameters: []
       description: Ingests an event or batch of events following the CloudEvents specification.
-      summary: 'Ingest events  '
+      summary: Ingest events
       responses:
         '204':
           description: 'There is no content to send for this request, but the headers may be useful. '
@@ -4476,7 +4470,6 @@ paths:
         For metered features you can pass additional filters that will be applied when calculating feature usage, based on the meter's groupBy fields.
         Only meters with SUM and COUNT aggregation are supported for features.
         Features cannot be updated later, only archived.
-      parameters: []
       responses:
         '201':
           description: The request has succeeded and a new resource has been created as a result.
@@ -4849,7 +4842,6 @@ paths:
       operationId: listCurrencies
       summary: List supported currencies
       description: List all supported currencies.
-      parameters: []
       responses:
         '200':
           description: The request has succeeded.
@@ -5433,7 +5425,6 @@ paths:
       operationId: createMeter
       summary: Create meter
       description: Create a meter.
-      parameters: []
       responses:
         '201':
           description: The request has succeeded and a new resource has been created as a result.
@@ -6135,7 +6126,6 @@ paths:
       operationId: createNotificationChannel
       summary: Create a notification channel
       description: Create a new notification channel.
-      parameters: []
       responses:
         '201':
           description: The request has succeeded and a new resource has been created as a result.
@@ -6803,7 +6793,6 @@ paths:
       operationId: createNotificationRule
       summary: Create a notification rule
       description: Create a new notification rule.
-      parameters: []
       responses:
         '201':
           description: The request has succeeded and a new resource has been created as a result.
@@ -7281,7 +7270,6 @@ paths:
       operationId: createPlan
       summary: Create a plan
       description: Create a new plan.
-      parameters: []
       responses:
         '201':
           description: The request has succeeded and a new resource has been created as a result.
@@ -8313,7 +8301,6 @@ paths:
       operationId: createPortalToken
       summary: Create consumer portal token
       description: Create a consumer portal token.
-      parameters: []
       responses:
         '200':
           description: The request has succeeded.
@@ -8444,7 +8431,6 @@ paths:
       operationId: invalidatePortalTokens
       summary: Invalidate portal tokens
       description: Invalidates consumer portal tokens by ID or subject.
-      parameters: []
       responses:
         '204':
           description: 'There is no content to send for this request, but the headers may be useful. '
@@ -8510,7 +8496,6 @@ paths:
       operationId: createStripeCheckoutSession
       summary: Create checkout session
       description: Create checkout session.
-      parameters: []
       responses:
         '201':
           description: The request has succeeded and a new resource has been created as a result.
@@ -8579,7 +8564,6 @@ paths:
       operationId: listSubjects
       summary: List subjects
       description: List subjects.
-      parameters: []
       responses:
         '200':
           description: The request has succeeded.
@@ -8641,7 +8625,6 @@ paths:
 
         If the subject doesn't exist, it will be created.
         If the subject exists, it will be partially updated with the provided fields.
-      parameters: []
       responses:
         '200':
           description: The request has succeeded.
@@ -9668,7 +9651,6 @@ paths:
     post:
       operationId: createSubscription
       summary: Create subscription
-      parameters: []
       responses:
         '201':
           description: The request has succeeded and a new resource has been created as a result.

api/client/go/client.gen.go

@@ -177,7 +177,6 @@ paths:
       operationId: createAddon
       summary: Create an add-on
       description: Create a new add-on.
-      parameters: []
       responses:
         '201':
           description: The request has succeeded and a new resource has been created as a result.
@@ -1766,7 +1765,6 @@ paths:
         New pending line items will be created for the period between now() and the next billing cycle's begining date for any metered item.
 
         The call can return multiple invoices if the pending line items are in different currencies.
-      parameters: []
       responses:
         '201':
           description: The request has succeeded and a new resource has been created as a result.
@@ -2610,7 +2608,6 @@ paths:
 
         Billing profiles are representations of a customer's billing information. Customer overrides
         can be applied to a billing profile to customize the billing behavior for a specific customer.
-      parameters: []
       responses:
         '201':
           description: The request has succeeded and a new resource has been created as a result.
@@ -2906,7 +2903,6 @@ paths:
       operationId: createCustomer
       summary: Create customer
       description: Create a new customer.
-      parameters: []
       responses:
         '201':
           description: The request has succeeded and a new resource has been created as a result.
@@ -3927,7 +3923,6 @@ paths:
         Returns debug metrics (in OpenMetrics format) like the number of ingested events since mindnight UTC.
 
         The OpenMetrics Counter(s) reset every day at midnight UTC.
-      parameters: []
       responses:
         '200':
           description: The request has succeeded.
@@ -4325,9 +4320,8 @@ paths:
         - Events
     post:
       operationId: ingestEvents
-      parameters: []
       description: Ingests an event or batch of events following the CloudEvents specification.
-      summary: 'Ingest events  '
+      summary: Ingest events
       responses:
         '204':
           description: 'There is no content to send for this request, but the headers may be useful. '
@@ -4478,7 +4472,6 @@ paths:
         For metered features you can pass additional filters that will be applied when calculating feature usage, based on the meter's groupBy fields.
         Only meters with SUM and COUNT aggregation are supported for features.
         Features cannot be updated later, only archived.
-      parameters: []
       responses:
         '201':
           description: The request has succeeded and a new resource has been created as a result.
@@ -4851,7 +4844,6 @@ paths:
       operationId: listCurrencies
       summary: List supported currencies
       description: List all supported currencies.
-      parameters: []
       responses:
         '200':
           description: The request has succeeded.
@@ -5435,7 +5427,6 @@ paths:
       operationId: createMeter
       summary: Create meter
       description: Create a meter.
-      parameters: []
       responses:
         '201':
           description: The request has succeeded and a new resource has been created as a result.
@@ -6137,7 +6128,6 @@ paths:
       operationId: createNotificationChannel
       summary: Create a notification channel
       description: Create a new notification channel.
-      parameters: []
       responses:
         '201':
           description: The request has succeeded and a new resource has been created as a result.
@@ -6805,7 +6795,6 @@ paths:
       operationId: createNotificationRule
       summary: Create a notification rule
       description: Create a new notification rule.
-      parameters: []
       responses:
         '201':
           description: The request has succeeded and a new resource has been created as a result.
@@ -7283,7 +7272,6 @@ paths:
       operationId: createPlan
       summary: Create a plan
       description: Create a new plan.
-      parameters: []
       responses:
         '201':
           description: The request has succeeded and a new resource has been created as a result.
@@ -8315,7 +8303,6 @@ paths:
       operationId: createPortalToken
       summary: Create consumer portal token
       description: Create a consumer portal token.
-      parameters: []
       responses:
         '200':
           description: The request has succeeded.
@@ -8446,7 +8433,6 @@ paths:
       operationId: invalidatePortalTokens
       summary: Invalidate portal tokens
       description: Invalidates consumer portal tokens by ID or subject.
-      parameters: []
       responses:
         '204':
           description: 'There is no content to send for this request, but the headers may be useful. '
@@ -8512,7 +8498,6 @@ paths:
       operationId: createStripeCheckoutSession
       summary: Create checkout session
       description: Create checkout session.
-      parameters: []
       responses:
         '201':
           description: The request has succeeded and a new resource has been created as a result.
@@ -8581,7 +8566,6 @@ paths:
       operationId: listSubjects
       summary: List subjects
       description: List subjects.
-      parameters: []
       responses:
         '200':
           description: The request has succeeded.
@@ -8643,7 +8627,6 @@ paths:
 
         If the subject doesn't exist, it will be created.
         If the subject exists, it will be partially updated with the provided fields.
-      parameters: []
       responses:
         '200':
           description: The request has succeeded.
@@ -9670,7 +9653,6 @@ paths:
     post:
       operationId: createSubscription
       summary: Create subscription
-      parameters: []
       responses:
         '201':
           description: The request has succeeded and a new resource has been created as a result.

api/openapi.cloud.yaml

@@ -0,0 +1,14 @@
+components:
+  securitySchemes:
+    personalAccessToken:
+      type: http
+      scheme: bearer
+      bearerFormat: Token
+    systemAccountAccessToken:
+      type: http
+      scheme: bearer
+      bearerFormat: Token
+    konnectAccessToken:
+      type: http
+      scheme: bearer
+      bearerFormat: JWT

api/openapi.yaml

@@ -1,25 +1,26 @@
 import { defineLinter } from '@typespec/compiler'
 import { casingAIPRule, casingRule } from './rules/casing.js'
 import { docDecoratorRule } from './rules/docs.js'
-import { friendlyNameRule } from './rules/friendlyName.js'
-import { operationSummaryRule } from './rules/operationSummary.js'
+import { friendlyNameRule } from './rules/friendly-name.js'
+import { operationSummaryRule } from './rules/operation-summary.js'
+import { operationIdKebabCaseRule } from './rules/operation-id.js'
 import { noNullableRule } from './rules/no-nullable.js'
 import { compositionOverInheritanceRule } from './rules/composition-over-inheritance.js'
 
 const packageName = '@openmeter/api-spec'
 
+// See example rules: https://github.com/Azure/typespec-azure/tree/main/packages/typespec-azure-core/src/rules
 const rules = [
   casingRule,
   casingAIPRule,
   docDecoratorRule,
   friendlyNameRule,
   noNullableRule,
   operationSummaryRule,
+  operationIdKebabCaseRule,
   compositionOverInheritanceRule,
 ]
 
-// Linter experimentation
-// See: https://github.com/Azure/typespec-azure/tree/main/packages/typespec-azure-core/src/rules
 export const $linter = defineLinter({
   rules,
   ruleSets: {
@@ -40,6 +41,7 @@ export const $linter = defineLinter({
         [`${packageName}/${friendlyNameRule.name}`]: true,
         [`${packageName}/${noNullableRule.name}`]: true,
         [`${packageName}/${operationSummaryRule.name}`]: true,
+        [`${packageName}/${operationIdKebabCaseRule.name}`]: true,
         [`${packageName}/${compositionOverInheritanceRule.name}`]: true,
       },
     },

api/spec/common/definitions/security.yaml

@@ -0,0 +1,35 @@
+import { createRule, paramMessage } from '@typespec/compiler'
+import { isKebabCase } from './utils.js'
+
+export const operationIdKebabCaseRule = createRule({
+  name: 'operation-id-kebab-case',
+  severity: 'error',
+  description: 'Ensure @operationId values are in kebab-case.',
+  messages: {
+    default: paramMessage`The operationId "${'operationId'}" should be in kebab-case.`,
+  },
+  create: (context) => ({
+    operation: (node) => {
+      const operationIdDecorator = node.decorators.find(
+        (d) => d.decorator.name === '$operationId',
+      )
+
+      if (operationIdDecorator) {
+        const operationId = operationIdDecorator.args[0]?.jsValue
+        if (
+          operationId &&
+          typeof operationId === 'string' &&
+          !isKebabCase(operationId)
+        ) {
+          context.reportDiagnostic({
+            format: {
+              operationId,
+            },
+            target: node,
+            messageId: 'default',
+          })
+        }
+      }
+    },
+  }),
+})