bwilliams
70d62f280e
GET /api/opportunities lists the stored opportunities, newest release first,
a page at a time (offset, and limit up to 100, default 50); has_more says
whether another page follows. GET /api/opportunities/{uuid} returns one with
its releases. PUT and DELETE /api/opportunities/{uuid}/marks/{mark} set and
clear one mark (hidden, skipped, interested, bid_submitted, won, lost) and
return them all; won and lost exclude each other (409). The API uses the
types in internal/types, and changing a mark is made atomic, as the store
replaces all of an opportunity's marks at once. The marks are found by
reflection: every bool field of types.OpportunityMarks, by its JSON name, so
a new mark needs no API change.
The API has one entry point, api.New, with its dependencies as options
(api.WithStore), and the server only mounts it under /api, keeping the
middleware. New resources are added inside internal/api. job-search serve
passes server.WithStore when database.file is set, opening the store before
the server; without one there are no opportunity routes.
The API is described by swag v2 annotations on the handlers. go generate
writes the OpenAPI 3.1 description (git-ignored, like the OCDS types), which
the server embeds and serves at /api/openapi.json, with Swagger UI at
/api/docs. A test checks the description and the routes match. swag is in
the README's dev tools, pinned to v2.0.0-rc6, and the build now needs it.
24 lines
507 B
Go
24 lines
507 B
Go
package api
|
|
|
|
import (
|
|
"fmt"
|
|
"strconv"
|
|
)
|
|
|
|
// intParam parses the query parameter text as an integer from low to high,
|
|
// or returns fallback if it is empty. Its error is meant for the client.
|
|
func intParam(text string, fallback, low, high int) (int, error) {
|
|
if text == "" {
|
|
return fallback, nil
|
|
}
|
|
|
|
number, err := strconv.Atoi(text)
|
|
if err != nil || number < low || number > high {
|
|
return 0, fmt.Errorf(
|
|
"parameter must be an integer between %d and %d", low, high,
|
|
)
|
|
}
|
|
|
|
return number, nil
|
|
}
|