Repository navigation
Commit 4f3a7b7
committed
docs(csapi): document pagination contract on list methods (A4 / #167)
Phase 8 / Task A4 / Finding #167. Adds a centralized "## Pagination" section
to the CSAPIQueryBuilder class docblock and a "@remarks Pagination" block to
every list method on the class.
Locked decision (per #167): docs-only. No behavior change. No auto-pagination
helper. The opt-in async-iterator / followNext helper is deferred to #170.
Class docblock anchor inserted between "## Resource Discovery" / "## Error
Handling" sections, covering:
- server-chosen default page size (varies by impl: connected-systems-go
defaults to limit=10; OpenSensorHub defaults to limit=100)
- rel="next" HATEOAS links in response body
- explicit pointer to the deferred helper in #170
39 list methods received the per-method @remarks block (the issue requires
">=16"; touching every list method satisfies the spirit of the issue and
avoids future audit drift):
Top-level: getSystems, getDeployments, getProcedures, getSamplingFeatures,
getProperties, getDatastreams, getObservations, getControlStreams,
getCommands.
Association: getSystemHistory, getSystemSubsystems, getSystemDatastreams,
getSystemControlStreams, getSystemSamplingFeatures, getSystemDeployments,
getSystemProcedures, getDeploymentSubdeployments, getDeploymentSystems,
getDeploymentHistory, getProcedureSystems, getProcedureDatastreams,
getProcedureHistory, getSamplingFeatureSystems, getSamplingFeatureObservations,
getSamplingFeatureHistory, getPropertySystems, getPropertyDatastreams,
getPropertyControlStreams, getPropertyHistory, getDatastreamObservations,
getDatastreamSystems, getDatastreamProcedures, getDatastreamHistory,
getObservationHistory, getControlStreamCommands, getControlStreamSystems,
getControlStreamProcedures, getControlStreamHistory, getCommandStatus.
Single-resource getters and create/update/delete methods are intentionally
NOT touched. No method signatures, return types, or runtime behavior changed.
Refs: docs/planning/P8-implementation-guide.md (Task A4)
Closes #1671 parent f3ebcbc commit 4f3a7b7
3 files changed
Lines changed: 282 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
42 | 42 | | |
43 | 43 | | |
44 | 44 | | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
45 | 59 | | |
46 | 60 | | |
47 | 61 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
170 | 170 | | |
171 | 171 | | |
172 | 172 | | |
173 | | - | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
174 | 183 | | |
175 | 184 | | |
176 | 185 | | |
| |||
0 commit comments