mirror of
https://github.com/Unleash/unleash.git
synced 2025-10-18 11:14:57 +02:00
ff83f934d5
## About the changes This removes some old and unused files from an initial test of setting up openapi that's currently not working:  Also, adds the ability of marking endpoints as (note, the endpoints are made up just for illustration purposes): - Enterprise only  - Beta:  - Both:  --------- Co-authored-by: Thomas Heartman <thomas@getunleash.io>
20 lines
785 B
TypeScript
20 lines
785 B
TypeScript
import type { OpenAPIV3 } from 'openapi-types';
|
|
import type { OpenApiTag } from './openapi-tags.js';
|
|
|
|
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<Tag = OpenApiTag | DeprecatedOpenAPITag>
|
|
extends Omit<OpenAPIV3.OperationObject, 'tags'> {
|
|
operationId: string;
|
|
tags: [Tag];
|
|
beta?: boolean;
|
|
enterpriseOnly?: boolean;
|
|
}
|