arrest
Version:
OpenAPI v3 compliant REST framework for Node.js, with support for MongoDB and JSON-Schema
472 lines (471 loc) • 10.5 kB
TypeScript
import { OpenAPIV3 } from 'openapi-police';
export declare const DEFAULT_DOCUMENT: OpenAPIV3.Document;
export declare const JSON_SCHEMA_DRAFT_2020_12: {
$schema: string;
$id: string;
title: string;
definitions: {
schemaArray: {
type: string;
minItems: number;
items: {
$ref: string;
};
};
nonNegativeInteger: {
type: string;
minimum: number;
};
nonNegativeIntegerDefault0: {
allOf: ({
$ref: string;
default?: undefined;
} | {
default: number;
$ref?: undefined;
})[];
};
simpleTypes: {
enum: string[];
};
stringArray: {
type: string;
items: {
type: string;
};
uniqueItems: boolean;
default: never[];
};
};
type: string[];
properties: {
$id: {
type: string;
format: string;
};
$schema: {
type: string;
format: string;
};
$ref: {
type: string;
format: string;
};
$comment: {
type: string;
};
title: {
type: string;
};
description: {
type: string;
};
default: boolean;
readOnly: {
type: string;
default: boolean;
};
examples: {
type: string;
items: boolean;
};
multipleOf: {
type: string;
exclusiveMinimum: number;
};
maximum: {
type: string;
};
exclusiveMaximum: {
type: string;
};
minimum: {
type: string;
};
exclusiveMinimum: {
type: string;
};
maxLength: {
$ref: string;
};
minLength: {
$ref: string;
};
pattern: {
type: string;
format: string;
};
additionalItems: {
$ref: string;
};
items: {
anyOf: {
$ref: string;
}[];
default: boolean;
};
maxItems: {
$ref: string;
};
minItems: {
$ref: string;
};
uniqueItems: {
type: string;
default: boolean;
};
contains: {
$ref: string;
};
maxProperties: {
$ref: string;
};
minProperties: {
$ref: string;
};
required: {
$ref: string;
};
additionalProperties: {
$ref: string;
};
definitions: {
type: string;
additionalProperties: {
$ref: string;
};
default: {};
};
properties: {
type: string;
additionalProperties: {
$ref: string;
};
default: {};
};
patternProperties: {
type: string;
additionalProperties: {
$ref: string;
};
propertyNames: {
format: string;
};
default: {};
};
dependencies: {
type: string;
additionalProperties: {
anyOf: {
$ref: string;
}[];
};
};
dependentRequired: {
type: string;
additionalProperties: {
$ref: string;
};
};
dependentSchemas: {
type: string;
additionalProperties: {
$ref: string;
};
};
propertyNames: {
$ref: string;
};
const: boolean;
enum: {
type: string;
items: boolean;
minItems: number;
uniqueItems: boolean;
};
type: {
anyOf: ({
$ref: string;
type?: undefined;
items?: undefined;
minItems?: undefined;
uniqueItems?: undefined;
} | {
type: string;
items: {
$ref: string;
};
minItems: number;
uniqueItems: boolean;
$ref?: undefined;
})[];
};
format: {
type: string;
};
contentMediaType: {
type: string;
};
contentEncoding: {
type: string;
};
if: {
$ref: string;
};
then: {
$ref: string;
};
else: {
$ref: string;
};
allOf: {
$ref: string;
};
anyOf: {
$ref: string;
};
oneOf: {
$ref: string;
};
not: {
$ref: string;
};
};
default: boolean;
};
/**
* @deprecated Use JSON_SCHEMA_DRAFT_2020_12 instead. This alias is provided for backward compatibility.
*/
export declare const JSON_SCHEMA_DRAFT_7: {
$schema: string;
$id: string;
title: string;
definitions: {
schemaArray: {
type: string;
minItems: number;
items: {
$ref: string;
};
};
nonNegativeInteger: {
type: string;
minimum: number;
};
nonNegativeIntegerDefault0: {
allOf: ({
$ref: string;
default?: undefined;
} | {
default: number;
$ref?: undefined;
})[];
};
simpleTypes: {
enum: string[];
};
stringArray: {
type: string;
items: {
type: string;
};
uniqueItems: boolean;
default: never[];
};
};
type: string[];
properties: {
$id: {
type: string;
format: string;
};
$schema: {
type: string;
format: string;
};
$ref: {
type: string;
format: string;
};
$comment: {
type: string;
};
title: {
type: string;
};
description: {
type: string;
};
default: boolean;
readOnly: {
type: string;
default: boolean;
};
examples: {
type: string;
items: boolean;
};
multipleOf: {
type: string;
exclusiveMinimum: number;
};
maximum: {
type: string;
};
exclusiveMaximum: {
type: string;
};
minimum: {
type: string;
};
exclusiveMinimum: {
type: string;
};
maxLength: {
$ref: string;
};
minLength: {
$ref: string;
};
pattern: {
type: string;
format: string;
};
additionalItems: {
$ref: string;
};
items: {
anyOf: {
$ref: string;
}[];
default: boolean;
};
maxItems: {
$ref: string;
};
minItems: {
$ref: string;
};
uniqueItems: {
type: string;
default: boolean;
};
contains: {
$ref: string;
};
maxProperties: {
$ref: string;
};
minProperties: {
$ref: string;
};
required: {
$ref: string;
};
additionalProperties: {
$ref: string;
};
definitions: {
type: string;
additionalProperties: {
$ref: string;
};
default: {};
};
properties: {
type: string;
additionalProperties: {
$ref: string;
};
default: {};
};
patternProperties: {
type: string;
additionalProperties: {
$ref: string;
};
propertyNames: {
format: string;
};
default: {};
};
dependencies: {
type: string;
additionalProperties: {
anyOf: {
$ref: string;
}[];
};
};
dependentRequired: {
type: string;
additionalProperties: {
$ref: string;
};
};
dependentSchemas: {
type: string;
additionalProperties: {
$ref: string;
};
};
propertyNames: {
$ref: string;
};
const: boolean;
enum: {
type: string;
items: boolean;
minItems: number;
uniqueItems: boolean;
};
type: {
anyOf: ({
$ref: string;
type?: undefined;
items?: undefined;
minItems?: undefined;
uniqueItems?: undefined;
} | {
type: string;
items: {
$ref: string;
};
minItems: number;
uniqueItems: boolean;
$ref?: undefined;
})[];
};
format: {
type: string;
};
contentMediaType: {
type: string;
};
contentEncoding: {
type: string;
};
if: {
$ref: string;
};
then: {
$ref: string;
};
else: {
$ref: string;
};
allOf: {
$ref: string;
};
anyOf: {
$ref: string;
};
oneOf: {
$ref: string;
};
not: {
$ref: string;
};
};
default: boolean;
};