From 096d9b8dc92905097e01f30d0b158cdbbeda7f0e Mon Sep 17 00:00:00 2001 From: Simon Date: Mon, 11 Dec 2023 10:40:53 +0100 Subject: [PATCH] improved doc --- .../form-actions/aam-deploy.php | 2 +- src/deployment-info.dto.ts | 27 +++++++++++-------- 2 files changed, 17 insertions(+), 12 deletions(-) diff --git a/integrations/elementor-plugin/form-actions/aam-deploy.php b/integrations/elementor-plugin/form-actions/aam-deploy.php index 8ce01d7..dbc2a85 100644 --- a/integrations/elementor-plugin/form-actions/aam-deploy.php +++ b/integrations/elementor-plugin/form-actions/aam-deploy.php @@ -140,7 +140,7 @@ public function register_settings_section( $widget ) { [ 'label' => esc_html__( 'Client name', 'elementor-forms-aam-deploy' ), 'type' => \Elementor\Controls_Manager::TEXT, - 'description' => esc_html__( 'Enter your client name (i.e. ???).', 'elementor-forms-aam-deploy' ), + 'description' => esc_html__( 'Enter your client name.', 'elementor-forms-aam-deploy' ), ] ); diff --git a/src/deployment-info.dto.ts b/src/deployment-info.dto.ts index 1e2f547..01d6177 100644 --- a/src/deployment-info.dto.ts +++ b/src/deployment-info.dto.ts @@ -1,6 +1,9 @@ +import { ApiProperty } from '@nestjs/swagger'; + export class DeploymentInfo { @ApiProperty({ - description: 'Name of the system to be created. Must not contain whitespaces.', + description: + 'Name of the system to be created. Must not contain whitespaces.', }) name: string; @@ -13,34 +16,36 @@ export class DeploymentInfo { description: 'Username of the initial user account created as site admin.', }) username: string; - + @ApiProperty({ description: 'Email for the initial user account.', }) email: string; - + @ApiProperty({ - description: 'Whether the permission backend (replication-backend) should be set up.', + description: + 'Whether the permission backend (replication-backend) should be set up.', }) backend: boolean; - + @ApiProperty({ description: 'Whether the new system should be added to uptime monitoring.', }) monitor: boolean; - + @ApiProperty({ - description: '???', + description: 'Name of the Keycloak confidential client.', }) client: string; - + @ApiProperty({ - description: '???', + description: 'Credentials for the Keycloak confidential client.', }) clientKey: string; - + @ApiProperty({ - description: '???', + description: + 'The prebuilt configuration which should be used as a basis for this app.', }) base: string; }