docs: document gps_device_capture for FLCRM-20930 - #86
Conversation
Add Records, Query, Data Events, and OpenAPI examples for GPS device capture. OpenSpec change lives in openspec/changes/document-gps-device-capture. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Warning
Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.
Documents gps_device_capture end-to-end across Records API v2, Query API, and Data Events, and adds OpenAPI examples to help integrators map and query external GPS receiver metadata (FLCRM-20930).
Changes:
- Adds
gps_device_captureto Records API docs (properties + create/update/PATCH examples) and OpenAPI example payloads. - Documents Query API
_gps_device_capture(jsonb) with JSON operator examples (->>and@>). - Updates Data Events
change-geometrydocs to mentionevent.valueGeoJSON and optionalevent.gpsData.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| reference/rest-api.json | Adds request/response examples that include gps_device_capture. |
| reference/RECORDS/records-intro.md | Documents gps_device_capture in the record properties table and adds an example. |
| reference/RECORDS/records-create.md | Adds gps_device_capture to create examples across languages. |
| reference/RECORDS/records-update.md | Adds gps_device_capture to update examples across languages. |
| reference/RECORDS/records-partial-update.md | Adds a PATCH example and notes about clearing via null. |
| reference/QUERY/query-intro.md | Adds _gps_device_capture column doc + SQL JSONB query examples. |
| docs/DATA EVENTS/data-events-reference/index.md | Expands change-geometry docs and includes an example event payload with optional gpsData. |
| docs/DATA EVENTS/data-events-reference/data-events-on.md | Updates change-geometry callback docs to describe event.value and optional event.gpsData. |
| openspec/changes/document-gps-device-capture/* | Adds OpenSpec proposal/design/spec + task checklist for the doc change. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Align example coordinates, fix invalid form_id UUID, clarify null-on-write, label gpsData as illustrative, and guard satellite_count SQL casts. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
KaraFox
left a comment
KaraFox
left a comment
There was a problem hiding this comment.
You might want to archive your change, but this looks good.
Sync gps-device-capture-docs into main specs and move the completed change to archive. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Warning
Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.
Pull request overview
Copilot reviewed 13 out of 13 changed files in this pull request and generated 4 comments.
| } | ||
| ``` | ||
|
|
||
| Sending `gps_device_capture: null` clears stored GPS device metadata. Additional device-specific keys are allowed. |
What?
gps_device_captureon Records API v2 (properties table plus create/update/PATCH examples)_gps_device_captureJSONB filters (->>and@>)change-geometryoptionalevent.gpsDataand point integrators to persistedgps_device_captureWhy?
change-geometrynow includes event data that was undocumentedTesting
cypress:repeatinpackage.jsonwith your spec name, then run./utils/run-against {namespace} repeat.fulcrumapp/api; no Cypress specs were added or changed.reference/, runnpx --yes rdme openapi validate rest-api.json.reference/rest-api.jsonparses as JSON and has noRAW_BODYkeys.gps_device_captureis in the properties table, including thatnullclears the value.gps_device_capturepayload with nested GeoJSONgeometry._gps_device_captureJSONB examples: filter bydevice_namewith->>and byfix_typewith@>.change-geometry/ONdocs and confirmevent.valueis GeoJSON andevent.gpsDatais optional (keys may differ by platform).geometry_matches_capture.change-geometry, and ReadMe rendering ofrest-api.jsonexamples.