Repository navigation
Commit 13f90b2
authored
docs(api): clarify per-version listings and latest filtering (#1735)
Callers can mistake the first search result for the current version
because the list documentation does not explain that results contain one
record per version. Document ascending name/version-string ordering,
explain that it is neither semantic-version nor publication-date
ordering, and show `version=latest` for current records only. The
clarification appears in the API guide, reference OpenAPI document, and
generated documentation for both API versions.
Closes #1676.
Validation:
- CI build, lint, schema/example validation, govulncheck, and full
unit/integration tests passed for `aff04c2`.
- Local `make validate` and `go test ./internal/api -run
'^TestOpenAPIEndpointCompliance$' -count=1` passed.
- `gofmt` and `git diff --check` passed.
- Live read-only verification reproduced superseded records without the
filter and only `isLatest=true` with `version=latest`.
This changes documentation only; query behavior and result ordering are
unchanged.1 parent edd9fa7 commit 13f90b2
3 files changed
Lines changed: 19 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
40 | 40 | | |
41 | 41 | | |
42 | 42 | | |
43 | | - | |
| 43 | + | |
44 | 44 | | |
45 | 45 | | |
46 | 46 | | |
47 | 47 | | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
48 | 56 | | |
49 | 57 | | |
50 | 58 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
22 | 22 | | |
23 | 23 | | |
24 | 24 | | |
25 | | - | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
26 | 31 | | |
27 | 32 | | |
28 | 33 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
89 | 89 | | |
90 | 90 | | |
91 | 91 | | |
92 | | - | |
93 | | - | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
94 | 96 | | |
95 | 97 | | |
96 | 98 | | |
| |||
0 commit comments