Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/justfile
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
# Source of truth for the RPi camera plugin's OpenAPI schema (sister repo). Pinned to a
# release so the drift check only fails when the pin moves; Renovate bumps it.
r9cam_plugin_repo := "CMLPlatform/r9cam"
r9cam_plugin_version := "v0.7.2"
r9cam_plugin_version := "v0.8.1"
r9cam_schema_file := "openapi.r9cam.json"
r9cam_schema_url := "https://raw.githubusercontent.com/" + r9cam_plugin_repo + "/" + r9cam_plugin_version + "/" + r9cam_schema_file
r9cam_schema_path := "public/api/schemas/openapi.r9cam.json"
Expand Down
74 changes: 73 additions & 1 deletion docs/public/api/schemas/openapi.r9cam.json
Original file line number Diff line number Diff line change
Expand Up @@ -570,6 +570,15 @@
"title": "CaptureProvenance",
"type": "object"
},
"CaptureRole": {
"description": "What a capture is for within its session.",
"enum": [
"standard",
"colour_reference"
],
"title": "CaptureRole",
"type": "string"
},
"CaptureUploadMetadata": {
"additionalProperties": {
"anyOf": [
Expand Down Expand Up @@ -747,11 +756,42 @@
"capture_metadata": {
"$ref": "#/components/schemas/CaptureMetadata"
},
"capture_role": {
"$ref": "#/components/schemas/CaptureRole",
"default": "standard",
"description": "colour_reference marks the operator's colour-reference shot (for example a colour checker)"
},
"image_properties": {
"$ref": "#/components/schemas/ImageProperties"
},
"provenance": {
"$ref": "#/components/schemas/CaptureProvenance"
},
"raw_sha256": {
"anyOf": [
{
"pattern": "^[0-9a-f]{64}$",
"type": "string"
},
{
"type": "null"
}
],
"description": "SHA-256 of the DNG saved on the Pi from the same request. None when no raw file exists",
"title": "Raw Sha256"
},
"session_id": {
"anyOf": [
{
"pattern": "^[A-Za-z0-9_.-]{1,64}$",
"type": "string"
},
{
"type": "null"
}
],
"description": "Groups the captures of one session, so a dataset can pair them with the session's reference shot",
"title": "Session Id"
}
},
"required": [
Expand Down Expand Up @@ -1093,7 +1133,7 @@
"name": "Apache-2.0"
},
"title": "Raspberry Pi Camera API",
"version": "0.7.2"
"version": "0.8.1"
},
"openapi": "3.1.0",
"paths": {
Expand Down Expand Up @@ -1247,6 +1287,38 @@
"post": {
"description": "Capture a full-resolution image, push it to the backend, and return the result.",
"operationId": "capture_image_captures_post",
"parameters": [
{
"description": "`colour_reference` marks the session's colour-reference shot.",
"in": "query",
"name": "role",
"required": false,
"schema": {
"$ref": "#/components/schemas/CaptureRole",
"default": "standard",
"description": "`colour_reference` marks the session's colour-reference shot."
}
},
{
"description": "Sets the current session for this and later captures. Unset keeps the current session.",
"in": "query",
"name": "session_id",
"required": false,
"schema": {
"anyOf": [
{
"pattern": "^[A-Za-z0-9_.-]{1,64}$",
"type": "string"
},
{
"type": "null"
}
],
"description": "Sets the current session for this and later captures. Unset keeps the current session.",
"title": "Session Id"
}
}
],
"requestBody": {
"content": {
"application/json": {
Expand Down
Loading