Skip to content

I12.6 · Watch Segment #84

Open
Open

Description

@adssib

Part of #15

Story

As a developer whose code calls Segment, I want patch-it to know when Segment breaks, deprecates or retires something, so I get the fix before production does.

Subtasks

  • Find Segment's sources and record them with the date checked (verify, don't guess; leave TBD if unknown):
    • deprecations / sunset page
    • API changelog (RSS / Atom if there is one)
    • OpenAPI spec, if published
    • official SDKs and their release notes / changelogs (Python and JS first)
    • API versioning scheme (date-based, path, header, none)
  • Pick the format plugin for each source (OpenAPI, RSS, GitHub Releases, changelog file, registry, prose) and add catalog lines
  • Golden test: a saved copy of each source in, the expected events out
  • One real historical breaking change as a replay fixture
  • Provider page providers/segment.md from the template
  • Add or update its row in docs/plugins.md (see CONTRIBUTING.md)
  • Note what the client needs to fix it (existing handler, or a new fix kind in the client)

Acceptance criteria

  • Daily ingest emits Segment events, each with source_url and an exact source_excerpt
  • The replayed historical change produces the right events
  • The provider page lists every source with its date checked

Activity

  1. brandonphelps1212 commented on Nov 19, 2026

    @brandonphelps1212
    Contributor

    Research findings (checked 2026-11-19): not yet, no pinnable source

    Sources

    Item Finding
    Public API OpenAPI Served only inside the docs site's JavaScript at docs.segmentapis.com (a content-hashed file that 404s once replaced; /swagger.json is a 404). It's not committed anywhere public, and no license is stated. info.version is SemVer (74.1.0), 200 operations.
    History 26 Wayback snapshots (2024-02 to 2026-07), and the generated public-api-sdk-* repos (MIT; about 2,800 tags, 158 versions, no changelog).
    Versioning Per endpoint, alpha/beta/stable, chosen by Accept: application/vnd.segment.{v1alpha,v1beta,v1,v2}+json. "Breaking changes are common and expected" in alpha.
    Deprecations page / changelog None found for the API. Twilio's changelog feed covers all products, and its 2 Segment items are announcements.
    SDKs analytics-python, analytics-next, analytics-node, analytics-go (MIT). There's no table of removed members in any of them.

    Why not yet

    • One deprecation in four years: DELETE /regulations/{regulateId}, flagged and described as deprecated (SDK 58.7.0, 2025-07-01), then removed in 73.0.0 (2026-03-26). That's clean, but rare.
    • Removals: 9 across the docs snapshots, 8 of them unmarked and all alpha-only. In the SDK history, 41 unmarked removals, 22 of which came back.
    • The only copy of the spec is a hashed live file with no license, so a plugin could only cite a Wayback snapshot. It would fire about once every year or two.

    Revisit when

    Segment publishes the spec somewhere pinnable (a repo, a release asset, a stable URL) with a license, or a deprecations page. Leaving this in Backlog.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions