Skip to content

feat: add externalFileLinks to Issue entity #180

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
katayama8000 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: add externalFileLinks to Issue entity #180

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions src/entity.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -620,10 +620,22 @@ export namespace Issue {
customFields: CustomFieldValue.CustomFieldValue[];
attachments: File.IssueFileInfo[];
sharedFiles: Project.SharedFile[];
externalFileLinks: ExternalFileLink[];
stars: Star.Star[];
childIssueSummary?: ChildIssueSummary;
}

export interface ExternalFileLink {
id: number;
serviceType: string;
name: string;
url: string;
createdUser?: User.User;
created: string;
updatedUser?: User.User;
updated: string;
}

export interface ChildIssueSummary {
total: number;
closed: number;
Expand Down
35 changes: 35 additions & 0 deletions test/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,6 +306,41 @@ describe("Backlog API", () => {
expect(data.childIssueSummary).toEqual({ total: 3, closed: 1 });
});

it("should get a single issue with externalFileLinks.", async () => {
const externalFileLink = {
id: 10,
serviceType: "googledrive",
name: "spec.pdf",
url: "https://drive.google.com/file/d/xxxx/view",
createdUser: null,
created: "2026-07-28T00:00:00Z",
updatedUser: null,
updated: "2026-07-28T00:00:00Z",
};
const issue = {
id: 1,
projectId: 1,
issueKey: "TEST-1",
keyId: 1,
summary: "with external file link",
sharedFiles: [],
externalFileLinks: [externalFileLink],
};
mockRequest({
method: "GET",
path: "/api/v2/issues/TEST-1",
query: { apiKey },
status: 200,
data: issue,
times: 1,
});
const data = await backlog.getIssue("TEST-1");
expect(data).toEqual(issue);
expect(data.externalFileLinks).toHaveLength(1);
expect(data.externalFileLinks[0].serviceType).toBe("googledrive");
expect(data.externalFileLinks[0].url).toBe(externalFileLink.url);
});

it("should serialize the expand parameter using bracket array format.", () => {
const query = (backlog as any).toQueryString({
parentChild: backlogjs.Option.Issue.ParentChildType.GrandchildOnly,
Expand Down