@stoplight/spectral-documentation
Version:
Your documentation is only as useful as the quality of the information you've provided, so make sure you're taking full advantage of the features OpenAPI has to offer.
258 lines (255 loc) • 9.31 kB
TypeScript
import * as _stoplight_spectral_functions from '@stoplight/spectral-functions';
import * as _stoplight_spectral_core from '@stoplight/spectral-core';
import { DiagnosticSeverity } from '@stoplight/types';
declare const _default: {
aliases: {
PathItem: string[];
OperationObject: string[];
DescribableObjects: {
description: string;
targets: {
formats: _stoplight_spectral_core.Format<void>[];
given: string[];
}[];
};
MediaTypeObjects: {
description: string;
targets: {
formats: _stoplight_spectral_core.Format<void>[];
given: string[];
}[];
};
};
rules: {
"docs-api-host": {
message: string;
description: string;
severity: DiagnosticSeverity;
formats: _stoplight_spectral_core.Format<void>[];
given: string;
then: {
field: string;
function: _stoplight_spectral_core.RulesetFunctionWithValidator<unknown, null>;
};
};
"docs-api-schemes": {
message: string;
description: string;
severity: DiagnosticSeverity;
formats: _stoplight_spectral_core.Format<void>[];
given: string;
then: {
field: string;
function: _stoplight_spectral_core.RulesetFunctionWithValidator<unknown, _stoplight_spectral_functions.SchemaOptions>;
functionOptions: {
dialect: string;
schema: {
items: {
type: string;
};
minItems: number;
type: string;
};
};
};
};
"docs-api-servers": {
message: string;
description: string;
severity: DiagnosticSeverity;
formats: _stoplight_spectral_core.Format<void>[];
given: string;
then: {
field: string;
function: _stoplight_spectral_core.RulesetFunctionWithValidator<unknown, _stoplight_spectral_functions.SchemaOptions>;
functionOptions: {
dialect: string;
schema: {
items: {
type: string;
};
minItems: number;
type: string;
};
};
};
};
"docs-api-host-not-example": {
message: string;
description: string;
severity: DiagnosticSeverity;
recommended: boolean;
formats: _stoplight_spectral_core.Format<void>[];
given: string;
then: {
field: string;
function: _stoplight_spectral_core.RulesetFunctionWithValidator<string, _stoplight_spectral_functions.PatternOptions>;
functionOptions: {
notMatch: string;
};
};
};
"docs-api-server-not-example.com": {
message: string;
description: string;
severity: DiagnosticSeverity;
recommended: boolean;
formats: _stoplight_spectral_core.Format<void>[];
given: string;
then: {
function: _stoplight_spectral_core.RulesetFunctionWithValidator<string, _stoplight_spectral_functions.PatternOptions>;
functionOptions: {
notMatch: string;
};
};
};
/**
* @author: Phil Sturgeon <https://github.com/philsturgeon>
*/
"docs-description": {
message: string;
description: string;
severity: DiagnosticSeverity;
given: string;
then: ({
field: string;
function: _stoplight_spectral_core.RulesetFunctionWithValidator<unknown, null>;
functionOptions?: undefined;
} | {
field: string;
function: _stoplight_spectral_core.RulesetFunctionWithValidator<string | number | unknown[] | Record<string, unknown>, _stoplight_spectral_functions.LengthOptions>;
functionOptions: {
min: number;
match?: undefined;
};
} | {
field: string;
function: _stoplight_spectral_core.RulesetFunctionWithValidator<string, _stoplight_spectral_functions.PatternOptions>;
functionOptions: {
match: string;
min?: undefined;
};
})[];
};
"docs-info-contact": {
message: string;
description: string;
severity: DiagnosticSeverity;
given: string;
then: {
field: string;
function: _stoplight_spectral_core.RulesetFunctionWithValidator<unknown, null>;
};
};
"docs-parameters-anything-useful": {
message: string;
description: string;
severity: DiagnosticSeverity;
formats: _stoplight_spectral_core.Format<void>[];
given: string[];
then: {
function: _stoplight_spectral_core.RulesetFunctionWithValidator<unknown, _stoplight_spectral_functions.SchemaOptions>;
functionOptions: {
schema: {
anyOf: {
required: string[];
}[];
};
};
};
};
"docs-parameter-examples-or-schema": {
message: string;
description: string;
severity: DiagnosticSeverity;
formats: _stoplight_spectral_core.Format<void>[];
given: string;
then: {
function: _stoplight_spectral_core.RulesetFunctionWithValidator<unknown, _stoplight_spectral_functions.SchemaOptions>;
functionOptions: {
schema: {
anyOf: {
required: string[];
}[];
};
};
};
};
"docs-media-type-examples-or-schema": {
message: string;
description: string;
severity: DiagnosticSeverity;
formats: _stoplight_spectral_core.Format<void>[];
given: string;
then: {
function: _stoplight_spectral_core.RulesetFunctionWithValidator<unknown, _stoplight_spectral_functions.SchemaOptions>;
functionOptions: {
schema: {
anyOf: {
required: string[];
}[];
};
};
};
};
"docs-tags-alphabetical": {
message: string;
description: string;
severity: DiagnosticSeverity;
given: string;
then: {
field: string;
function: _stoplight_spectral_core.RulesetFunctionWithValidator<unknown[] | Record<string, unknown>, _stoplight_spectral_functions.AlphabeticalOptions>;
functionOptions: {
keyedBy: string;
};
};
};
"docs-operationId-valid-in-url": {
message: string;
description: string;
severity: DiagnosticSeverity;
given: string;
then: {
field: string;
function: _stoplight_spectral_core.RulesetFunctionWithValidator<string, _stoplight_spectral_functions.PatternOptions>;
functionOptions: {
match: string;
};
};
};
"docs-tags": {
message: string;
description: string;
severity: DiagnosticSeverity;
given: string;
then: {
field: string;
function: _stoplight_spectral_core.RulesetFunctionWithValidator<unknown, _stoplight_spectral_functions.SchemaOptions>;
functionOptions: {
schema: {
type: string;
minItems: number;
};
};
};
};
"docs-operation-tags": {
message: string;
description: string;
severity: DiagnosticSeverity;
given: string;
then: {
field: string;
function: _stoplight_spectral_core.RulesetFunctionWithValidator<unknown, _stoplight_spectral_functions.SchemaOptions>;
functionOptions: {
schema: {
type: string;
minItems: number;
};
};
};
};
};
};
export { _default as default };