Cleanup outlook endpoints and completed roadmap documentation
All checks were successful
ci/woodpecker/push/build-image Pipeline was successful
All checks were successful
ci/woodpecker/push/build-image Pipeline was successful
This commit is contained in:
@@ -8,7 +8,7 @@ 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, outlook active/location filter construction,
|
||||
forecast day-slice filtering, outlook active filter construction,
|
||||
alert active-time selection, response envelopes, and template names.
|
||||
|
||||
## Inputs and Outputs
|
||||
@@ -36,7 +36,7 @@ The adapter may:
|
||||
- choose the presenter function for an endpoint;
|
||||
- filter forecast copies for `/today` and `/tomorrow`;
|
||||
- pass the current UTC instant to active-alert application filtering;
|
||||
- construct outlook active/location filters.
|
||||
- construct outlook active filters.
|
||||
|
||||
The adapter must not:
|
||||
|
||||
@@ -99,10 +99,8 @@ common query values are lowercased and trimmed before binding where applicable.
|
||||
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.
|
||||
Outlook routes accept `day` and `outlookType`. `containsLocation` is a response
|
||||
field only and is rejected as a request parameter.
|
||||
|
||||
## Timezone Parsing
|
||||
|
||||
@@ -144,17 +142,13 @@ 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`.
|
||||
- `/outlooks/convective/active` adds `ActiveAt=outlookNow().UTC()`.
|
||||
|
||||
The package variable `outlookNow` exists so endpoint tests can make active and
|
||||
location filtering deterministic.
|
||||
The package variable `outlookNow` exists so endpoint tests can make active
|
||||
filtering deterministic.
|
||||
|
||||
The application service returns filtered outlook copies and trims run-level
|
||||
discussions to days represented by retained outlooks.
|
||||
`/outlooks/convective/location` is retained for compatibility and active
|
||||
local-outlook behavior under the weatherfeeder outlook v2 contract.
|
||||
|
||||
## Failure Behavior
|
||||
|
||||
|
||||
Reference in New Issue
Block a user