docs: move vendor api spec under docs/data-sources
This commit is contained in:
1 parent
0b6dead194
commit
24ea639a49
2 files changed
+3
-3
No files matched your search
File renamed without changes.
@@ -7,7 +7,7 @@ sources:
|
||||
- https://service.vic.gov.au/find-services/transport-and-driving/servo-saver/help-centre/servo-saver-public-api/terms-and-acceptable-use-policy (fetched 30 Aug 2026; AUP version Sep 2025; page modified 2025-10-14)
|
||||
- https://service.vic.gov.au/find-services/transport-and-driving/servo-saver/help-centre/servo-saver-public-api/apply-for-servo-saver-public-api
|
||||
- live probes of https://api.fuel.service.vic.gov.au/open-data/v1 (30 Aug 2026, no key)
|
||||
- documents/api_spec.json (NSW OneGov Fuel API Swagger 2.0)
|
||||
- docs/data-sources/nsw/api_spec.json (NSW OneGov Fuel API Swagger 2.0)
|
||||
- codebase inspection (backend + frontend)
|
||||
---
|
||||
|
||||
@@ -34,7 +34,7 @@ Two questions:
|
||||
- Read side (stations-with-prices, prices, trends, brands, fuel-types, suburb-boundaries) is mostly **state-agnostic SQL**; radius search works anywhere with coordinates. Suburb-polygon search is NSW-only because `suburb_boundary` only loads the NSW Geoscape dataset.
|
||||
- Frontend ignores `state` entirely; map defaults to Sydney; `frontend/utils/fuelTypeUtils.ts` colours are keyed on NSW codes (`U91, DL, E10, P95, P98`); `FuelTypeService.GetCommonFuelTypes` hardcodes `{U91, DL, E10, P95, P98}`. `/attribution` page exists and names the NSW API (already says it covers NSW/ACT/TAS).
|
||||
- **No component displays `price.lastUpdated`** (checked `frontend/app`, `components`, `utils`) — the generated client carries the field, nothing renders it.
|
||||
- NSW units: **cents per litre, 1 decimal** (`price` example `186.9` in `documents/api_spec.json`) — identical to VIC units, so no conversion needed.
|
||||
- NSW units: **cents per litre, 1 decimal** (`price` example `186.9` in `docs/data-sources/nsw/api_spec.json`) — identical to VIC units, so no conversion needed.
|
||||
|
||||
## Key Findings — Terms (fetched 30 Aug 2026)
|
||||
|
||||
@@ -147,6 +147,6 @@ Registration itself: apply via the 3-step form (`.../apply-for-servo-saver-publi
|
||||
|
||||
- PDF was extracted locally with pypdf (29 pages, fully machine-readable); content summarised above, raw extract at `/var/folders/.../fairfuel.txt` (ephemeral).
|
||||
- Terms page is JS-rendered; captured via Firecrawl (markdown, 59 KB) — key clauses quoted above; full capture ephemeral at `/var/folders/.../servo-terms.md`.
|
||||
- NSW comparison facts from `documents/api_spec.json` in-repo (NSW OneGov, spec version 2.0.05) — states covered: "The v1 API can only access data for NSW. The v2 API includes data for Tasmania (TAS) as well as NSW."
|
||||
- NSW comparison facts from `docs/data-sources/nsw/api_spec.json` in-repo (NSW OneGov, spec version 2.0.05) — states covered: "The v1 API can only access data for NSW. The v2 API includes data for Tasmania (TAS) as well as NSW."
|
||||
- Live probes on 30 Aug 2026 confirmed endpoint reachability and header validation without a consumer ID.
|
||||
- Codebase facts current as of HEAD on 30 Aug 2026 (clean working tree).
|
||||
Reference in new issue
Block a user