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

Open
sjperaltas wants to merge 1 commit into
base: v2
Choose a base branch
from
Open

api: add gps device capture to records schema #75

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
123 changes: 122 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,9 @@
}
}
},
"gps_device_capture": {
"$ref": "#/components/schemas/GpsDeviceCapture"
},
Comment on lines +272 to +274
"speed": {
"type": "number",
"nullable": true,
Expand Down Expand Up @@ -458,6 +461,9 @@
"geometry": {
"$ref": "#/components/schemas/Geometry"
},
"gps_device_capture": {
"$ref": "#/components/schemas/GpsDeviceCapture"
},
Comment on lines +464 to +466
"speed": {
"type": "number",
"nullable": true
Expand Down Expand Up @@ -511,6 +517,113 @@
},
"description": "Location metadata captured at creation or update time."
},
"GpsDeviceCapture": {
"type": "object",
"description": "Flexible GPS device metadata captured with a record.",
"additionalProperties": true,
"properties": {
Comment on lines +520 to +524
"device_name": {
"type": "string",
Comment on lines +520 to +526
"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 used to compute geometry_matches_capture"
},
"geometry_matches_capture": {
"type": "boolean",
"readOnly": true,
"description": "Server-computed flag indicating whether the current record geometry matches gps_device_capture.geometry"
}
}
},
"GpsDeviceCaptureRequest": {
"type": "object",
"description": "Flexible GPS device metadata captured with a record.",
"additionalProperties": true,
"properties": {
"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 used to compute geometry_matches_capture"
}
}
},
"AttachmentCopyAllRequest": {
"type": "object",
"required": [
Expand Down Expand Up @@ -3798,6 +3911,10 @@
"$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",
"description": "Flexible GPS device metadata captured with the record."
},
"form_values": {
"type": "object",
"description": "Field values keyed by field key",
Expand Down Expand Up @@ -3843,6 +3960,10 @@
"$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",
"description": "Flexible GPS device metadata captured with the record."
},
"form_values": {
"type": "object",
"description": "Field values keyed by field key",
Expand Down Expand Up @@ -13835,4 +13956,4 @@
"proxy-enabled": true
},
"x-readme-fauxas": true
}
}