Skip to content

api: add gps device capture to records schema #75

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
KaraFox merged 5 commits into from
Jul 24, 2026
+80 −1
Merged

api: add gps device capture to records schema #75

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7b81a2f
Add gps_device_capture to records schema
sjperaltas Jun 22, 2026
93c637c
Refactor GPS device capture OpenAPI schemas
sjperaltas Jul 22, 2026
2b185d8
Document gps_device_capture response fields
sjperaltas Jul 22, 2026
ad9ab9c
Clarify GPS capture request schema contract
sjperaltas Jul 22, 2026
28ac3b7
Remove geometry_matches_capture from API schema
sjperaltas Jul 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 80 additions & 1 deletion reference/rest-api.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,6 +269,11 @@
}
}
},
"gps_device_capture": {
"$ref": "#/components/schemas/GpsDeviceCaptureBase",
"nullable": true,
"description": "Flexible GPS device metadata captured with the record."
},
Comment thread
sjperaltas marked this conversation as resolved.
Comment thread
sjperaltas marked this conversation as resolved.
Comment thread
sjperaltas marked this conversation as resolved.
"speed": {
Comment thread
sjperaltas marked this conversation as resolved.
"type": "number",
"nullable": true,
Expand Down Expand Up @@ -458,6 +463,11 @@
"geometry": {
"$ref": "#/components/schemas/Geometry"
},
"gps_device_capture": {
"$ref": "#/components/schemas/GpsDeviceCaptureBase",
"nullable": true,
"description": "Flexible GPS device metadata captured with the record."
},
Comment thread
sjperaltas marked this conversation as resolved.
Comment thread
sjperaltas marked this conversation as resolved.
"speed": {
"type": "number",
"nullable": true
Expand Down Expand Up @@ -511,6 +521,65 @@
},
"description": "Location metadata captured at creation or update time."
},
"GpsDeviceCaptureBase": {
"type": "object",
"description": "Flexible GPS device metadata captured with a record.",
"additionalProperties": true,
Comment thread
sjperaltas marked this conversation as resolved.
Comment thread
sjperaltas marked this conversation as resolved.
"properties": {
Comment thread
sjperaltas marked this conversation as resolved.
Comment thread
sjperaltas marked this conversation as resolved.
"device_name": {
"type": "string",
"description": "Name of the GPS device"
},
"manufacturer": {
"type": "string",
"description": "Manufacturer of the GPS device"
},
"fix_type": {
"type": "string",
"description": "Type of GPS fix"
},
"satellite_count": {
"type": "integer",
"description": "Number of satellites used for the fix"
},
"hdop": {
"type": "number",
"description": "Horizontal dilution of precision"
},
"vdop": {
"type": "number",
"description": "Vertical dilution of precision"
},
"pdop": {
"type": "number",
"description": "Position dilution of precision"
},
"differential_correction": {
"type": "boolean",
"description": "Whether differential correction was used"
},
"antenna_height": {
"type": "number",
"description": "Antenna height in meters"
},
"firmware_version": {
"type": "string",
"description": "Device firmware version"
},
"geometry": {
"$ref": "#/components/schemas/Geometry",
"description": "GPS-captured geometry reference."
}
}
},
"GpsDeviceCaptureRequest": {
"allOf": [
{
"$ref": "#/components/schemas/GpsDeviceCaptureBase"
}
],
"description": "GPS device metadata accepted during create/update. Known keys are documented and additional device-specific keys are accepted."
},
Comment thread
sjperaltas marked this conversation as resolved.
Comment thread
sjperaltas marked this conversation as resolved.
"AttachmentCopyAllRequest": {
"type": "object",
"required": [
Expand Down Expand Up @@ -3798,6 +3867,11 @@
"$ref": "#/components/schemas/Geometry",
"description": "Optional GeoJSON geometry (Point, LineString, Polygon, MultiLineString, or MultiPolygon). If provided, latitude/longitude will be updated to reflect this geometry."
},
"gps_device_capture": {
"$ref": "#/components/schemas/GpsDeviceCaptureRequest",
"nullable": true,
"description": "Flexible GPS device metadata captured with the record. Set null to clear metadata."
},
Comment thread
sjperaltas marked this conversation as resolved.
"form_values": {
"type": "object",
"description": "Field values keyed by field key",
Expand Down Expand Up @@ -3843,6 +3917,11 @@
"$ref": "#/components/schemas/Geometry",
"description": "Optional GeoJSON geometry (Point, LineString, Polygon, MultiLineString, or MultiPolygon). If provided, latitude/longitude will be updated to reflect this geometry."
},
"gps_device_capture": {
"$ref": "#/components/schemas/GpsDeviceCaptureRequest",
"nullable": true,
"description": "Flexible GPS device metadata captured with the record. Set null to clear metadata."
},
Comment thread
sjperaltas marked this conversation as resolved.
"form_values": {
"type": "object",
"description": "Field values keyed by field key",
Expand Down Expand Up @@ -13835,4 +13914,4 @@
"proxy-enabled": true
},
"x-readme-fauxas": true
}
}
Loading