/** * Schema for individual badge configuration in x-badges extension. * Badges are indicators that can be displayed in API documentation. */ export declare const XBadgeSchema: import("@scalar/typebox").TObject<{ /** The text that displays in the badge. This is required for all badges. */ name: import("@scalar/typebox").TString; /** * The position of the badge in relation to the header. * Defaults to 'after' if not specified. */ position: import("@scalar/typebox").TOptional, import("@scalar/typebox").TLiteral<"after">]>>; /** * The color of the badge. Can be defined in various formats such as color keywords, * RGB, RGBA, HSL, HSLA, and Hexadecimal. */ color: import("@scalar/typebox").TOptional; }>; /** * Schema for individual badge configuration in x-badges extension. * Badges are indicators that can be displayed in API documentation. */ export type XBadge = { /** The text that displays in the badge. This is required for all badges. */ name: string; /** * The position of the badge in relation to the header. * @default 'after' */ position?: 'before' | 'after'; /** * The color of the badge. Can be defined in various formats such as color keywords, * RGB, RGBA, HSL, HSLA, and Hexadecimal. */ color?: string; }; export declare const XBadge: import("@scalar/validation").ObjectSchema<{ name: import("@scalar/validation").StringSchema; position: import("@scalar/validation").OptionalSchema, import("@scalar/validation").LiteralSchema<"after">]>>; color: import("@scalar/validation").OptionalSchema; }>; export declare const XBadgesSchema: import("@scalar/typebox").TObject<{ /** * You can add badges to operations to use as indicators in documentation. Each operation can have multiple badges, and the displayed color is also configurable. The following example sets badges on the GET `/hello-world` operation: * * ```yaml * openapi: 3.1.0 * info: * title: x-badges * version: 1.0.0 * paths: * /hello-world: * get: * summary: Hello World * x-badges: * - name: 'Alpha' * - name: 'Beta' * position: before * - name: 'Gamma' * position: after * color: '#ffcc00' ``` */ 'x-badges': import("@scalar/typebox").TOptional, import("@scalar/typebox").TLiteral<"after">]>>; /** * The color of the badge. Can be defined in various formats such as color keywords, * RGB, RGBA, HSL, HSLA, and Hexadecimal. */ color: import("@scalar/typebox").TOptional; }>>>; }>; export type XBadges = { /** * You can add badges to operations to use as indicators in documentation. Each operation can have multiple badges, and the displayed color is also configurable. The following example sets badges on the GET `/hello-world` operation: * * ```yaml * openapi: 3.1.0 * info: * title: x-badges * version: 1.0.0 * paths: * /hello-world: * get: * summary: Hello World * x-badges: * - name: 'Alpha' * - name: 'Beta' * position: before * - name: 'Gamma' * position: after * color: '#ffcc00' ``` */ 'x-badges'?: XBadge[]; }; export declare const XBadges: import("@scalar/validation").ObjectSchema<{ 'x-badges': import("@scalar/validation").OptionalSchema, import("@scalar/validation").LiteralSchema<"after">]>>; color: import("@scalar/validation").OptionalSchema; }>>>; }>; //# sourceMappingURL=x-badge.d.ts.map