Add a stub endpoint plugin #50082
Add a stub endpoint plugin #50082
Conversation
💔 Build Failed |
oatkiller
force-pushed
the
create-stub-endpoint-plugin
branch
from
0b4ba3d
to
dad3989
Compare
💔 Build Failed |
oatkiller
force-pushed
the
create-stub-endpoint-plugin
branch
from
dad3989
to
9299846
Compare
💚 Build Succeeded |
| "id": "endpoint", | ||
| "version": "1.0.0", | ||
| "kibanaVersion": "kibana", | ||
| "configPath": ["x-pack", "endpoint"], |
| async function greetingIndex(...passedArgs: [unknown, unknown, KibanaResponseFactory]) { | ||
| const [, , response] = passedArgs; | ||
| return response.ok({ | ||
| body: JSON.stringify({ hello: 'world' }), |
There was a problem hiding this comment.
nit: don't think JSON.stringify is necessary
| ); | ||
| } | ||
|
|
||
| async function greetingIndex(...passedArgs: [unknown, unknown, KibanaResponseFactory]) { |
There was a problem hiding this comment.
Let's use RequestHandler as a more descriptive type. We will remove the required types from the generic soon.
import { RequestHandler } from 'src/core/server';
export const greetingIndex: RequestHandler<any, any, any> = async (context, request, response) => {| schema: schema.object({ enabled: schema.boolean({ defaultValue: false }) }), | ||
| }; | ||
|
|
||
| export function plugin() { |
There was a problem hiding this comment.
JFYI PluginInitializerContext also passed to the plugin factory
export const plugin = (initializerContext: PluginInitializerContext) => new EndpointPlugin(initializerContext)| import { schema } from '@kbn/config-schema'; | ||
| import { EndpointPlugin } from './plugin'; | ||
|
|
||
| export const config = { |
There was a problem hiding this comment.
config schema defined only on the server. lets remove it
| export function addRoutes(router: IRouter) { | ||
| router.get( | ||
| { | ||
| path: '/endpoint/hello-world', |
There was a problem hiding this comment.
JFYI: by convention API endpoints are prefixed with api/
yes. |
Sorry if I confused things. I was just pulling your commits in to see if they would fix my tests (they did.) I can close this PR until your PR is merged. |
|
@oatkiller #50286 merged |
Summary
This PR adds a basic (useless) endpoint plugin and Endpoint app. My assumption is that the Endpoint team will work merge their work into master. Up until the product is ready for release, the plugin will be disabled. When the app is release ready, we will make the plugin enabled by default and our commits will be added to a release branch.
TODO
Checklist
Use
strikethroughsto remove checklist items you don't feel are applicable to this PR.For maintainers