Skip to content

feat: GTFS diff schema v2#11

Merged
cka-y merged 6 commits intomainfrom
feat/schemav2
Apr 9, 2026
Merged

feat: GTFS diff schema v2#11
cka-y merged 6 commits intomainfrom
feat/schemav2

Conversation

@cka-y
Copy link
Copy Markdown
Contributor

@cka-y cka-y commented Apr 8, 2026

This pull request introduces a new versioning structure for the GTFS Diff specification, documents the stable v1 (CSV) and draft v2 (JSON) formats, and adds comprehensive documentation and examples for both. The v2 specification is formalized with a detailed JSON Schema and a realistic example output, clarifying the structure and semantics of the new JSON-based diff format.

Specification Versioning and Documentation

  • Added a "Specification versions" section to README.md, listing v1 (CSV, stable) and v2 (JSON, draft), and updated resource links to reflect the new formats.
  • Added a complete specification document for v1 (CSV) format, including field definitions, ordering, examples, and rationale.

GTFS Diff v2 (JSON) Format

  • Introduced a draft JSON Schema for GTFS Diff v2, defining the structure for metadata, summary, and per-file diffs, including row-level changes and truncation metadata. (spec/v2/json_schema/gtfs_diff_v2_schema.json)
  • Added a realistic example output file for v2, demonstrating metadata, summary statistics, and detailed file diffs in the new JSON format. (spec/v2/examples/example_output.json)

@cka-y cka-y marked this pull request as ready for review April 8, 2026 19:57
@cka-y cka-y linked an issue Apr 8, 2026 that may be closed by this pull request
Comment thread spec/v2/json_schema/gtfs_diff_v2_schema.json Outdated
Comment thread spec/v2/json_schema/gtfs_diff_v2_schema.json Outdated
Comment thread spec/v2/json_schema/gtfs_diff_v2_schema.json Outdated
@cka-y cka-y requested a review from davidgamez April 9, 2026 19:58
@cka-y cka-y merged commit 8de810c into main Apr 9, 2026
@cka-y cka-y deleted the feat/schemav2 branch April 9, 2026 20:08
Comment thread spec/v1/specification.md

|**Field Name**|**Type**|**Required**|**Description**|
| :- | :- | :- | :- |
|id|String|Required|Uniquely identifies a row in the GFTS Diff file.|
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
|id|String|Required|Uniquely identifies a row in the GFTS Diff file.|
|id|String|Required|Uniquely identifies a row in the GTFS Diff file.|

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[SPIKE] Define and document the GTFS diff changelog schema

3 participants