066613e2a6
* Allow routes to define some payload config values * Documentation typo * Move hapi `payload` config under `body` + additional validations * Update API docs * Amend explanation in API docs * Add stream and buffer types to @kbn/config-schema * Fixes based on PR feedback: - Add 'patch' and 'options' to valid RouteMethod - Add tests for all the new flags - Allow `stream` and `buffer` schema in the body validations (findings from tests) * API documentation update * Fix type definitions * Fix the NITs in the PR comments + better typing inheritance * API docs update * Fix APM-legacy wrapper's types * Fix KibanaRequest.from type exposure of hapi in API docs * Move RouterRoute interface back to private + Expose some public docs * Update @kbn/config-schema docs
53 lines
1.6 KiB
TypeScript
53 lines
1.6 KiB
TypeScript
/*
|
|
* Licensed to Elasticsearch B.V. under one or more contributor
|
|
* license agreements. See the NOTICE file distributed with
|
|
* this work for additional information regarding copyright
|
|
* ownership. Elasticsearch B.V. licenses this file to you under
|
|
* the Apache License, Version 2.0 (the "License"); you may
|
|
* not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing,
|
|
* software distributed under the License is distributed on an
|
|
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
* KIND, either express or implied. See the License for the
|
|
* specific language governing permissions and limitations
|
|
* under the License.
|
|
*/
|
|
import * as Joi from 'joi';
|
|
import { ByteSizeValue } from '../src/byte_size_value';
|
|
|
|
declare module 'joi' {
|
|
interface BytesSchema extends AnySchema {
|
|
min(limit: number | string | ByteSizeValue): this;
|
|
max(limit: number | string | ByteSizeValue): this;
|
|
}
|
|
|
|
interface MapSchema extends AnySchema {
|
|
entries(key: AnySchema, value: AnySchema): this;
|
|
}
|
|
|
|
interface RecordSchema extends AnySchema {
|
|
entries(key: AnySchema, value: AnySchema): this;
|
|
}
|
|
|
|
export type JoiRoot = Joi.Root & {
|
|
bytes: () => BytesSchema;
|
|
duration: () => AnySchema;
|
|
map: () => MapSchema;
|
|
record: () => RecordSchema;
|
|
stream: () => AnySchema;
|
|
};
|
|
|
|
interface AnySchema {
|
|
custom(validator: (value: any) => string | void): this;
|
|
}
|
|
|
|
// Joi types don't include `schema` function even though it's supported.
|
|
interface ObjectSchema {
|
|
schema(): this;
|
|
}
|
|
}
|