forked from elastic/kibana
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Expose createRouter from HttpService, prepare handlers for context in…
…troduction (elastic#42686) * expose createRouter, prepare route handler for context introduction. * fix tests * update examples in docs * update tests * re-genereated docs * remove registerRouter from http service contract createRouter registers a router under the hood. that reduces API surface for consumers * address comments * update docs
- Loading branch information
Showing
42 changed files
with
897 additions
and
903 deletions.
There are no files selected for viewing
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
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
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
13 changes: 13 additions & 0 deletions
13
docs/development/core/server/kibana-plugin-server.irouter.delete.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 |
---|---|---|
@@ -0,0 +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) > [delete](./kibana-plugin-server.irouter.delete.md) | ||
|
||
## IRouter.delete property | ||
|
||
Register a route handler for `DELETE` request. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
delete: <P extends ObjectType, Q extends ObjectType, B extends ObjectType>(route: RouteConfig<P, Q, B>, handler: RequestHandler<P, Q, B>) => void; | ||
``` |
13 changes: 13 additions & 0 deletions
13
docs/development/core/server/kibana-plugin-server.irouter.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 |
---|---|---|
@@ -0,0 +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) > [get](./kibana-plugin-server.irouter.get.md) | ||
|
||
## IRouter.get property | ||
|
||
Register a route handler for `GET` request. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
get: <P extends ObjectType, Q extends ObjectType, B extends ObjectType>(route: RouteConfig<P, Q, B>, handler: RequestHandler<P, Q, B>) => void; | ||
``` |
24 changes: 24 additions & 0 deletions
24
docs/development/core/server/kibana-plugin-server.irouter.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 |
---|---|---|
@@ -0,0 +1,24 @@ | ||
<!-- 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) | ||
|
||
## IRouter interface | ||
|
||
Registers route handlers for specified resource path and method. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface IRouter | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [delete](./kibana-plugin-server.irouter.delete.md) | <code><P extends ObjectType, Q extends ObjectType, B extends ObjectType>(route: RouteConfig<P, Q, B>, handler: RequestHandler<P, Q, B>) => void</code> | Register a route handler for <code>DELETE</code> request. | | ||
| [get](./kibana-plugin-server.irouter.get.md) | <code><P extends ObjectType, Q extends ObjectType, B extends ObjectType>(route: RouteConfig<P, Q, B>, handler: RequestHandler<P, Q, B>) => void</code> | Register a route handler for <code>GET</code> request. | | ||
| [post](./kibana-plugin-server.irouter.post.md) | <code><P extends ObjectType, Q extends ObjectType, B extends ObjectType>(route: RouteConfig<P, Q, B>, handler: RequestHandler<P, Q, B>) => void</code> | Register a route handler for <code>POST</code> request. | | ||
| [put](./kibana-plugin-server.irouter.put.md) | <code><P extends ObjectType, Q extends ObjectType, B extends ObjectType>(route: RouteConfig<P, Q, B>, handler: RequestHandler<P, Q, B>) => void</code> | Register a route handler for <code>PUT</code> request. | | ||
| [routerPath](./kibana-plugin-server.irouter.routerpath.md) | <code>string</code> | Resulted path | | ||
|
13 changes: 13 additions & 0 deletions
13
docs/development/core/server/kibana-plugin-server.irouter.post.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 |
---|---|---|
@@ -0,0 +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) > [post](./kibana-plugin-server.irouter.post.md) | ||
|
||
## IRouter.post property | ||
|
||
Register a route handler for `POST` request. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
post: <P extends ObjectType, Q extends ObjectType, B extends ObjectType>(route: RouteConfig<P, Q, B>, handler: RequestHandler<P, Q, B>) => void; | ||
``` |
13 changes: 13 additions & 0 deletions
13
docs/development/core/server/kibana-plugin-server.irouter.put.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 |
---|---|---|
@@ -0,0 +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) > [put](./kibana-plugin-server.irouter.put.md) | ||
|
||
## IRouter.put property | ||
|
||
Register a route handler for `PUT` request. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
put: <P extends ObjectType, Q extends ObjectType, B extends ObjectType>(route: RouteConfig<P, Q, B>, handler: RequestHandler<P, Q, B>) => void; | ||
``` |
13 changes: 13 additions & 0 deletions
13
docs/development/core/server/kibana-plugin-server.irouter.routerpath.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 |
---|---|---|
@@ -0,0 +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) > [routerPath](./kibana-plugin-server.irouter.routerpath.md) | ||
|
||
## IRouter.routerPath property | ||
|
||
Resulted path | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
routerPath: string; | ||
``` |
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
20 changes: 0 additions & 20 deletions
20
docs/development/core/server/kibana-plugin-server.router.(constructor).md
This file was deleted.
Oops, something went wrong.
25 changes: 0 additions & 25 deletions
25
docs/development/core/server/kibana-plugin-server.router.delete.md
This file was deleted.
Oops, something went wrong.
25 changes: 0 additions & 25 deletions
25
docs/development/core/server/kibana-plugin-server.router.get.md
This file was deleted.
Oops, something went wrong.
45 changes: 0 additions & 45 deletions
45
docs/development/core/server/kibana-plugin-server.router.md
This file was deleted.
Oops, something went wrong.
11 changes: 0 additions & 11 deletions
11
docs/development/core/server/kibana-plugin-server.router.path.md
This file was deleted.
Oops, something went wrong.
25 changes: 0 additions & 25 deletions
25
docs/development/core/server/kibana-plugin-server.router.post.md
This file was deleted.
Oops, something went wrong.
25 changes: 0 additions & 25 deletions
25
docs/development/core/server/kibana-plugin-server.router.put.md
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.