Document convective outlook endpoints
This commit is contained in:
@@ -8,7 +8,8 @@ This document describes the internal HTTP adapter under
|
||||
|
||||
The HTTP adapter turns feedapi route definitions into calls on the application
|
||||
service boundary. It owns route registration, query binding, request validation,
|
||||
forecast day-slice filtering, response envelopes, and template names.
|
||||
forecast day-slice filtering, outlook active/location filter construction,
|
||||
response envelopes, and template names.
|
||||
|
||||
## Inputs and Outputs
|
||||
|
||||
@@ -33,7 +34,8 @@ The adapter may:
|
||||
- bind and validate query parameters;
|
||||
- call the `Service` interface;
|
||||
- choose the presenter function for an endpoint;
|
||||
- filter forecast copies for `/today` and `/tomorrow`.
|
||||
- filter forecast copies for `/today` and `/tomorrow`;
|
||||
- construct outlook active/location filters.
|
||||
|
||||
The adapter must not:
|
||||
|
||||
@@ -59,9 +61,9 @@ declared in endpoint definitions, but `templates.base_dir` is loaded by feedapi.
|
||||
|
||||
## State
|
||||
|
||||
The adapter has no durable state. `forecastNow` is package-level state only to
|
||||
make forecast day filtering testable. Do not add request caches or cross-request
|
||||
mutable state here.
|
||||
The adapter has no durable state. `forecastNow` and `outlookNow` are
|
||||
package-level state only to make time-dependent endpoint tests deterministic.
|
||||
Do not add request caches or cross-request mutable state here.
|
||||
|
||||
## Route Registry
|
||||
|
||||
@@ -71,6 +73,7 @@ mutable state here.
|
||||
- active alerts;
|
||||
- current conditions;
|
||||
- weather stories;
|
||||
- convective outlooks;
|
||||
- forecast discussions;
|
||||
- hourly and narrative forecasts.
|
||||
|
||||
@@ -80,19 +83,25 @@ middleware, and error normalization after definitions are registered.
|
||||
|
||||
## Query Binding
|
||||
|
||||
There are three binder shapes:
|
||||
Binder shapes include:
|
||||
|
||||
- `bindQuery`: `format` and `units`;
|
||||
- `bindPrecisionQuery`: `format`, `units`, and `precision`;
|
||||
- `bindForecastPrecisionQuery`: `format`, `units`, `precision`, and timezone;
|
||||
- `bindTimezoneQuery`: `format`, `units`, and timezone.
|
||||
- outlook binders: `format`, `units`, timezone, and outlook filters.
|
||||
|
||||
All binders use feedapi binding helpers with `RejectUnknown: true`. Supported
|
||||
common query values are lowercased and trimmed before binding where applicable.
|
||||
|
||||
`precision` defaults to `0` and must be between `0` and `2`. Timezone parsing is
|
||||
available only through binders used by forecast, discussion, and weather story
|
||||
routes.
|
||||
available only through binders used by forecast, discussion, weather story, and
|
||||
outlook routes.
|
||||
|
||||
Outlook routes accept `day`, `outlookType`, and, except for
|
||||
`/outlooks/convective/location`, `containsLocation`. The location route always
|
||||
adds `containsLocation=true` after binding and rejects an explicit
|
||||
`containsLocation` query value.
|
||||
|
||||
## Timezone Parsing
|
||||
|
||||
@@ -122,6 +131,19 @@ Filtering behavior:
|
||||
The package variable `forecastNow` exists so endpoint tests can make day-slice
|
||||
behavior deterministic.
|
||||
|
||||
## Outlook Filters
|
||||
|
||||
Outlook route filters are built at the HTTP boundary and passed to the
|
||||
application service:
|
||||
|
||||
- `/outlooks/convective` uses only user-supplied filters;
|
||||
- `/outlooks/convective/active` adds `ActiveAt=outlookNow().UTC()`;
|
||||
- `/outlooks/convective/location` adds the same active timestamp and
|
||||
`ContainsLocation=true`.
|
||||
|
||||
The package variable `outlookNow` exists so endpoint tests can make active and
|
||||
location filtering deterministic.
|
||||
|
||||
## Failure Behavior
|
||||
|
||||
Binder failures become feedapi invalid-parameter responses. Handler service
|
||||
|
||||
Reference in New Issue
Block a user