Skip to content

api: add gps device capture to records schema - #75

Merged
KaraFox merged 5 commits into
v2from
feature/FLCRM-20532-gps-device-capture-api-openapi
Jul 24, 2026
Merged

api: add gps device capture to records schema#75
KaraFox merged 5 commits into
v2from
feature/FLCRM-20532-gps-device-capture-api-openapi

Conversation

@sjperaltas

@sjperaltas sjperaltas commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

What?

  • Add gps_device_capture to Records v2 response schemas
  • Add a reusable GpsDeviceCapture response schema with read-only geometry_matches_capture
  • Add a writable GpsDeviceCaptureRequest schema for record create/update requests

Why?

  • Documents the backend GPS device capture contract for FLCRM-20532
  • Prevents downstream schema validation failures caused by the new response shape
  • Keeps writable input separate from the server-computed geometry_matches_capture field

Related PRs:

Resolution

  • Updated Record and RecordHistoryItem to include gps_device_capture
  • Updated RecordRequest and RecordPatchRequest to accept gps_device_capture
  • Modeled geometry_matches_capture as a response-only boolean inside the response schema

Code Review

High quality code reviews are expected. You can utilize this PR review checklist to help you conduct one.

Testing

  • Validated reference/rest-api.json parses as valid JSON
  • Ran npx --yes rdme openapi validate rest-api.json successfully
  • Checked for RAW_BODY anti-patterns
  • Reviewed the diff to confirm only the Records-related schemas changed

Copilot AI review requested due to automatic review settings June 22, 2026 18:54
@sjperaltas
sjperaltas requested review from a team as code owners June 22, 2026 18:54

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the OpenAPI specification (reference/rest-api.json) to document the new gps_device_capture shape on Records v2 responses and to accept corresponding input on record create/update requests, aligning the published schema with the backend contract for FLCRM-20532.

Changes:

  • Add gps_device_capture to the Record and RecordHistoryItem response schemas.
  • Introduce reusable GpsDeviceCapture (response) and GpsDeviceCaptureRequest (write) schemas, with geometry_matches_capture modeled as response-only (readOnly).
  • Extend RecordRequest and RecordPatchRequest to accept gps_device_capture via GpsDeviceCaptureRequest.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread reference/rest-api.json
Comment thread reference/rest-api.json
Comment thread reference/rest-api.json Outdated
Comment thread reference/rest-api.json Outdated
Copilot AI review requested due to automatic review settings July 22, 2026 20:44
sjperaltas and others added 2 commits July 22, 2026 14:46
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@sjperaltas
sjperaltas force-pushed the feature/FLCRM-20532-gps-device-capture-api-openapi branch from b8709f1 to 93c637c Compare July 22, 2026 20:46
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 4 comments.

Comment thread reference/rest-api.json
Comment thread reference/rest-api.json Outdated
Comment thread reference/rest-api.json Outdated
Comment thread reference/rest-api.json Outdated
Copilot AI review requested due to automatic review settings July 22, 2026 21:01

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 3 comments.

Comment thread reference/rest-api.json
Comment thread reference/rest-api.json
Comment thread reference/rest-api.json
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings July 22, 2026 22:02

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 5 comments.

Comment thread reference/rest-api.json
Comment thread reference/rest-api.json
Comment thread reference/rest-api.json Outdated
Comment thread reference/rest-api.json
Comment thread reference/rest-api.json
Comment thread reference/rest-api.json Outdated
Copilot AI review requested due to automatic review settings July 23, 2026 14:30
@sjperaltas
sjperaltas force-pushed the feature/FLCRM-20532-gps-device-capture-api-openapi branch from 15fe4f2 to d1c2473 Compare July 23, 2026 14:31
@sjperaltas
sjperaltas requested a review from KaraFox July 23, 2026 14:35

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 4 comments.

Comment thread reference/rest-api.json
Comment thread reference/rest-api.json
Comment thread reference/rest-api.json
Comment thread reference/rest-api.json
Copilot AI review requested due to automatic review settings July 23, 2026 14:48

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 4 comments.

Comment thread reference/rest-api.json
Comment thread reference/rest-api.json
Comment thread reference/rest-api.json
Comment thread reference/rest-api.json
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings July 23, 2026 15:13
@sjperaltas
sjperaltas force-pushed the feature/FLCRM-20532-gps-device-capture-api-openapi branch from d1c2473 to 28ac3b7 Compare July 23, 2026 15:13

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.

Comment thread reference/rest-api.json
Comment thread reference/rest-api.json
@sjperaltas

Copy link
Copy Markdown
Contributor Author

/retest

@KaraFox
KaraFox merged commit 400b859 into v2 Jul 24, 2026
4 of 5 checks passed
@KaraFox
KaraFox deleted the feature/FLCRM-20532-gps-device-capture-api-openapi branch July 24, 2026 21:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants