Skip to content

Commit 1cfddad

Browse files
committed
fix(contract): align zipcode paths and api tags with backend /docs. Related to #599
1 parent fccf3a4 commit 1cfddad

3 files changed

Lines changed: 8 additions & 8 deletions

File tree

contracts/openapi.yaml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,10 @@ tags:
3131
description: Health checks, schema introspection, and system status
3232
- name: jobs
3333
description: Cross-cutting async job status polling
34-
- name: external-apis
35-
description: Integrations with external APIs (Weather, Zipcode)
34+
- name: weather
35+
description: Weather forecast lookup via external API
36+
- name: zipcode
37+
description: Address and postal code geocoding via external API
3638

3739
paths:
3840
# ── Layer 1: Input ──────────────────────────────────────────────
@@ -102,7 +104,5 @@ paths:
102104
# ── Layer 9: External APIs ─────────────────────────────────────
103105
/api/v1/weather/forecast:
104106
$ref: "path/weather.yaml#/forecast"
105-
/api/v1/zipcode/postal-code:
106-
$ref: "path/zipcode.yaml#/postal_code"
107-
/api/v1/zipcode/location:
108-
$ref: "path/zipcode.yaml#/location"
107+
/api/v1/zipcode/lookup-address:
108+
$ref: "path/zipcode.yaml#/lookup_address"

contracts/path/weather.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ forecast:
55
Fetch hourly weather data for the given location and date range.
66
Coordinates must be provided as decimal degrees (e.g. `40.7128` for latitude, `-74.0060` for longitude).
77
tags:
8-
- external-apis
8+
- weather
99
parameters:
1010
- name: latitude
1111
in: query

contracts/path/zipcode.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ lookup_address:
77
place name, state, county, and country.
88
The list is ordered by relevance (most relevant first, up to 10 results).
99
tags:
10-
- external-apis
10+
- zipcode
1111
parameters:
1212
- name: address
1313
in: query

0 commit comments

Comments
 (0)