mirror of
https://github.com/Unleash/unleash.git
synced 2025-01-31 00:16:47 +01:00
9448461aaa
* Docs: start experimenting with OpenAPI and docusaurus * Docs: add docusaurus-theme-openapi-docs pkg * Wip: current status * Docs: Add 'docusaurus-plugin-api-docs' * Move openapi into own sidebar; generate from localhost * Chore: Update docusaurus plugin for OpenAPI * Add website/yarn.lock to git * Fix: fix CSS warning by using flex-end instead of end * docs: make openapi generated code work again * docs: make tags work properly with openapi sidebar * Docs/chore: update OpenAPI tag scheme. Add a whole bunch of new tags to make it easier to understand available tags in OpenAPI. * docs: point to new openapi docs from old api docs * docs: typo * Docs: link restructure * docs: add operation indicators to openapi docs * docs: change badge color for operations * docs: update openapi-docs package It now sorts tags the same as the schema * docs: pluralize APIs in slug * docs: update links to generated api docs * docs: update openapi snapshot tests with new tags * docs: conditionally load spec from localhost or from file * docs: Remove changes relating to immediate switchover * refactor: rename types; extract into separate file * docs: fix api doc links
72 lines
2.2 KiB
TypeScript
72 lines
2.2 KiB
TypeScript
import { Response } from 'express';
|
|
import Controller from '../controller';
|
|
import { Logger } from '../../logger';
|
|
import { IUnleashConfig } from '../../types/option';
|
|
import { IUnleashServices } from '../../types/services';
|
|
import UserSplashService from '../../services/user-splash-service';
|
|
import { IAuthRequest } from '../unleash-types';
|
|
import { NONE } from '../../types/permissions';
|
|
import { OpenApiService } from '../../services/openapi-service';
|
|
import { createResponseSchema } from '../../openapi/util/create-response-schema';
|
|
import { splashSchema, SplashSchema } from '../../openapi/spec/splash-schema';
|
|
|
|
class UserSplashController extends Controller {
|
|
private logger: Logger;
|
|
|
|
private userSplashService: UserSplashService;
|
|
|
|
private openApiService: OpenApiService;
|
|
|
|
constructor(
|
|
config: IUnleashConfig,
|
|
{
|
|
userSplashService,
|
|
openApiService,
|
|
}: Pick<IUnleashServices, 'userSplashService' | 'openApiService'>,
|
|
) {
|
|
super(config);
|
|
this.logger = config.getLogger('splash-controller.ts');
|
|
this.userSplashService = userSplashService;
|
|
this.openApiService = openApiService;
|
|
|
|
this.route({
|
|
method: 'post',
|
|
path: '/:id',
|
|
acceptAnyContentType: true,
|
|
handler: this.updateSplashSettings,
|
|
permission: NONE,
|
|
middleware: [
|
|
openApiService.validPath({
|
|
tags: ['Admin UI'],
|
|
operationId: 'updateSplashSettings',
|
|
responses: { 200: createResponseSchema('splashSchema') },
|
|
}),
|
|
],
|
|
});
|
|
}
|
|
|
|
private async updateSplashSettings(
|
|
req: IAuthRequest<{ id: string }>,
|
|
res: Response<SplashSchema>,
|
|
): Promise<void> {
|
|
const { user } = req;
|
|
const { id } = req.params;
|
|
|
|
const splash = {
|
|
splashId: id,
|
|
userId: user.id,
|
|
seen: true,
|
|
};
|
|
|
|
this.openApiService.respondWithValidation(
|
|
200,
|
|
res,
|
|
splashSchema.$id,
|
|
await this.userSplashService.updateSplash(splash),
|
|
);
|
|
}
|
|
}
|
|
|
|
module.exports = UserSplashController;
|
|
export default UserSplashController;
|