Remove deprecated & unused HttpServiceSetup.auth (#127056)

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
This commit is contained in:
Alejandro Fernández Haro 2022-03-09 09:44:01 +01:00 committed by GitHub
parent 133e57ffb9
commit 565454c64e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 0 additions and 37 deletions

View file

@ -1,18 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [HttpServiceSetup](./kibana-plugin-core-server.httpservicesetup.md) &gt; [auth](./kibana-plugin-core-server.httpservicesetup.auth.md)
## HttpServiceSetup.auth property
> Warning: This API is now obsolete.
>
> use [the start contract](./kibana-plugin-core-server.httpservicestart.auth.md) instead.
>
Auth status. See [HttpAuth](./kibana-plugin-core-server.httpauth.md)
<b>Signature:</b>
```typescript
auth: HttpAuth;
```

View file

@ -77,7 +77,6 @@ async (context, request, response) => {
| Property | Type | Description |
| --- | --- | --- |
| [auth](./kibana-plugin-core-server.httpservicesetup.auth.md) | HttpAuth | Auth status. See [HttpAuth](./kibana-plugin-core-server.httpauth.md) |
| [basePath](./kibana-plugin-core-server.httpservicesetup.basepath.md) | IBasePath | Access or manipulate the Kibana base path See [IBasePath](./kibana-plugin-core-server.ibasepath.md)<!-- -->. |
| [createCookieSessionStorageFactory](./kibana-plugin-core-server.httpservicesetup.createcookiesessionstoragefactory.md) | &lt;T&gt;(cookieOptions: SessionStorageCookieOptions&lt;T&gt;) =&gt; Promise&lt;SessionStorageFactory&lt;T&gt;&gt; | Creates cookie based session storage factory [SessionStorageFactory](./kibana-plugin-core-server.sessionstoragefactory.md) |
| [createRouter](./kibana-plugin-core-server.httpservicesetup.createrouter.md) | &lt;Context extends RequestHandlerContext = RequestHandlerContext&gt;() =&gt; IRouter&lt;Context&gt; | Provides ability to declare a handler function for a particular path and HTTP request method. |

View file

@ -179,10 +179,6 @@ const createSetupContractMock = () => {
csp: CspConfig.DEFAULT,
createRouter: jest.fn(),
registerRouteHandlerContext: jest.fn(),
auth: {
get: internalMock.auth.get,
isAuthenticated: internalMock.auth.isAuthenticated,
},
getServerInfo: internalMock.getServerInfo,
};

View file

@ -312,14 +312,6 @@ export interface HttpServiceSetup {
*/
basePath: IBasePath;
/**
* Auth status.
* See {@link HttpAuth}
*
* @deprecated use {@link HttpServiceStart.auth | the start contract} instead.
*/
auth: HttpAuth;
/**
* The CSP config used for Kibana.
*/

View file

@ -181,10 +181,6 @@ export function createPluginSetupContext<TPlugin, TPluginDependencies>(
registerOnPostAuth: deps.http.registerOnPostAuth,
registerOnPreResponse: deps.http.registerOnPreResponse,
basePath: deps.http.basePath,
auth: {
get: deps.http.auth.get,
isAuthenticated: deps.http.auth.isAuthenticated,
},
csp: deps.http.csp,
getServerInfo: deps.http.getServerInfo,
},

View file

@ -1127,8 +1127,6 @@ export interface HttpServicePreboot {
// @public
export interface HttpServiceSetup {
// @deprecated
auth: HttpAuth;
basePath: IBasePath;
createCookieSessionStorageFactory: <T>(cookieOptions: SessionStorageCookieOptions<T>) => Promise<SessionStorageFactory<T>>;
createRouter: <Context extends RequestHandlerContext = RequestHandlerContext>() => IRouter<Context>;