chore: remove some warnings from the types and fix the buiold

Signed-off-by: blam <ben@blam.sh>

plugins/scaffolder/api-report.md

@@ -261,9 +261,6 @@ export interface ScaffolderApi {
     templateRef: string,
   ): Promise<TemplateParameterSchema>;
   listActions(): Promise<ListActionsResponse>;
-  // Warning: (tsdoc-param-tag-with-invalid-name) The @param block should be followed by a valid parameter name: The identifier cannot non-word characters
-  // Warning: (tsdoc-param-tag-with-invalid-name) The @param block should be followed by a valid parameter name: The identifier cannot non-word characters
-  // Warning: (tsdoc-param-tag-with-invalid-name) The @param block should be followed by a valid parameter name: The identifier cannot non-word characters
   scaffold(
     options: ScaffolderScaffoldOptions,
   ): Promise<ScaffolderScaffoldResponse>;
@@ -294,9 +291,6 @@ export class ScaffolderClient implements ScaffolderApi {
   ): Promise<TemplateParameterSchema>;
   // (undocumented)
   listActions(): Promise<ListActionsResponse>;
-  // Warning: (tsdoc-param-tag-with-invalid-name) The @param block should be followed by a valid parameter name: The identifier cannot non-word characters
-  // Warning: (tsdoc-param-tag-with-invalid-name) The @param block should be followed by a valid parameter name: The identifier cannot non-word characters
-  // Warning: (tsdoc-param-tag-with-invalid-name) The @param block should be followed by a valid parameter name: The identifier cannot non-word characters
   scaffold(
     options: ScaffolderScaffoldOptions,
   ): Promise<ScaffolderScaffoldResponse>;

plugins/scaffolder/package.json

@@ -34,6 +34,7 @@
     "clean": "backstage-cli package clean"
   },
   "dependencies": {
+    "@types/json-schema": "^7.0.9",
     "@backstage/catalog-client": "^0.7.0",
     "@backstage/catalog-model": "^0.10.0",
     "@backstage/config": "^0.1.14",

plugins/scaffolder/src/api.ts

@@ -112,9 +112,7 @@ export class ScaffolderClient implements ScaffolderApi {
    * Executes the scaffolding of a component, given a template and its
    * parameter values.
    *
-   * @param options.templateName - Template name for the scaffolder to use. New project is going to be created out of this template.
-   * @param options.values - Parameters for the template, e.g. name, description
-   * @param options.secrets - Optional secrets to pass to as the secrets parameter to the template.
+   * @param options - The {@link ScaffolderScaffoldOptions} the scaffolding.
    */
   async scaffold(
     options: ScaffolderScaffoldOptions,

plugins/scaffolder/src/types.ts

@@ -79,6 +79,7 @@ export type LogEvent = {
   id: string;
   taskId: string;
 };
+
 export interface ScaffolderScaffoldOptions {
   templateName: string;
   values: Record<string, any>;
@@ -115,9 +116,7 @@ export interface ScaffolderApi {
    * Executes the scaffolding of a component, given a template and its
    * parameter values.
    *
-   * @param options.templateName - Name of the Template entity for the scaffolder to use. New project is going to be created out of this template.
-   * @param options.values - Parameters for the template, e.g. name, description
-   * @param options.secrets - Optional secrets to pass to as the secrets parameter to the template.
+   * @param options - The {@link ScaffolderScaffoldOptions} the scaffolding.
    */
   scaffold(
     options: ScaffolderScaffoldOptions,