diff --git a/src/lib/openapi/util/api-operation.ts b/src/lib/openapi/util/api-operation.ts index 4853782376..672dab5cf6 100644 --- a/src/lib/openapi/util/api-operation.ts +++ b/src/lib/openapi/util/api-operation.ts @@ -1,7 +1,16 @@ import { OpenAPIV3 } from 'openapi-types'; import { OpenApiTag } from './openapi-tags'; -export interface ApiOperation +type DeprecatedOpenAPITag = + // Deprecated tag names. Please use a tag from the OpenAPITag type instead. + // + // These tag names were the original ones we used for OpenAPI, but they + // turned out to be too generic and/or didn't match the new tag naming + // schema. Because we require our operations to have one of a predefined set + // of values, it would be breaking change to remove them completely. + 'client' | 'other' | 'auth' | 'admin'; + +export interface ApiOperation extends Omit { operationId: string; tags: [Tag];