update doc comments

parkiino · parkiino · commit 4f4e14c8e4d6 · 2020-06-02T12:34:46.000-04:00
diff --git a/x-pack/plugins/ingest_manager/common/types/models/datasource.ts b/x-pack/plugins/ingest_manager/common/types/models/datasource.ts
@@ -43,6 +43,9 @@ export interface DatasourceInput extends Omit<NewDatasourceInput, 'streams'> {
   streams: DatasourceInputStream[];
 }
 
+/**
+ * Type of `datasource` prop in CustomConfigureDatasourceContent
+ */
 export interface NewDatasource {
   name: string;
   description?: string;
diff --git a/x-pack/plugins/ingest_manager/public/applications/ingest_manager/sections/agent_config/create_datasource_page/components/custom_configure_datasource.tsx b/x-pack/plugins/ingest_manager/public/applications/ingest_manager/sections/agent_config/create_datasource_page/components/custom_configure_datasource.tsx
@@ -16,6 +16,10 @@ export interface CustomConfigureDatasourceProps {
   datasource: NewDatasource | (NewDatasource & { id: string });
 }
 
+/**
+ * Allows external plugins to create custom content for the Ingest
+ * Datasource configuration.
+ */
 export type CustomConfigureDatasourceContent = React.FC<CustomConfigureDatasourceProps>;
 
 const ConfigureDatasourceMapping: { [key: string]: CustomConfigureDatasourceContent } = {
diff --git a/x-pack/plugins/ingest_manager/public/index.ts b/x-pack/plugins/ingest_manager/public/index.ts
@@ -12,13 +12,6 @@ export const plugin = (initializerContext: PluginInitializerContext) => {
   return new IngestManagerPlugin(initializerContext);
 };
 
-/**
- * Allows external plugins to create custom content for the Ingest
- * Datasource configuration.
- */
 export { CustomConfigureDatasourceContent } from './applications/ingest_manager/sections/agent_config/create_datasource_page/components/custom_configure_datasource';
 
-/**
- * Type of `datasource` prop in CustomConfigureDatasourceContent
- */
 export { NewDatasource } from './applications/ingest_manager/types';
diff --git a/x-pack/plugins/siem/public/management/pages/policy/view/ingest_manager_integration/configure_datasource.tsx b/x-pack/plugins/siem/public/management/pages/policy/view/ingest_manager_integration/configure_datasource.tsx
@@ -17,6 +17,10 @@ import { getManagementUrl } from '../../../..';
 
 type DatasourceWithId = NewDatasource & { id: string };
 
+/**
+ * Exports Endpoint-specific datasource configuration instructions
+ * for use in the Ingest app create / edit datasource config
+ */
 export const ConfigureEndpointDatasource = memo<CustomConfigureDatasourceContent>(
   ({ from, datasource }: { from: string; datasource: NewDatasource | DatasourceWithId }) => {
     const { services } = useKibana();

Original file line number	Diff line number	Diff line change
`@@ -43,6 +43,9 @@ export interface DatasourceInput extends Omit<NewDatasourceInput, 'streams'> {`
`43`	`43`	`streams: DatasourceInputStream[];`
`44`	`44`	`}`
`45`	`45`
	`46`	`+/**`
	`47`	+ * Type of `datasource` prop in CustomConfigureDatasourceContent
	`48`	`+ */`
`46`	`49`	`export interface NewDatasource {`
`47`	`50`	`name: string;`
`48`	`51`	`description?: string;`
Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,10 @@ export interface CustomConfigureDatasourceProps {`
`16`	`16`	`datasource: NewDatasource \| (NewDatasource & { id: string });`
`17`	`17`	`}`
`18`	`18`
	`19`	`+/**`
	`20`	`+ * Allows external plugins to create custom content for the Ingest`
	`21`	`+ * Datasource configuration.`
	`22`	`+ */`
`19`	`23`	`export type CustomConfigureDatasourceContent = React.FC<CustomConfigureDatasourceProps>;`
`20`	`24`
`21`	`25`	`const ConfigureDatasourceMapping: { [key: string]: CustomConfigureDatasourceContent } = {`