Skip to content

:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.

3.5 KB
Raw Blame
/**
 * Auto-generated Zod validation schemas from the Django backend OpenAPI schema.
 * To modify these schemas, update the Django serializers or views, then run:
 *   hogli build:openapi
 * Questions or issues? #team-devex on Slack
 *
 * PostHog API - generated
 * OpenAPI spec version: 1.0.0
 */
import * as zod from 'zod'

/**
 * Enable or disable all CI signal detectors in one transaction.
 */
export const EngineeringAnalyticsCiSignalsConfigUpdateBody = /* @__PURE__ */ zod.object({
    enabled: zod.boolean().describe('Enable or disable every CI signal detector atomically.'),
})

/**
 * Opens a pull request that edits the repository's checked-in .test_quarantine.json and, for a new quarantine, opens a tracking issue that the PR links but does not close. The file stays the source of truth that CI enforces; this never bypasses it. A quarantine only affects CI runs that start after the PR merges.
 * @summary Quarantine, extend, or unquarantine a flaky test
 */
export const EngineeringAnalyticsQuarantineRequestBody = /* @__PURE__ */ zod.object({
    operation: zod
        .enum(['quarantine', 'extend', 'remove'])
        .describe('\* `quarantine` - Quarantine\n\* `extend` - Extend\n\* `remove` - Remove')
        .describe(
            "What to do: 'quarantine' (add or replace an entry and file a tracking issue), 'extend' (re-stamp an existing entry's expiry, reusing its issue), or 'remove' (delete the entry). All three open a pull request.\n\n\* `quarantine` - Quarantine\n\* `extend` - Extend\n\* `remove` - Remove"
        ),
    selector: zod
        .string()
        .describe(
            "Test selector to act on: an exact test id, a file, a directory, a class prefix, or 'product:<dashed-name>'."
        ),
    runner: zod
        .union([
            zod
                .enum(['pytest', 'jest', 'playwright'])
                .describe('\* `pytest` - Pytest\n\* `jest` - Jest\n\* `playwright` - Playwright'),
            zod.null(),
        ])
        .optional()
        .describe(
            "Test runner the selector targets: 'pytest', 'jest', or 'playwright'. Existing entries and Jest file extensions are inferred for older clients that omit it; other selectors default to 'pytest'.\n\n\* `pytest` - Pytest\n\* `jest` - Jest\n\* `playwright` - Playwright"
        ),
    repo: zod
        .string()
        .nullish()
        .describe("Optional 'owner\/name' repository override; defaults to the team's most active repo."),
    reason: zod
        .string()
        .optional()
        .describe('Why the test is quarantined. Required for quarantine and extend; ignored by remove.'),
    owner: zod
        .string()
        .optional()
        .describe(
            "GitHub team or user handle responsible for the fix, e.g. '@PostHog\/team-x'. Required for quarantine and extend."
        ),
    issue: zod
        .string()
        .optional()
        .describe(
            'Existing tracking issue URL, carried forward on extend and remove. Ignored by quarantine, which files a fresh issue.'
        ),
    expires: zod.iso
        .date()
        .nullish()
        .describe(
            'ISO date the quarantine expires (at most 30 days out). Defaults to 14 days from today. Ignored by remove.'
        ),
    mode: zod
        .enum(['run', 'skip'])
        .describe('\* `run` - Run\n\* `skip` - Skip')
        .optional()
        .describe(
            "'run' (the test still executes but cannot fail the suite) or 'skip' (not run at all). Defaults to 'run'.\n\n\* `run` - Run\n\* `skip` - Skip"
        ),
})