github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 17:28:26 -04:00
Code Issues Projects Releases Packages Wiki Activity

export DomainDeprecationDetails type from public + fix typo (#96885)

Browse source
This commit is contained in:
Alison Goryachev 2021-04-14 09:51:47 -04:00 • committed by GitHub
parent e36650de70
commit b401cbb3eb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 47 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

11
docs/development/core/public/kibana-plugin-core-public.domaindeprecationdetails.domainid.md Normal file
View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-core-public](./kibana-plugin-core-public.md) &gt; [DomainDeprecationDetails](./kibana-plugin-core-public.domaindeprecationdetails.md) &gt; [domainId](./kibana-plugin-core-public.domaindeprecationdetails.domainid.md)
## DomainDeprecationDetails.domainId property
<b>Signature:</b>
```typescript
domainId: string;
```

18
docs/development/core/public/kibana-plugin-core-public.domaindeprecationdetails.md Normal file
View file

@ -0,0 +1,18 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-core-public](./kibana-plugin-core-public.md) &gt; [DomainDeprecationDetails](./kibana-plugin-core-public.domaindeprecationdetails.md)
## DomainDeprecationDetails interface
<b>Signature:</b>
```typescript
export interface DomainDeprecationDetails extends DeprecationsDetails
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [domainId](./kibana-plugin-core-public.domaindeprecationdetails.domainid.md) | <code>string</code> | |

1
docs/development/core/public/kibana-plugin-core-public.md
View file

@ -61,6 +61,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [CoreStart](./kibana-plugin-core-public.corestart.md) | Core services exposed to the <code>Plugin</code> start lifecycle |
| [DeprecationsServiceStart](./kibana-plugin-core-public.deprecationsservicestart.md) | DeprecationsService provides methods to fetch domain deprecation details from the Kibana server. |
| [DocLinksStart](./kibana-plugin-core-public.doclinksstart.md) | |
| [DomainDeprecationDetails](./kibana-plugin-core-public.domaindeprecationdetails.md) | |
| [ErrorToastOptions](./kibana-plugin-core-public.errortoastoptions.md) | Options available for [IToasts](./kibana-plugin-core-public.itoasts.md) error APIs. |
| [FatalErrorInfo](./kibana-plugin-core-public.fatalerrorinfo.md) | Represents the <code>message</code> and <code>stack</code> of a fatal Error |
| [FatalErrorsSetup](./kibana-plugin-core-public.fatalerrorssetup.md) | FatalErrors stop the Kibana Public Core and displays a fatal error screen with details about the Kibana build and the error. |

7
src/core/public/index.ts
View file

@ -67,7 +67,12 @@ import { DocLinksStart } from './doc_links';
import { SavedObjectsStart } from './saved_objects';
import { DeprecationsServiceStart } from './deprecations';
export type { PackageInfo, EnvironmentMode, IExternalUrlPolicy } from '../server/types';
export type {
PackageInfo,
EnvironmentMode,
IExternalUrlPolicy,
DomainDeprecationDetails,
} from '../server/types';
export type { CoreContext, CoreSystem } from './core_system';
export { DEFAULT_APP_CATEGORIES } from '../utils';
export type {

10
src/core/public/public.api.md
View file

@ -476,7 +476,6 @@ export const DEFAULT_APP_CATEGORIES: Record<string, AppCategory>;
// @public
export interface DeprecationsServiceStart {
// Warning: (ae-forgotten-export) The symbol "DomainDeprecationDetails" needs to be exported by the entry point index.d.ts
getAllDeprecations: () => Promise<DomainDeprecationDetails[]>;
getDeprecations: (domainId: string) => Promise<DomainDeprecationDetails[]>;
isDeprecationResolvable: (details: DomainDeprecationDetails) => boolean;
@ -658,6 +657,15 @@ export interface DocLinksStart {
};
}
// Warning: (ae-forgotten-export) The symbol "DeprecationsDetails" needs to be exported by the entry point index.d.ts
// Warning: (ae-missing-release-tag) "DomainDeprecationDetails" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export interface DomainDeprecationDetails extends DeprecationsDetails {
// (undocumented)
domainId: string;
}
export { EnvironmentMode }
// @public

2
test/plugin_functional/plugins/core_plugin_deprecations/server/config.ts
View file

@ -24,7 +24,7 @@ const configSecretDeprecation: ConfigDeprecation = (settings, fromPath, addDepre
addDeprecation({
documentationUrl: 'config-secret-doc-url',
message:
'Kibana plugin funcitonal tests will no longer allow corePluginDeprecations.secret ' +
'Kibana plugin functional tests will no longer allow corePluginDeprecations.secret ' +
'config to be set to anything except 42.',
});
}

2
test/plugin_functional/test_suites/core/deprecations.ts
View file

@ -42,7 +42,7 @@ export default function ({ getService, getPageObjects }: PluginFunctionalProvide
{
level: 'critical',
message:
'Kibana plugin funcitonal tests will no longer allow corePluginDeprecations.secret config to be set to anything except 42.',
'Kibana plugin functional tests will no longer allow corePluginDeprecations.secret config to be set to anything except 42.',
correctiveActions: {},
documentationUrl: 'config-secret-doc-url',
domainId: 'corePluginDeprecations',