From fd3d01c94640c3e180e9cc69c487ce8a0f800c27 Mon Sep 17 00:00:00 2001
From: Elaine Mattos <elaine.mattos@gmail.com>
Date: Tue, 26 Dec 2023 10:07:57 +0100
Subject: [PATCH] fix: add api-report

Signed-off-by: Elaine Mattos <elaine.mattos@gmail.com>
---
 .../scaffolder-backend-module-gitlab/api-report.md   | 12 +++++++++++-
 .../src/actions/createGitlabIssueAction.ts           |  5 +++++
 2 files changed, 16 insertions(+), 1 deletion(-)

diff --git a/plugins/scaffolder-backend-module-gitlab/api-report.md b/plugins/scaffolder-backend-module-gitlab/api-report.md
index 7f94daf6c9..9ff9fb3dfc 100644
--- a/plugins/scaffolder-backend-module-gitlab/api-report.md
+++ b/plugins/scaffolder-backend-module-gitlab/api-report.md
@@ -39,7 +39,7 @@ export const createGitlabIssueAction: (options: {
     discussionToResolve?: string | undefined;
     epicId?: number | undefined;
     labels?: string | undefined;
-    issueType?: string | undefined;
+    issueType?: IssueType | undefined;
     mergeRequestToResolveDiscussionsOf?: number | undefined;
     milestoneId?: number | undefined;
     weight?: number | undefined;
@@ -174,4 +174,14 @@ export const createPublishGitlabMergeRequestAction: (options: {
   },
   JsonObject
 >;
+
+// @public
+export enum IssueType {
+  // (undocumented)
+  INCIDENT = 'incident',
+  // (undocumented)
+  ISSUE = 'issue',
+  // (undocumented)
+  TEST = 'test_case',
+}
 ```
diff --git a/plugins/scaffolder-backend-module-gitlab/src/actions/createGitlabIssueAction.ts b/plugins/scaffolder-backend-module-gitlab/src/actions/createGitlabIssueAction.ts
index c7d163bdd9..bc9c796253 100644
--- a/plugins/scaffolder-backend-module-gitlab/src/actions/createGitlabIssueAction.ts
+++ b/plugins/scaffolder-backend-module-gitlab/src/actions/createGitlabIssueAction.ts
@@ -23,6 +23,11 @@ import { z } from 'zod';
 import { checkEpicScope, convertDate, getClient, parseRepoUrl } from '../util';
 import { Gitlab, CreateIssueOptions, IssueSchema } from '@gitbeaker/rest';
 
+/**
+ * Gitlab issue types
+ *
+ * @public
+ */
 export enum IssueType {
   ISSUE = 'issue',
   INCIDENT = 'incident',