-
Notifications
You must be signed in to change notification settings - Fork 8.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
becf2bb
commit 983bc52
Showing
15 changed files
with
173 additions
and
181 deletions.
There are no files selected for viewing
26 changes: 13 additions & 13 deletions
26
docs/development/core/server/kibana-plugin-server.basepath.get.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [BasePath](./kibana-plugin-server.basepath.md) > [get](./kibana-plugin-server.basepath.get.md) | ||
|
||
## BasePath.get property | ||
|
||
returns `basePath` value, specific for an incoming request. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
(request: KibanaRequest<unknown, unknown, unknown, any> | LegacyRequest) => string; | ||
``` | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [BasePath](./kibana-plugin-server.basepath.md) > [get](./kibana-plugin-server.basepath.get.md) | ||
|
||
## BasePath.get property | ||
|
||
returns `basePath` value, specific for an incoming request. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
get: (request: KibanaRequest<unknown, unknown, unknown, any> | LegacyRequest) => string; | ||
``` |
26 changes: 13 additions & 13 deletions
26
docs/development/core/server/kibana-plugin-server.basepath.set.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [BasePath](./kibana-plugin-server.basepath.md) > [set](./kibana-plugin-server.basepath.set.md) | ||
|
||
## BasePath.set property | ||
|
||
sets `basePath` value, specific for an incoming request. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
(request: KibanaRequest<unknown, unknown, unknown, any> | LegacyRequest, requestSpecificBasePath: string) => void; | ||
``` | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [BasePath](./kibana-plugin-server.basepath.md) > [set](./kibana-plugin-server.basepath.set.md) | ||
|
||
## BasePath.set property | ||
|
||
sets `basePath` value, specific for an incoming request. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
set: (request: KibanaRequest<unknown, unknown, unknown, any> | LegacyRequest, requestSpecificBasePath: string) => void; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
26 changes: 13 additions & 13 deletions
26
docs/development/core/server/kibana-plugin-server.irouter.handlelegacyerrors.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [IRouter](./kibana-plugin-server.irouter.md) > [handleLegacyErrors](./kibana-plugin-server.irouter.handlelegacyerrors.md) | ||
|
||
## IRouter.handleLegacyErrors property | ||
|
||
Wrap a router handler to catch and converts legacy boom errors to proper custom errors. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
<P, Q, B>(handler: RequestHandler<P, Q, B>) => RequestHandler<P, Q, B>; | ||
``` | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [IRouter](./kibana-plugin-server.irouter.md) > [handleLegacyErrors](./kibana-plugin-server.irouter.handlelegacyerrors.md) | ||
|
||
## IRouter.handleLegacyErrors property | ||
|
||
Wrap a router handler to catch and converts legacy boom errors to proper custom errors. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
handleLegacyErrors: <P, Q, B>(handler: RequestHandler<P, Q, B>) => RequestHandler<P, Q, B>; | ||
``` |
124 changes: 62 additions & 62 deletions
124
docs/development/core/server/kibana-plugin-server.routeconfig.validate.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,62 +1,62 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [RouteConfig](./kibana-plugin-server.routeconfig.md) > [validate](./kibana-plugin-server.routeconfig.validate.md) | ||
|
||
## RouteConfig.validate property | ||
|
||
A schema created with `@kbn/config-schema` that every request will be validated against. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
RouteValidatorFullConfig<P, Q, B> | false; | ||
``` | ||
|
||
## Remarks | ||
|
||
You \*must\* specify a validation schema to be able to read: - url path segments - request query - request body To opt out of validating the request, specify `validate: false`<!-- -->. In this case request params, query, and body will be \*\*empty\*\* objects and have no access to raw values. In some cases you may want to use another validation library. To do this, you need to instruct the `@kbn/config-schema` library to output \*\*non-validated values\*\* with setting schema as `schema.object({}, { allowUnknowns: true })`<!-- -->; | ||
|
||
## Example | ||
|
||
|
||
```ts | ||
import { schema } from '@kbn/config-schema'; | ||
router.get({ | ||
path: 'path/{id}', | ||
validate: { | ||
params: schema.object({ | ||
id: schema.string(), | ||
}), | ||
query: schema.object({...}), | ||
body: schema.object({...}), | ||
}, | ||
}, | ||
(context, req, res,) { | ||
req.params; // type Readonly<{id: string}> | ||
console.log(req.params.id); // value | ||
}); | ||
|
||
router.get({ | ||
path: 'path/{id}', | ||
validate: false, // handler has no access to params, query, body values. | ||
}, | ||
(context, req, res,) { | ||
req.params; // type Readonly<{}>; | ||
console.log(req.params.id); // undefined | ||
}); | ||
|
||
router.get({ | ||
path: 'path/{id}', | ||
validate: { | ||
// handler has access to raw non-validated params in runtime | ||
params: schema.object({}, { allowUnknowns: true }) | ||
}, | ||
}, | ||
(context, req, res,) { | ||
req.params; // type Readonly<{}>; | ||
console.log(req.params.id); // value | ||
myValidationLibrary.validate({ params: req.params }); | ||
}); | ||
|
||
``` | ||
|
||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [RouteConfig](./kibana-plugin-server.routeconfig.md) > [validate](./kibana-plugin-server.routeconfig.validate.md) | ||
|
||
## RouteConfig.validate property | ||
|
||
A schema created with `@kbn/config-schema` that every request will be validated against. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
validate: RouteValidatorFullConfig<P, Q, B> | false; | ||
``` | ||
|
||
## Remarks | ||
|
||
You \*must\* specify a validation schema to be able to read: - url path segments - request query - request body To opt out of validating the request, specify `validate: false`<!-- -->. In this case request params, query, and body will be \*\*empty\*\* objects and have no access to raw values. In some cases you may want to use another validation library. To do this, you need to instruct the `@kbn/config-schema` library to output \*\*non-validated values\*\* with setting schema as `schema.object({}, { allowUnknowns: true })`<!-- -->; | ||
|
||
## Example | ||
|
||
|
||
```ts | ||
import { schema } from '@kbn/config-schema'; | ||
router.get({ | ||
path: 'path/{id}', | ||
validate: { | ||
params: schema.object({ | ||
id: schema.string(), | ||
}), | ||
query: schema.object({...}), | ||
body: schema.object({...}), | ||
}, | ||
}, | ||
(context, req, res,) { | ||
req.params; // type Readonly<{id: string}> | ||
console.log(req.params.id); // value | ||
}); | ||
|
||
router.get({ | ||
path: 'path/{id}', | ||
validate: false, // handler has no access to params, query, body values. | ||
}, | ||
(context, req, res,) { | ||
req.params; // type Readonly<{}>; | ||
console.log(req.params.id); // undefined | ||
}); | ||
|
||
router.get({ | ||
path: 'path/{id}', | ||
validate: { | ||
// handler has access to raw non-validated params in runtime | ||
params: schema.object({}, { allowUnknowns: true }) | ||
}, | ||
}, | ||
(context, req, res,) { | ||
req.params; // type Readonly<{}>; | ||
console.log(req.params.id); // value | ||
myValidationLibrary.validate({ params: req.params }); | ||
}); | ||
|
||
``` | ||
|
42 changes: 21 additions & 21 deletions
42
...elopment/core/server/kibana-plugin-server.routevalidationerror._constructor_.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,21 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [RouteValidationError](./kibana-plugin-server.routevalidationerror.md) > [(constructor)](./kibana-plugin-server.routevalidationerror._constructor_.md) | ||
|
||
## RouteValidationError.(constructor) | ||
|
||
Constructs a new instance of the `RouteValidationError` class | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
constructor(error;: Error | string, path?: string[];) | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| error | <code>Error | string</code> | | | ||
| path | <code>string[]</code> | | | ||
|
||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [RouteValidationError](./kibana-plugin-server.routevalidationerror.md) > [(constructor)](./kibana-plugin-server.routevalidationerror._constructor_.md) | ||
|
||
## RouteValidationError.(constructor) | ||
|
||
Constructs a new instance of the `RouteValidationError` class | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
constructor(error: Error | string, path?: string[]); | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| error | <code>Error | string</code> | | | ||
| path | <code>string[]</code> | | | ||
|
26 changes: 13 additions & 13 deletions
26
...ent/core/server/kibana-plugin-server.routevalidationresultfactory.badrequest.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [RouteValidationResultFactory](./kibana-plugin-server.routevalidationresultfactory.md) > [badRequest](./kibana-plugin-server.routevalidationresultfactory.badrequest.md) | ||
|
||
## RouteValidationResultFactory.badRequest property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
(error: Error | string, path?: string[]) => { | ||
RouteValidationError; | ||
}; | ||
``` | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [RouteValidationResultFactory](./kibana-plugin-server.routevalidationresultfactory.md) > [badRequest](./kibana-plugin-server.routevalidationresultfactory.badrequest.md) | ||
|
||
## RouteValidationResultFactory.badRequest property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
badRequest: (error: Error | string, path?: string[]) => { | ||
error: RouteValidationError; | ||
}; | ||
``` |
26 changes: 13 additions & 13 deletions
26
...development/core/server/kibana-plugin-server.routevalidationresultfactory.ok.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [RouteValidationResultFactory](./kibana-plugin-server.routevalidationresultfactory.md) > [ok](./kibana-plugin-server.routevalidationresultfactory.ok.md) | ||
|
||
## RouteValidationResultFactory.ok property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
<T>(value: T) => { | ||
T; | ||
}; | ||
``` | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [RouteValidationResultFactory](./kibana-plugin-server.routevalidationresultfactory.md) > [ok](./kibana-plugin-server.routevalidationresultfactory.ok.md) | ||
|
||
## RouteValidationResultFactory.ok property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
ok: <T>(value: T) => { | ||
value: T; | ||
}; | ||
``` |
35 changes: 17 additions & 18 deletions
35
docs/development/core/server/kibana-plugin-server.routevalidatoroptions.unsafe.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,17 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [RouteValidatorOptions](./kibana-plugin-server.routevalidatoroptions.md) > [unsafe](./kibana-plugin-server.routevalidatoroptions.unsafe.md) | ||
|
||
## RouteValidatorOptions.unsafe property | ||
|
||
Set the `unsafe` config to avoid running some additional internal \*safe\* validations on top of your custom validation | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
unsafe?: { | ||
params?: boolean; | ||
query?: boolean; | ||
body?: boolean; | ||
} | ||
|
||
``` | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [RouteValidatorOptions](./kibana-plugin-server.routevalidatoroptions.md) > [unsafe](./kibana-plugin-server.routevalidatoroptions.unsafe.md) | ||
|
||
## RouteValidatorOptions.unsafe property | ||
|
||
Set the `unsafe` config to avoid running some additional internal \*safe\* validations on top of your custom validation | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
unsafe?: { | ||
params?: boolean; | ||
query?: boolean; | ||
body?: boolean; | ||
}; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.