技能 编程开发 Fireflies API迁移与升级

Fireflies API迁移与升级

v20260423
fireflies-upgrade-migration
本技能旨在帮助用户处理Fireflies.ai API的弃用和变化。它指导用户更新GraphQL查询参数,例如将单值参数改为数组格式,或将旧的字段名迁移到新的有效字段,确保代码能够适应Fireflies API的最新变化。
获取技能
350 次下载
概览

Fireflies.ai Upgrade & Migration

Current State

!npm list graphql graphql-request 2>/dev/null || echo 'No graphql packages'

Overview

Fireflies.ai uses a GraphQL API (no versioned SDK). Breaking changes come as field deprecations and new query parameter patterns. This skill covers all known deprecations and migration paths.

Known Deprecations

Transcript Query Parameter Changes

// DEPRECATED: Single organizer email string
const OLD = `{ transcripts(organizer_email: "alice@co.com") { id } }`;

// CURRENT: Array of organizer emails
const NEW = `{ transcripts(organizers: ["alice@co.com"]) { id } }`;
// DEPRECATED: Single participant email string
const OLD = `{ transcripts(participant_email: "bob@co.com") { id } }`;

// CURRENT: Array of participant emails
const NEW = `{ transcripts(participants: ["bob@co.com"]) { id } }`;
// DEPRECATED: title parameter for search
const OLD = `{ transcripts(title: "standup") { id } }`;

// CURRENT: keyword with scope
const NEW = `{ transcripts(keyword: "standup") { id } }`;
// DEPRECATED: date parameter (single date)
const OLD = `{ transcripts(date: "2026-03-01") { id } }`;

// CURRENT: fromDate/toDate range
const NEW = `{
  transcripts(
    fromDate: "2026-03-01T00:00:00Z"
    toDate: "2026-03-31T23:59:59Z"
  ) { id }
}`;

Field-Level Deprecations

// DEPRECATED
transcript.host_email

// CURRENT
transcript.organizer_email

Migration Procedure

Step 1: Scan Codebase for Deprecated Patterns

set -euo pipefail
echo "=== Scanning for deprecated Fireflies patterns ==="

# Deprecated query parameters
grep -rn 'organizer_email:' --include='*.ts' --include='*.js' --include='*.py' . || echo "No organizer_email (good)"
grep -rn 'participant_email:' --include='*.ts' --include='*.js' --include='*.py' . || echo "No participant_email (good)"
grep -rn 'host_email' --include='*.ts' --include='*.js' --include='*.py' . || echo "No host_email (good)"
grep -rn 'transcripts(.*title:' --include='*.ts' --include='*.js' --include='*.py' . || echo "No title param (good)"
grep -rn 'transcripts(.*date:' --include='*.ts' --include='*.js' --include='*.py' . || echo "No date param (good)"

Step 2: Update Query Patterns

Create a migration helper:

// migrations/fireflies-deprecations.ts

/**
 * Maps old query parameter names to new ones.
 * Update your GraphQL queries to use the new parameter names.
 */
const PARAM_MIGRATIONS: Record<string, string> = {
  "organizer_email": "organizers (now an array)",
  "participant_email": "participants (now an array)",
  "title": "keyword",
  "date": "fromDate + toDate",
  "host_email": "organizer_email",
};

export function checkForDeprecations(query: string): string[] {
  const warnings: string[] = [];
  for (const [old, replacement] of Object.entries(PARAM_MIGRATIONS)) {
    if (query.includes(old)) {
      warnings.push(`Deprecated: "${old}" → use "${replacement}"`);
    }
  }
  return warnings;
}

Step 3: Introspect Schema for Changes

set -euo pipefail
# Discover all available query fields
curl -s -X POST https://api.fireflies.ai/graphql \
  -H "Authorization: Bearer $FIREFLIES_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "{ __schema { queryType { fields { name args { name type { name kind } } } } } }"
  }' | jq '.data.__schema.queryType.fields[] | {name, args: [.args[] | .name]}'

# Discover transcript fields
curl -s -X POST https://api.fireflies.ai/graphql \
  -H "Authorization: Bearer $FIREFLIES_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "{ __type(name: \"Transcript\") { fields { name type { name kind } } } }"
  }' | jq '.data.__type.fields[] | .name'

Step 4: Test Updated Queries

import { describe, it, expect } from "vitest";
import { checkForDeprecations } from "../migrations/fireflies-deprecations";

describe("Deprecation Check", () => {
  it("should flag deprecated parameters", () => {
    const warnings = checkForDeprecations(
      '{ transcripts(organizer_email: "test") { id } }'
    );
    expect(warnings.length).toBeGreaterThan(0);
    expect(warnings[0]).toContain("organizers");
  });

  it("should pass clean queries", () => {
    const warnings = checkForDeprecations(
      '{ transcripts(organizers: ["test"]) { id } }'
    );
    expect(warnings.length).toBe(0);
  });
});

Step 5: Monitor Fireflies Changelog

# Check for API updates
set -euo pipefail
curl -s https://docs.fireflies.ai/additional-info/change-log | head -100
# Or visit: https://docs.fireflies.ai/getting-started/whats-new

Error Handling

Issue Cause Solution
Field not found Using removed field Introspect schema, update query
Unexpected null Field renamed Check deprecation list above
Query validation error Old parameter name Update to array-based params
Type mismatch String vs array param Wrap single value in array

Output

  • Codebase scanned for deprecated patterns
  • All queries updated to current API patterns
  • Schema introspection results for reference
  • Tests verifying updated queries work

Resources

Next Steps

For CI integration during upgrades, see fireflies-ci-integration.

信息
Category 编程开发
Name fireflies-upgrade-migration
版本 v20260423
大小 6.07KB
更新时间 2026-04-26
语言