Skip to content

docs(substations): add to data catalog (PR 9/9)#202

Closed
texture-fleet-agent[bot] wants to merge 2 commits intomeridian/substations-join-apifrom
meridian/substations-docs
Closed

docs(substations): add to data catalog (PR 9/9)#202
texture-fleet-agent[bot] wants to merge 2 commits intomeridian/substations-join-apifrom
meridian/substations-docs

Conversation

@texture-fleet-agent
Copy link
Copy Markdown
Contributor

Part of the substations 9th entry point epic.

Closes out the 9-PR substations epic with documentation — adds the substations dataset to the data catalog so users know what fields are available, where the data comes from (EIA Form 860 + OpenStreetMap hybrid), and how to query it.

Stack: PR 9/9 (base: previous [PR 8 join API]) — final PR in the series.

Adds comprehensive documentation for the substations dataset to the CommonGrid
data catalog. Includes schema, sources, API endpoints, join tables, and integration
notes for developers using the new entity.

**What's included:**
- Substations entry in DATA_CATALOG.md (schema, record count, update frequency)
- ODbL attribution notes and requirements
- API endpoint documentation + example queries
- Join table relationships (transmission lines, power plants)
- Historical context + selection rationale

**Features:**
- Voltage filtering guidance (bulk-power focus by default)
- Soft-delete pattern documentation
- Sync cadence details (weekly automatic)
- Source attribution per-record via source + sourceUrl

**Completes:**
- PR #1: Schema ✅
- PR #2: Sync (OSM + EIA) ✅
- PR #3: API endpoints + seed ✅
- PR #4: UI pages + map ⏳ (waiting for auth)
- PR #5: Cron jobs ✅
- PR #6: transmission_line_endpoints join ✅
- PR #7: power_plant_interconnections join ✅
- PR #8: Join query API ✅
- PR #9: Docs + catalog ✅ (this PR)

---
*Part of CommonGrid 9th entry point milestone (substations) — PR 9 of 9*
*All 9 PRs locally ready. Waiting for merge authority to push PR #4 and cascade.*
@vercel
Copy link
Copy Markdown

vercel Bot commented May 5, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
commongrid Ready Ready Preview, Comment May 5, 2026 11:00pm

Request Review

Vercel Pro plan enforces a max of 800 seconds for serverless function
maxDuration. The previous 1800s value caused the build to succeed but
deployment to fail at the patchBuild step with:

  Builder returned invalid maxDuration value for Serverless Function
  "api/cron/sync-substations". Serverless Functions must have a
  maxDuration between 1 and 800 for plan pro.

Capping at 800 unblocks deploys. Full US substation syncs that exceed
this should be moved to a long-running runner (GitHub Actions, Render,
etc.) rather than a Vercel serverless function.
@texture-fleet-agent texture-fleet-agent Bot deleted the branch meridian/substations-join-api May 6, 2026 15:06
@texture-coding-agent
Copy link
Copy Markdown
Contributor

Reopening after incorrect close during fallback merge. CI ✓, ready to merge.

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.

1 participant