{ "openapi": "3.1.0", "info": { "title": "Gradia Feedback reference block", "version": "0.2.1" }, "paths": { "/v1/feedback/session": { "get": { "summary": "Session", "operationId": "session_v1_feedback_session_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "if-gradia-principal", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{64}$" }, { "type": "null" } ], "title": "If-Gradia-Principal" } }, { "name": "if-gradia-configuration", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{64}$" }, { "type": "null" } ], "title": "If-Gradia-Configuration" } }, { "name": "if-gradia-block-version", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 40 }, { "type": "null" } ], "title": "If-Gradia-Block-Version" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/feedback/diagnostics/attempts": { "get": { "summary": "Attempt Diagnostics", "operationId": "attempt_diagnostics_v1_feedback_diagnostics_attempts_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "if-gradia-principal", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{64}$" }, { "type": "null" } ], "title": "If-Gradia-Principal" } }, { "name": "if-gradia-configuration", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{64}$" }, { "type": "null" } ], "title": "If-Gradia-Configuration" } }, { "name": "if-gradia-block-version", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 40 }, { "type": "null" } ], "title": "If-Gradia-Block-Version" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/feedback/config": { "get": { "summary": "Get Config", "operationId": "get_config_v1_feedback_config_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "if-gradia-principal", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{64}$" }, { "type": "null" } ], "title": "If-Gradia-Principal" } }, { "name": "if-gradia-configuration", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{64}$" }, { "type": "null" } ], "title": "If-Gradia-Configuration" } }, { "name": "if-gradia-block-version", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 40 }, { "type": "null" } ], "title": "If-Gradia-Block-Version" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/feedback": { "post": { "summary": "Submit", "operationId": "submit_v1_feedback_post", "parameters": [ { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128, "title": "Idempotency-Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "if-gradia-principal", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{64}$" }, { "type": "null" } ], "title": "If-Gradia-Principal" } }, { "name": "if-gradia-configuration", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{64}$" }, { "type": "null" } ], "title": "If-Gradia-Configuration" } }, { "name": "if-gradia-block-version", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 40 }, { "type": "null" } ], "title": "If-Gradia-Block-Version" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Submission" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Acknowledgment" } } } }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Acknowledgment" } } }, "description": "Created" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "summary": "Listing", "operationId": "listing_v1_feedback_get", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 25, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 36, "default": "", "title": "Cursor" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "if-gradia-principal", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{64}$" }, { "type": "null" } ], "title": "If-Gradia-Principal" } }, { "name": "if-gradia-configuration", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{64}$" }, { "type": "null" } ], "title": "If-Gradia-Configuration" } }, { "name": "if-gradia-block-version", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 40 }, { "type": "null" } ], "title": "If-Gradia-Block-Version" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeedbackPage" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/feedback/{identity}": { "get": { "summary": "Get One", "operationId": "get_one_v1_feedback__identity__get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "if-gradia-principal", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{64}$" }, { "type": "null" } ], "title": "If-Gradia-Principal" } }, { "name": "if-gradia-configuration", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{64}$" }, { "type": "null" } ], "title": "If-Gradia-Configuration" } }, { "name": "if-gradia-block-version", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 40 }, { "type": "null" } ], "title": "If-Gradia-Block-Version" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeedbackRecord" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "summary": "Triage", "operationId": "triage_v1_feedback__identity__patch", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "if-gradia-principal", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{64}$" }, { "type": "null" } ], "title": "If-Gradia-Principal" } }, { "name": "if-gradia-configuration", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{64}$" }, { "type": "null" } ], "title": "If-Gradia-Configuration" } }, { "name": "if-gradia-block-version", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 40 }, { "type": "null" } ], "title": "If-Gradia-Block-Version" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Triage" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TriageAcknowledgment" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/feedback/{identity}/events": { "get": { "summary": "Events", "operationId": "events_v1_feedback__identity__events_get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "After" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "if-gradia-principal", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{64}$" }, { "type": "null" } ], "title": "If-Gradia-Principal" } }, { "name": "if-gradia-configuration", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{64}$" }, { "type": "null" } ], "title": "If-Gradia-Configuration" } }, { "name": "if-gradia-block-version", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 40 }, { "type": "null" } ], "title": "If-Gradia-Block-Version" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/feedback/{identity}/attachments/{attachment_id}": { "get": { "summary": "Get Attachment", "operationId": "get_attachment_v1_feedback__identity__attachments__attachment_id__get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } }, { "name": "attachment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Attachment Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "if-gradia-principal", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{64}$" }, { "type": "null" } ], "title": "If-Gradia-Principal" } }, { "name": "if-gradia-configuration", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{64}$" }, { "type": "null" } ], "title": "If-Gradia-Configuration" } }, { "name": "if-gradia-block-version", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 40 }, { "type": "null" } ], "title": "If-Gradia-Block-Version" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/feedback/{identity}/audio": { "get": { "summary": "Get Audio", "operationId": "get_audio_v1_feedback__identity__audio_get", "parameters": [ { "name": "identity", "in": "path", "required": true, "schema": { "type": "string", "title": "Identity" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "if-gradia-principal", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{64}$" }, { "type": "null" } ], "title": "If-Gradia-Principal" } }, { "name": "if-gradia-configuration", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{64}$" }, { "type": "null" } ], "title": "If-Gradia-Configuration" } }, { "name": "if-gradia-block-version", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 40 }, { "type": "null" } ], "title": "If-Gradia-Block-Version" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } } }, "components": { "schemas": { "Acknowledgment": { "properties": { "status": { "type": "string", "const": "acknowledged", "title": "Status" }, "feedback": { "$ref": "#/components/schemas/FeedbackRecord" }, "replayed": { "type": "boolean", "title": "Replayed" } }, "additionalProperties": false, "type": "object", "required": [ "status", "feedback", "replayed" ], "title": "Acknowledgment" }, "Attachment": { "properties": { "kind": { "type": "string", "enum": [ "photo", "screenshot", "video" ], "title": "Kind" }, "mime_type": { "type": "string", "enum": [ "image/png", "image/jpeg", "image/webp", "video/webm", "video/mp4" ], "title": "Mime Type" }, "data_base64": { "type": "string", "maxLength": 22369624, "minLength": 1, "title": "Data Base64" } }, "additionalProperties": false, "type": "object", "required": [ "kind", "mime_type", "data_base64" ], "title": "Attachment" }, "AttachmentMetadata": { "properties": { "id": { "type": "string", "title": "Id" }, "kind": { "type": "string", "enum": [ "photo", "screenshot", "video" ], "title": "Kind" }, "mime_type": { "type": "string", "title": "Mime Type" }, "size_bytes": { "type": "integer", "title": "Size Bytes" }, "sha256": { "type": "string", "title": "Sha256" } }, "additionalProperties": false, "type": "object", "required": [ "id", "kind", "mime_type", "size_bytes", "sha256" ], "title": "AttachmentMetadata" }, "Audio": { "properties": { "mime_type": { "type": "string", "enum": [ "audio/webm", "audio/ogg", "audio/wav" ], "title": "Mime Type" }, "data_base64": { "type": "string", "maxLength": 349528, "minLength": 1, "title": "Data Base64" } }, "additionalProperties": false, "type": "object", "required": [ "mime_type", "data_base64" ], "title": "Audio" }, "AudioMetadata": { "properties": { "mime_type": { "type": "string", "enum": [ "audio/webm", "audio/ogg", "audio/wav" ], "title": "Mime Type" }, "size_bytes": { "type": "integer", "title": "Size Bytes" }, "sha256": { "type": "string", "title": "Sha256" } }, "additionalProperties": false, "type": "object", "required": [ "mime_type", "size_bytes", "sha256" ], "title": "AudioMetadata" }, "Context": { "properties": { "page_url": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ], "title": "Page Url" }, "app_id": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ], "title": "App Id" } }, "additionalProperties": false, "type": "object", "title": "Context" }, "FeedbackPage": { "properties": { "items": { "items": { "$ref": "#/components/schemas/FeedbackRecord" }, "type": "array", "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "additionalProperties": false, "type": "object", "required": [ "items", "next_cursor" ], "title": "FeedbackPage" }, "FeedbackRecord": { "properties": { "id": { "type": "string", "title": "Id" }, "revision": { "type": "integer", "title": "Revision" }, "status": { "type": "string", "enum": [ "new", "in_review", "resolved", "dismissed" ], "title": "Status" }, "category": { "type": "string", "title": "Category" }, "message": { "type": "string", "title": "Message" }, "assignee": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assignee" }, "context": { "$ref": "#/components/schemas/Context" }, "audio": { "anyOf": [ { "$ref": "#/components/schemas/AudioMetadata" }, { "type": "null" } ] }, "attachments": { "items": { "$ref": "#/components/schemas/AttachmentMetadata" }, "type": "array", "title": "Attachments" }, "created_at": { "type": "string", "title": "Created At" }, "updated_at": { "type": "string", "title": "Updated At" } }, "additionalProperties": false, "type": "object", "required": [ "id", "revision", "status", "category", "message", "assignee", "context", "audio", "created_at", "updated_at" ], "title": "FeedbackRecord" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "Submission": { "properties": { "message": { "type": "string", "maxLength": 10000, "minLength": 1, "title": "Message" }, "category": { "type": "string", "maxLength": 60, "minLength": 1, "title": "Category", "default": "general" }, "context": { "$ref": "#/components/schemas/Context" }, "audio": { "anyOf": [ { "$ref": "#/components/schemas/Audio" }, { "type": "null" } ] }, "attachments": { "items": { "$ref": "#/components/schemas/Attachment" }, "type": "array", "maxItems": 8, "title": "Attachments" } }, "additionalProperties": false, "type": "object", "required": [ "message" ], "title": "Submission" }, "Triage": { "properties": { "expected_revision": { "type": "integer", "minimum": 1.0, "title": "Expected Revision" }, "status": { "anyOf": [ { "type": "string", "enum": [ "new", "in_review", "resolved", "dismissed" ] }, { "type": "null" } ], "title": "Status" }, "category": { "anyOf": [ { "type": "string", "maxLength": 60, "minLength": 1 }, { "type": "null" } ], "title": "Category" }, "assignee": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ], "title": "Assignee" } }, "additionalProperties": false, "type": "object", "required": [ "expected_revision" ], "title": "Triage" }, "TriageAcknowledgment": { "properties": { "status": { "type": "string", "const": "acknowledged", "title": "Status" }, "feedback": { "$ref": "#/components/schemas/FeedbackRecord" } }, "additionalProperties": false, "type": "object", "required": [ "status", "feedback" ], "title": "TriageAcknowledgment" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" } } } }