{ "openapi": "3.1.0", "info": { "title": "Platform API v1", "version": "v1", "description": "Platform public REST API v1 for survey participation, authoring, analytics, issues, teams, people, and reference data." }, "servers": [ { "url": "https:\/\/nanodepo.net\/api\/v1" } ], "tags": [ { "name": "status", "description": "Operational health endpoint for API availability checks." }, { "name": "guest surveys", "description": "Public survey participation flow available by survey token." }, { "name": "knowledge cards", "description": "Reference knowledge-base cards and taxonomy guidance." }, { "name": "issues", "description": "Organization diagnostic issues, ownership, comments, ideas, and reactions." }, { "name": "surveys", "description": "Survey authoring, publishing, milestones, categories, questions, and AI-assisted drafting." }, { "name": "analytics", "description": "Survey results, analytics, drilldowns, milestone comparisons, and exports." }, { "name": "templates", "description": "Reusable survey templates visible to the current organization." }, { "name": "teams", "description": "Organization teams, team membership, and team survey slices." }, { "name": "people", "description": "Organization members, roles, ownership, and membership removal." } ], "security": [ { "http": [] } ], "paths": { "\/guest-surveys\/{surveyToken}": { "get": { "operationId": "guestSurvey.show", "description": "Returns the current state needed to render and continue a public guest survey by token.", "summary": "Read guest survey state", "tags": [ "guest surveys" ], "parameters": [ { "name": "surveyToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "currentStep": { "type": "string" }, "resumeFromStep": { "type": "string" }, "answeredQuestionIds": { "type": "array", "items": {} }, "survey": { "type": "object", "properties": { "token": { "type": [ "string", "null" ] }, "id": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "questionsCount": { "type": "integer" }, "orgId": { "type": [ "string", "null" ] }, "orgName": { "type": [ "string", "null" ] }, "anonymityMode": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "requiresName": { "type": "boolean" }, "startHref": { "type": [ "string", "null" ] }, "apiHref": { "type": [ "string", "null" ] } }, "required": [ "token", "id", "title", "description", "questionsCount", "orgId", "orgName", "anonymityMode", "language", "requiresName", "startHref", "apiHref" ] }, "milestone": { "anyOf": [ { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "id", "value" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, { "type": "null" } ] }, "user": { "type": [ "string", "null" ] }, "question": { "anyOf": [ { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "keywords": { "type": "array", "items": {} }, "displayMode": { "type": "string" }, "answers": { "type": "array", "items": { "$ref": "#\/components\/schemas\/GuestAnswerOptionResource" } }, "selectedAnswerId": { "type": [ "string", "null" ] }, "comment": { "type": [ "string", "null" ] }, "followUp": { "type": [ "array", "null" ], "items": {} } }, "required": [ "id", "title", "keywords", "displayMode", "answers", "selectedAnswerId", "comment", "followUp" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, { "type": "null" } ] }, "teams": { "type": "array", "items": {} }, "completion": { "type": [ "object", "null" ], "properties": { "ready": { "type": "boolean" }, "hpScore": { "type": [ "string", "null" ] }, "categoryScores": { "type": "array", "items": {} }, "insights": { "type": "object", "properties": { "ready": { "type": "string" }, "answerCount": { "type": "integer", "minimum": 0 }, "analyzedAnswerCount": { "type": "integer", "minimum": 0 }, "responses": { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "responseId": { "type": "string" }, "questionId": { "type": "string" }, "categoryId": { "type": "string" }, "signalType": { "type": "string" }, "sentiment": { "type": "string" }, "driverTags": { "type": "array", "items": { "type": [ "string", "null" ] } }, "suggestion": { "type": [ "string", "null" ] } }, "required": [ "responseId", "questionId", "categoryId", "signalType", "sentiment", "driverTags", "suggestion" ] } }, "aggregates": { "type": "object", "properties": { "sentiment": { "type": "object", "properties": { "negative": { "type": "number" }, "neutral": { "type": "number" }, "positive": { "type": "number" }, "mixed": { "type": "number" } }, "required": [ "negative", "neutral", "positive", "mixed" ] }, "signals": { "type": "object", "properties": { "problem": { "type": "integer", "minimum": 0 }, "strength": { "type": "integer", "minimum": 0 }, "idea": { "type": "integer", "minimum": 0 }, "neutral": { "type": "integer", "minimum": 0 } }, "required": [ "problem", "strength", "idea", "neutral" ] }, "topDrivers": { "type": "array", "items": {} }, "scope": { "type": "string" }, "persistence": { "type": "string" } }, "required": [ "sentiment", "signals", "topDrivers", "scope", "persistence" ] }, "taxons": { "type": "string" } }, "required": [ "ready", "answerCount", "analyzedAnswerCount", "responses", "aggregates", "taxons" ] }, "personalSummary": { "type": [ "string", "null" ] }, "revealCta": { "type": "boolean" }, "reveal": { "type": "object", "properties": { "canReveal": { "type": "boolean" }, "requiresName": { "type": "boolean" }, "revealed": { "type": "boolean" }, "redirectHref": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] }, "sessionId": { "type": [ "string", "null" ] } }, "required": [ "canReveal", "requiresName", "revealed", "redirectHref", "reason", "sessionId" ] } }, "required": [ "ready", "hpScore", "categoryScores", "insights", "personalSummary", "revealCta", "reveal" ] }, "aiUsage": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "restricted": { "type": "boolean" }, "message": { "type": "string" } }, "required": [ "restricted", "message" ] } ] }, "availability": { "type": "object", "properties": { "available": { "type": "boolean" }, "code": { "type": [ "string", "null" ] }, "message": { "type": [ "string", "null" ] } }, "required": [ "available", "code", "message" ] } }, "required": [ "currentStep", "resumeFromStep", "answeredQuestionIds", "survey", "milestone", "user", "question", "teams", "completion", "aiUsage", "availability" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" } }, "security": [] } }, "\/guest-surveys\/{surveyToken}\/start": { "post": { "operationId": "guestSurvey.start", "description": "Starts or resumes the guest survey session and returns the updated survey state.", "summary": "Start guest survey", "tags": [ "guest surveys" ], "parameters": [ { "name": "surveyToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "name": { "type": [ "string", "null" ], "minLength": 2, "maxLength": 120 }, "code": { "type": [ "string", "null" ] }, "teamId": { "type": [ "string", "null" ] } }, "required": [ "email" ] } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "currentStep": { "type": "string" }, "resumeFromStep": { "type": "string" }, "answeredQuestionIds": { "type": "array", "items": {} }, "survey": { "type": "object", "properties": { "token": { "type": [ "string", "null" ] }, "id": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "questionsCount": { "type": "integer" }, "orgId": { "type": [ "string", "null" ] }, "orgName": { "type": [ "string", "null" ] }, "anonymityMode": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "requiresName": { "type": "boolean" }, "startHref": { "type": [ "string", "null" ] }, "apiHref": { "type": [ "string", "null" ] } }, "required": [ "token", "id", "title", "description", "questionsCount", "orgId", "orgName", "anonymityMode", "language", "requiresName", "startHref", "apiHref" ] }, "milestone": { "anyOf": [ { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "id", "value" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, { "type": "null" } ] }, "user": { "type": [ "string", "null" ] }, "question": { "anyOf": [ { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "keywords": { "type": "array", "items": {} }, "displayMode": { "type": "string" }, "answers": { "type": "array", "items": { "$ref": "#\/components\/schemas\/GuestAnswerOptionResource" } }, "selectedAnswerId": { "type": [ "string", "null" ] }, "comment": { "type": [ "string", "null" ] }, "followUp": { "type": [ "array", "null" ], "items": {} } }, "required": [ "id", "title", "keywords", "displayMode", "answers", "selectedAnswerId", "comment", "followUp" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, { "type": "null" } ] }, "teams": { "type": "array", "items": {} }, "completion": { "type": [ "object", "null" ], "properties": { "ready": { "type": "boolean" }, "hpScore": { "type": [ "string", "null" ] }, "categoryScores": { "type": "array", "items": {} }, "insights": { "type": "object", "properties": { "ready": { "type": "string" }, "answerCount": { "type": "integer", "minimum": 0 }, "analyzedAnswerCount": { "type": "integer", "minimum": 0 }, "responses": { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "responseId": { "type": "string" }, "questionId": { "type": "string" }, "categoryId": { "type": "string" }, "signalType": { "type": "string" }, "sentiment": { "type": "string" }, "driverTags": { "type": "array", "items": { "type": [ "string", "null" ] } }, "suggestion": { "type": [ "string", "null" ] } }, "required": [ "responseId", "questionId", "categoryId", "signalType", "sentiment", "driverTags", "suggestion" ] } }, "aggregates": { "type": "object", "properties": { "sentiment": { "type": "object", "properties": { "negative": { "type": "number" }, "neutral": { "type": "number" }, "positive": { "type": "number" }, "mixed": { "type": "number" } }, "required": [ "negative", "neutral", "positive", "mixed" ] }, "signals": { "type": "object", "properties": { "problem": { "type": "integer", "minimum": 0 }, "strength": { "type": "integer", "minimum": 0 }, "idea": { "type": "integer", "minimum": 0 }, "neutral": { "type": "integer", "minimum": 0 } }, "required": [ "problem", "strength", "idea", "neutral" ] }, "topDrivers": { "type": "array", "items": {} }, "scope": { "type": "string" }, "persistence": { "type": "string" } }, "required": [ "sentiment", "signals", "topDrivers", "scope", "persistence" ] }, "taxons": { "type": "string" } }, "required": [ "ready", "answerCount", "analyzedAnswerCount", "responses", "aggregates", "taxons" ] }, "personalSummary": { "type": [ "string", "null" ] }, "revealCta": { "type": "boolean" }, "reveal": { "type": "object", "properties": { "canReveal": { "type": "boolean" }, "requiresName": { "type": "boolean" }, "revealed": { "type": "boolean" }, "redirectHref": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] }, "sessionId": { "type": [ "string", "null" ] } }, "required": [ "canReveal", "requiresName", "revealed", "redirectHref", "reason", "sessionId" ] } }, "required": [ "ready", "hpScore", "categoryScores", "insights", "personalSummary", "revealCta", "reveal" ] }, "aiUsage": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "restricted": { "type": "boolean" }, "message": { "type": "string" } }, "required": [ "restricted", "message" ] } ] }, "availability": { "type": "object", "properties": { "available": { "type": "boolean" }, "code": { "type": [ "string", "null" ] }, "message": { "type": [ "string", "null" ] } }, "required": [ "available", "code", "message" ] } }, "required": [ "currentStep", "resumeFromStep", "answeredQuestionIds", "survey", "milestone", "user", "question", "teams", "completion", "aiUsage", "availability" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" }, "422": { "$ref": "#\/components\/responses\/ApiV1Error422" } }, "security": [] } }, "\/guest-surveys\/{surveyToken}\/answer": { "patch": { "operationId": "guestSurvey.answer", "description": "Stores one answer for the active guest survey session and returns the updated survey state.", "summary": "Save guest answer", "tags": [ "guest surveys" ], "parameters": [ { "name": "surveyToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SaveAnswerRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "currentStep": { "type": "string" }, "resumeFromStep": { "type": "string" }, "answeredQuestionIds": { "type": "array", "items": {} }, "survey": { "type": "object", "properties": { "token": { "type": [ "string", "null" ] }, "id": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "questionsCount": { "type": "integer" }, "orgId": { "type": [ "string", "null" ] }, "orgName": { "type": [ "string", "null" ] }, "anonymityMode": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "requiresName": { "type": "boolean" }, "startHref": { "type": [ "string", "null" ] }, "apiHref": { "type": [ "string", "null" ] } }, "required": [ "token", "id", "title", "description", "questionsCount", "orgId", "orgName", "anonymityMode", "language", "requiresName", "startHref", "apiHref" ] }, "milestone": { "anyOf": [ { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "id", "value" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, { "type": "null" } ] }, "user": { "type": [ "string", "null" ] }, "question": { "anyOf": [ { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "keywords": { "type": "array", "items": {} }, "displayMode": { "type": "string" }, "answers": { "type": "array", "items": { "$ref": "#\/components\/schemas\/GuestAnswerOptionResource" } }, "selectedAnswerId": { "type": [ "string", "null" ] }, "comment": { "type": [ "string", "null" ] }, "followUp": { "type": [ "array", "null" ], "items": {} } }, "required": [ "id", "title", "keywords", "displayMode", "answers", "selectedAnswerId", "comment", "followUp" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, { "type": "null" } ] }, "teams": { "type": "array", "items": {} }, "completion": { "type": [ "object", "null" ], "properties": { "ready": { "type": "boolean" }, "hpScore": { "type": [ "string", "null" ] }, "categoryScores": { "type": "array", "items": {} }, "insights": { "type": "object", "properties": { "ready": { "type": "string" }, "answerCount": { "type": "integer", "minimum": 0 }, "analyzedAnswerCount": { "type": "integer", "minimum": 0 }, "responses": { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "responseId": { "type": "string" }, "questionId": { "type": "string" }, "categoryId": { "type": "string" }, "signalType": { "type": "string" }, "sentiment": { "type": "string" }, "driverTags": { "type": "array", "items": { "type": [ "string", "null" ] } }, "suggestion": { "type": [ "string", "null" ] } }, "required": [ "responseId", "questionId", "categoryId", "signalType", "sentiment", "driverTags", "suggestion" ] } }, "aggregates": { "type": "object", "properties": { "sentiment": { "type": "object", "properties": { "negative": { "type": "number" }, "neutral": { "type": "number" }, "positive": { "type": "number" }, "mixed": { "type": "number" } }, "required": [ "negative", "neutral", "positive", "mixed" ] }, "signals": { "type": "object", "properties": { "problem": { "type": "integer", "minimum": 0 }, "strength": { "type": "integer", "minimum": 0 }, "idea": { "type": "integer", "minimum": 0 }, "neutral": { "type": "integer", "minimum": 0 } }, "required": [ "problem", "strength", "idea", "neutral" ] }, "topDrivers": { "type": "array", "items": {} }, "scope": { "type": "string" }, "persistence": { "type": "string" } }, "required": [ "sentiment", "signals", "topDrivers", "scope", "persistence" ] }, "taxons": { "type": "string" } }, "required": [ "ready", "answerCount", "analyzedAnswerCount", "responses", "aggregates", "taxons" ] }, "personalSummary": { "type": [ "string", "null" ] }, "revealCta": { "type": "boolean" }, "reveal": { "type": "object", "properties": { "canReveal": { "type": "boolean" }, "requiresName": { "type": "boolean" }, "revealed": { "type": "boolean" }, "redirectHref": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] }, "sessionId": { "type": [ "string", "null" ] } }, "required": [ "canReveal", "requiresName", "revealed", "redirectHref", "reason", "sessionId" ] } }, "required": [ "ready", "hpScore", "categoryScores", "insights", "personalSummary", "revealCta", "reveal" ] }, "aiUsage": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "restricted": { "type": "boolean" }, "message": { "type": "string" } }, "required": [ "restricted", "message" ] } ] }, "availability": { "type": "object", "properties": { "available": { "type": "boolean" }, "code": { "type": [ "string", "null" ] }, "message": { "type": [ "string", "null" ] } }, "required": [ "available", "code", "message" ] } }, "required": [ "currentStep", "resumeFromStep", "answeredQuestionIds", "survey", "milestone", "user", "question", "teams", "completion", "aiUsage", "availability" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" }, "422": { "$ref": "#\/components\/responses\/ApiV1Error422" } }, "security": [] } }, "\/guest-surveys\/{surveyToken}\/completion": { "get": { "operationId": "guestSurvey.completion", "description": "Returns completion progress and availability for final submission of the guest survey.", "summary": "Read guest completion state", "tags": [ "guest surveys" ], "parameters": [ { "name": "surveyToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "completion": { "type": "object", "properties": { "ready": { "type": "boolean" }, "hpScore": { "type": [ "string", "null" ] }, "categoryScores": { "type": "array", "items": {} }, "insights": { "type": "object", "properties": { "ready": { "type": "string" }, "answerCount": { "type": "integer", "minimum": 0 }, "analyzedAnswerCount": { "type": "integer", "minimum": 0 }, "responses": { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "responseId": { "type": "string" }, "questionId": { "type": "string" }, "categoryId": { "type": "string" }, "signalType": { "type": "string" }, "sentiment": { "type": "string" }, "driverTags": { "type": "array", "items": { "type": [ "string", "null" ] } }, "suggestion": { "type": [ "string", "null" ] } }, "required": [ "responseId", "questionId", "categoryId", "signalType", "sentiment", "driverTags", "suggestion" ] } }, "aggregates": { "type": "object", "properties": { "sentiment": { "type": "object", "properties": { "negative": { "type": "number" }, "neutral": { "type": "number" }, "positive": { "type": "number" }, "mixed": { "type": "number" } }, "required": [ "negative", "neutral", "positive", "mixed" ] }, "signals": { "type": "object", "properties": { "problem": { "type": "integer", "minimum": 0 }, "strength": { "type": "integer", "minimum": 0 }, "idea": { "type": "integer", "minimum": 0 }, "neutral": { "type": "integer", "minimum": 0 } }, "required": [ "problem", "strength", "idea", "neutral" ] }, "topDrivers": { "type": "array", "items": {} }, "scope": { "type": "string" }, "persistence": { "type": "string" } }, "required": [ "sentiment", "signals", "topDrivers", "scope", "persistence" ] }, "taxons": { "type": "string" } }, "required": [ "ready", "answerCount", "analyzedAnswerCount", "responses", "aggregates", "taxons" ] }, "personalSummary": { "type": [ "string", "null" ] }, "revealCta": { "type": "boolean" }, "reveal": { "type": "object", "properties": { "canReveal": { "type": "boolean" }, "requiresName": { "type": "boolean" }, "revealed": { "type": "boolean" }, "redirectHref": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] }, "sessionId": { "type": [ "string", "null" ] } }, "required": [ "canReveal", "requiresName", "revealed", "redirectHref", "reason", "sessionId" ] } }, "required": [ "ready", "hpScore", "categoryScores", "insights", "personalSummary", "revealCta", "reveal" ] } }, "required": [ "completion" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" } }, "security": [] } }, "\/guest-surveys\/{surveyToken}\/final": { "post": { "operationId": "guestSurvey.final", "description": "Stores the optional final comment and returns the guest survey completion payload.", "summary": "Submit guest final comment", "tags": [ "guest surveys" ], "parameters": [ { "name": "surveyToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SubmitFinalCommentRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "completion": { "type": "object", "properties": { "ready": { "type": "boolean" }, "hpScore": { "type": [ "string", "null" ] }, "categoryScores": { "type": "array", "items": {} }, "insights": { "type": "object", "properties": { "ready": { "type": "string" }, "answerCount": { "type": "integer", "minimum": 0 }, "analyzedAnswerCount": { "type": "integer", "minimum": 0 }, "responses": { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "responseId": { "type": "string" }, "questionId": { "type": "string" }, "categoryId": { "type": "string" }, "signalType": { "type": "string" }, "sentiment": { "type": "string" }, "driverTags": { "type": "array", "items": { "type": [ "string", "null" ] } }, "suggestion": { "type": [ "string", "null" ] } }, "required": [ "responseId", "questionId", "categoryId", "signalType", "sentiment", "driverTags", "suggestion" ] } }, "aggregates": { "type": "object", "properties": { "sentiment": { "type": "object", "properties": { "negative": { "type": "number" }, "neutral": { "type": "number" }, "positive": { "type": "number" }, "mixed": { "type": "number" } }, "required": [ "negative", "neutral", "positive", "mixed" ] }, "signals": { "type": "object", "properties": { "problem": { "type": "integer", "minimum": 0 }, "strength": { "type": "integer", "minimum": 0 }, "idea": { "type": "integer", "minimum": 0 }, "neutral": { "type": "integer", "minimum": 0 } }, "required": [ "problem", "strength", "idea", "neutral" ] }, "topDrivers": { "type": "array", "items": {} }, "scope": { "type": "string" }, "persistence": { "type": "string" } }, "required": [ "sentiment", "signals", "topDrivers", "scope", "persistence" ] }, "taxons": { "type": "string" } }, "required": [ "ready", "answerCount", "analyzedAnswerCount", "responses", "aggregates", "taxons" ] }, "personalSummary": { "type": [ "string", "null" ] }, "revealCta": { "type": "boolean" }, "reveal": { "type": "object", "properties": { "canReveal": { "type": "boolean" }, "requiresName": { "type": "boolean" }, "revealed": { "type": "boolean" }, "redirectHref": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] }, "sessionId": { "type": [ "string", "null" ] } }, "required": [ "canReveal", "requiresName", "revealed", "redirectHref", "reason", "sessionId" ] } }, "required": [ "ready", "hpScore", "categoryScores", "insights", "personalSummary", "revealCta", "reveal" ] } }, "required": [ "completion" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" }, "422": { "$ref": "#\/components\/responses\/ApiV1Error422" } }, "security": [] } }, "\/guest-surveys\/{surveyToken}\/reveal": { "post": { "operationId": "guestSurvey.reveal", "description": "Stores the guest identity reveal choice for the survey response and returns the updated reveal state.", "summary": "Reveal guest identity", "tags": [ "guest surveys" ], "parameters": [ { "name": "surveyToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/RevealIdentityRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "reveal": { "type": "object", "properties": { "canReveal": { "type": "boolean" }, "requiresName": { "type": "boolean" }, "revealed": { "type": "boolean" }, "redirectHref": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] }, "sessionId": { "type": [ "string", "null" ] } }, "required": [ "canReveal", "requiresName", "revealed", "redirectHref", "reason", "sessionId" ] }, "redirectHref": { "type": "string" } }, "required": [ "reveal", "redirectHref" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" }, "422": { "$ref": "#\/components\/responses\/ApiV1Error422" } }, "security": [] } }, "\/{org}\/issues": { "get": { "operationId": "issue.index", "description": "Returns organization diagnostic issues with optional status, priority, owner, survey, taxon, milestone, search, and limit filters.", "summary": "List issues", "tags": [ "issues" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Issue status filter. `all` or an empty value clears the filter.", "schema": { "type": "string", "enum": [ "open", "in_progress", "implemented" ] } }, { "name": "priority", "in": "query", "description": "Issue priority filter. `all` or an empty value clears the filter.", "schema": { "type": "string", "enum": [ "low", "medium", "high" ] } }, { "name": "q", "in": "query", "description": "Case-insensitive search by issue title or taxon title.", "schema": { "type": "string" } }, { "name": "owner", "in": "query", "description": "Owner filter: `me`, `unassigned`, or a user id. `all` or an empty value clears the filter.", "schema": { "type": "string" } }, { "name": "survey", "in": "query", "description": "Survey id filter. `all` or an empty value clears the filter.", "schema": { "type": "string" } }, { "name": "taxon", "in": "query", "description": "Taxon key filter. `all` or an empty value clears the filter.", "schema": { "type": "string" } }, { "name": "milestoneId", "in": "query", "description": "Milestone id filter. `all` or an empty value clears the filter.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Maximum number of issues to return; numeric values are clamped to 1..100.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "issues": { "type": "array", "items": { "$ref": "#\/components\/schemas\/IssueListItemResource" } }, "totalCount": { "type": "integer", "minimum": 0 }, "filters": { "type": "object", "properties": { "selected": { "type": "object", "properties": { "status": { "type": [ "string", "null" ] }, "priority": { "type": [ "string", "null" ] }, "q": { "type": [ "string", "null" ] }, "owner": { "type": [ "string", "null" ] }, "survey": { "type": [ "string", "null" ] }, "taxon": { "type": [ "string", "null" ] }, "milestoneId": { "type": [ "string", "null" ] } }, "required": [ "status", "priority", "q", "owner", "survey", "taxon", "milestoneId" ] }, "options": { "type": "object", "properties": { "statuses": { "type": "array", "items": { "$ref": "#\/components\/schemas\/IssueOptionResource" } }, "priorities": { "type": "array", "items": { "$ref": "#\/components\/schemas\/IssueOptionResource" } }, "owners": { "type": "array", "items": { "$ref": "#\/components\/schemas\/IssueOptionResource" } }, "surveys": { "type": "array", "items": { "$ref": "#\/components\/schemas\/IssueOptionResource" } } }, "required": [ "statuses", "priorities", "owners", "surveys" ] } }, "required": [ "selected", "options" ] }, "orgState": { "type": "object", "properties": { "hasSurveys": { "type": "boolean" }, "hasFinalizedMilestones": { "type": "boolean" } }, "required": [ "hasSurveys", "hasFinalizedMilestones" ] } }, "required": [ "issues", "totalCount", "filters", "orgState" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" } } } }, "\/{org}\/issues\/{issue}": { "get": { "operationId": "issue.show", "description": "Returns one diagnostic issue with evidence, comments, ideas, permissions, and available actions.", "summary": "Read issue", "tags": [ "issues" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "issue", "in": "path", "required": true, "description": "The issue ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "issue": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "evidenceSummary": { "anyOf": [ { "type": "object", "properties": { "passed": { "type": "boolean" }, "minRequired": { "type": "integer", "const": 5 }, "respondentsCount": { "type": "integer" }, "surveys": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] } } }, "required": [ "passed", "minRequired", "respondentsCount", "surveys" ] }, { "type": "object", "properties": { "passed": { "type": "boolean" }, "minRequired": { "type": "integer", "const": 5 }, "respondentsCount": { "type": "integer" }, "surveys": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "passed", "minRequired", "respondentsCount", "surveys" ] } ] }, "status": { "type": "string" }, "priority": { "type": "string" }, "taxon": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "null" } }, "required": [ "key", "name", "description" ] } ] }, "owner": { "type": "string" }, "surveys": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "createdAt": { "type": "string" }, "changeLog": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "hasFinalizedMilestones": { "type": "boolean" } }, "required": [ "id", "title", "description", "evidenceSummary", "status", "priority", "taxon", "owner", "surveys", "createdAt", "changeLog", "hasFinalizedMilestones" ] }, "ideas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/IssueIdeaResource" } }, "comments": { "type": "array", "items": { "$ref": "#\/components\/schemas\/IssueCommentResource" } }, "recommendations": { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "title": { "type": "string" }, "summary": { "type": "string" }, "reasoning": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "href": { "type": "string" } }, "required": [ "key", "title", "summary", "reasoning", "href" ] } }, "deepDiveRecommendations": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "permissions": { "type": "object", "properties": { "canComment": { "type": "boolean" }, "canAssignOwner": { "type": "boolean" }, "canTakeOwnership": { "type": "boolean" }, "canReleaseOwnership": { "type": "boolean" }, "canAddIdea": { "type": "boolean" }, "canReact": { "type": "boolean" }, "canChangeStatus": { "type": "boolean" }, "canChangePriority": { "type": "boolean" } }, "required": [ "canComment", "canAssignOwner", "canTakeOwnership", "canReleaseOwnership", "canAddIdea", "canReact", "canChangeStatus", "canChangePriority" ] }, "actionHrefs": { "type": "object", "properties": { "commentStore": { "type": "string" }, "commentDelete": { "type": "string" }, "ideaStore": { "type": "string" }, "ideaReact": { "type": "string" }, "assignOwner": { "type": "string" }, "takeOwnership": { "type": "string" }, "releaseOwnership": { "type": "string" }, "changeStatus": { "type": "string" }, "changePriority": { "type": "string" } }, "required": [ "commentStore", "commentDelete", "ideaStore", "ideaReact", "assignOwner", "takeOwnership", "releaseOwnership", "changeStatus", "changePriority" ] }, "assignableEmployees": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "avatar": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "avatar" ] } }, "statusOptions": { "type": "array", "items": { "$ref": "#\/components\/schemas\/IssueOptionResource" } }, "priorityOptions": { "type": "array", "items": { "$ref": "#\/components\/schemas\/IssueOptionResource" } }, "revealHref": { "type": [ "string", "null" ] } }, "required": [ "issue", "ideas", "comments", "recommendations", "deepDiveRecommendations", "permissions", "actionHrefs", "assignableEmployees", "statusOptions", "priorityOptions", "revealHref" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" } } } }, "\/{org}\/issues\/{issue}\/owner": { "patch": { "operationId": "issue.updateOwner", "description": "Assigns or clears the owner of a diagnostic issue.", "summary": "Update issue owner", "tags": [ "issues" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "issue", "in": "path", "required": true, "description": "The issue ID", "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UpdateIssueOwnerRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" }, "422": { "$ref": "#\/components\/responses\/ApiV1Error422" } } } }, "\/{org}\/issues\/{issue}\/take": { "post": { "operationId": "issue.take", "description": "Assigns the authenticated user as the owner of a diagnostic issue.", "summary": "Take issue", "tags": [ "issues" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "issue", "in": "path", "required": true, "description": "The issue ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" } } } }, "\/{org}\/issues\/{issue}\/release": { "post": { "operationId": "issue.release", "description": "Clears the authenticated user from the issue owner slot.", "summary": "Release issue", "tags": [ "issues" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "issue", "in": "path", "required": true, "description": "The issue ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" } } } }, "\/{org}\/issues\/{issue}\/status": { "patch": { "operationId": "issue.updateStatus", "description": "Changes the workflow status of a diagnostic issue.", "summary": "Update issue status", "tags": [ "issues" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "issue", "in": "path", "required": true, "description": "The issue ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ChangeIssueStatusRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" }, "422": { "$ref": "#\/components\/responses\/ApiV1Error422" } } } }, "\/{org}\/issues\/{issue}\/priority": { "patch": { "operationId": "issue.updatePriority", "description": "Changes the priority of a diagnostic issue.", "summary": "Update issue priority", "tags": [ "issues" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "issue", "in": "path", "required": true, "description": "The issue ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ChangeIssuePriorityRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" }, "422": { "$ref": "#\/components\/responses\/ApiV1Error422" } } } }, "\/{org}\/issues\/{issue}\/comments": { "post": { "operationId": "issue.storeComment", "description": "Adds a comment to a diagnostic issue.", "summary": "Create issue comment", "tags": [ "issues" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "issue", "in": "path", "required": true, "description": "The issue ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StoreIssueCommentRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" }, "422": { "$ref": "#\/components\/responses\/ApiV1Error422" } } } }, "\/{org}\/issues\/{issue}\/comments\/{comment}": { "delete": { "operationId": "issue.destroyComment", "description": "Deletes one comment from a diagnostic issue.", "summary": "Delete issue comment", "tags": [ "issues" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "issue", "in": "path", "required": true, "description": "The issue ID", "schema": { "type": "string" } }, { "name": "comment", "in": "path", "required": true, "description": "The comment ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" } } } }, "\/{org}\/issues\/{issue}\/ideas": { "post": { "operationId": "issue.storeIdea", "description": "Adds an improvement idea to a diagnostic issue.", "summary": "Create issue idea", "tags": [ "issues" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "issue", "in": "path", "required": true, "description": "The issue ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StoreIdeaRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" }, "422": { "$ref": "#\/components\/responses\/ApiV1Error422" } } } }, "\/{org}\/issues\/{issue}\/ideas\/{idea}\/react": { "post": { "operationId": "issue.reactToIdea", "description": "Stores the authenticated user reaction for one issue idea.", "summary": "React to issue idea", "tags": [ "issues" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "issue", "in": "path", "required": true, "description": "The issue ID", "schema": { "type": "string" } }, { "name": "idea", "in": "path", "required": true, "description": "The idea ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ReactToIdeaRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" }, "422": { "$ref": "#\/components\/responses\/ApiV1Error422" } } } }, "\/knowledge-cards": { "get": { "operationId": "reference.knowledgeCards", "description": "Returns public knowledge-base cards with optional taxonomy and applicability filters.", "summary": "List knowledge cards", "tags": [ "knowledge cards" ], "parameters": [ { "name": "taxon_key", "in": "query", "description": "Limits cards to a knowledge-base taxon key.", "schema": { "type": "string" } }, { "name": "applicability_level", "in": "query", "description": "Limits cards to an applicability level stored on the card.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "cards": { "type": "array", "items": { "$ref": "#\/components\/schemas\/KnowledgeCardCompactResource" } }, "taxon": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" } }, "required": [ "key", "title", "description" ] }, "filters": { "type": "string" } }, "required": [ "cards", "taxon", "filters" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } } }, "security": [] } }, "\/knowledge-cards\/{slug}": { "get": { "operationId": "reference.knowledgeCard", "description": "Returns one public knowledge-base card by slug.", "summary": "Read knowledge card", "tags": [ "knowledge cards" ], "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "card": { "type": "object", "properties": { "key": { "type": "string" }, "title": { "type": "string" }, "summary": { "type": "string" }, "what_is_it": { "type": "string" }, "when_it_helps": { "type": "array", "items": {} }, "how_to_start": { "type": "array", "items": {} }, "expected_benefit": { "type": "string" }, "common_pitfalls": { "type": "array", "items": {} }, "deeper_reading": { "type": "array", "items": {} }, "faq": { "type": "array", "items": { "$ref": "#\/components\/schemas\/FaqItemResource" } }, "applicability_levels": { "type": "array", "items": { "type": "string" } }, "related_card_keys": { "type": "array", "items": {} }, "taxons": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TaxonResource" } } }, "required": [ "key", "title", "summary", "what_is_it", "when_it_helps", "how_to_start", "expected_benefit", "common_pitfalls", "deeper_reading", "faq", "applicability_levels", "related_card_keys", "taxons" ] }, "relatedCards": { "type": "array", "items": { "$ref": "#\/components\/schemas\/KnowledgeCardCompactResource" } }, "canonicalHref": { "type": "string" } }, "required": [ "card", "relatedCards", "canonicalHref" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" } }, "security": [] } }, "\/{org}\/surveys\/{survey}\/report-artifacts": { "get": { "operationId": "reportArtifact.index", "tags": [ "ReportArtifact" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "survey", "in": "path", "required": true, "description": "The survey ID", "schema": { "type": "string" } }, { "name": "milestoneId", "in": "query", "schema": { "type": [ "string", "null" ] } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "artifacts": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ReportArtifactResource" } } }, "required": [ "artifacts" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" }, "422": { "$ref": "#\/components\/responses\/ApiV1Error422" } } }, "post": { "operationId": "reportArtifact.store", "tags": [ "ReportArtifact" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "survey", "in": "path", "required": true, "description": "The survey ID", "schema": { "type": "string" } } ], "responses": { "202": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "artifact": { "type": "object", "properties": { "id": { "type": "string" }, "parentId": { "type": [ "string", "null" ] }, "milestoneId": { "type": [ "string", "null" ] }, "revision": { "type": "integer" }, "title": { "type": [ "string", "null" ] }, "type": { "type": "string" }, "settings": { "type": "array", "items": {} }, "status": { "type": "string" }, "sections": { "type": "array", "items": {} }, "error": { "type": [ "string", "null" ], "const": "\u041e\u0442\u0447\u0451\u0442 \u043d\u0435 \u0441\u043e\u0431\u0440\u0430\u043d. \u041f\u0440\u043e\u0432\u0435\u0440\u044c\u0442\u0435 \u043d\u0430\u0441\u0442\u0440\u043e\u0439\u043a\u0438 \u0438 \u043f\u043e\u043f\u0440\u043e\u0431\u0443\u0439\u0442\u0435 \u0441\u0433\u0435\u043d\u0435\u0440\u0438\u0440\u043e\u0432\u0430\u0442\u044c \u0437\u0430\u043d\u043e\u0432\u043e." }, "downloadHref": { "type": [ "string", "null" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "parentId", "milestoneId", "revision", "title", "type", "settings", "status", "sections", "error", "downloadHref", "createdAt", "updatedAt" ] } }, "required": [ "artifact" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" }, "422": { "$ref": "#\/components\/responses\/ApiV1Error422" } } } }, "\/{org}\/surveys\/{survey}\/report-artifacts\/options": { "get": { "operationId": "reportArtifact.options", "tags": [ "ReportArtifact" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "survey", "in": "path", "required": true, "description": "The survey ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "types": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ArtifactTypeResource" } } }, "required": [ "types" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" } } } }, "\/{org}\/surveys\/{survey}\/report-artifacts\/{reportArtifact}\/download": { "get": { "operationId": "reportArtifact.download", "tags": [ "ReportArtifact" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "survey", "in": "path", "required": true, "description": "The survey ID", "schema": { "type": "string" } }, { "name": "reportArtifact", "in": "path", "required": true, "description": "The report artifact ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object" } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" } } } }, "\/{org}\/surveys\/{survey}\/analytics": { "get": { "operationId": "surveyAnalytics.show", "description": "Returns analytics filters, KPIs, categories, taxons, questions, and team leaderboard data for one survey.", "summary": "Read survey analytics", "tags": [ "analytics" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "survey", "in": "path", "required": true, "description": "The survey ID", "schema": { "type": "string" } }, { "name": "milestoneId", "in": "query", "schema": { "type": [ "string", "null" ] } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "survey": {}, "surveyTabs": {}, "currentMilestone": {}, "milestones": {}, "orgKpi": { "type": "object", "properties": { "score": {}, "delta": {}, "summary": {}, "history": {}, "completedCount": { "type": "integer" }, "respondentsCount": { "type": "integer" }, "conversion": { "type": "integer" }, "belowThresholdCategoriesCount": { "type": "integer" } }, "required": [ "score", "delta", "summary", "history", "completedCount", "respondentsCount", "conversion", "belowThresholdCategoriesCount" ] }, "categories": { "type": "array", "items": { "$ref": "#\/components\/schemas\/AnalyticsCategoryResource" } }, "taxons": { "type": "array", "items": { "$ref": "#\/components\/schemas\/AnalyticsTaxonResource" } }, "subjectOverview": {}, "teams": { "type": "object", "properties": { "top": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TeamLeaderboardEntryResource" } }, "bottom": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TeamLeaderboardEntryResource" } } }, "required": [ "top", "bottom" ] }, "actionHrefs": {}, "filters": { "type": "object", "additionalProperties": {} }, "viewState": {}, "pipeline": {} }, "required": [ "survey", "surveyTabs", "currentMilestone", "milestones", "orgKpi", "categories", "taxons", "subjectOverview", "teams", "actionHrefs", "filters", "viewState", "pipeline" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" }, "": { "type": "string" } }, "required": [ "path", null ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" }, "422": { "$ref": "#\/components\/responses\/ApiV1Error422" } } } }, "\/{org}\/surveys\/{survey}\/analytics\/questions": { "get": { "operationId": "surveyAnalytics.questions", "description": "Returns paginated question analytics rows for one survey.", "summary": "List survey analytics questions", "tags": [ "analytics" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "survey", "in": "path", "required": true, "description": "The survey ID", "schema": { "type": "string" } }, { "name": "q", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 100 } }, { "name": "categoryId", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 64 } }, { "name": "sort", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "score-asc", "score-desc", "answers-desc" ] } }, { "name": "page", "in": "query", "description": "Page number for the in-memory questions list pagination.", "schema": { "type": "integer", "default": 1 } }, { "name": "perPage", "in": "query", "description": "Items per page for the questions list; values are clamped to 1..100.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "survey": {}, "surveyTabs": {}, "currentMilestone": {}, "categories": {}, "questions": { "type": "array", "items": {} }, "filters": {}, "canManageQuestions": { "type": "boolean" }, "editorHref": {} }, "required": [ "survey", "surveyTabs", "currentMilestone", "categories", "questions", "filters", "canManageQuestions", "editorHref" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" }, "pagination": { "type": "object", "properties": { "currentPage": { "type": [ "object", "null" ] }, "perPage": { "type": [ "object", "null" ] }, "total": { "type": "integer" }, "lastPage": { "type": [ "object", "null" ] } }, "required": [ "currentPage", "perPage", "total", "lastPage" ] } }, "required": [ "path", "pagination" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" }, "422": { "$ref": "#\/components\/responses\/ApiV1Error422" } } } }, "\/{org}\/surveys\/{survey}\/analytics\/questions\/{question}": { "get": { "operationId": "surveyAnalytics.question", "description": "Returns overview, segments, or answers for one survey question.", "summary": "Read survey question analytics", "tags": [ "analytics" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "survey", "in": "path", "required": true, "description": "The survey ID", "schema": { "type": "string" } }, { "name": "question", "in": "path", "required": true, "description": "The question ID", "schema": { "type": "string" } }, { "name": "tab", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "overview", "segments", "summary", "analytics", "report" ] } }, { "name": "milestoneId", "in": "query", "schema": { "type": [ "string", "null" ] } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "survey": {}, "milestone": {}, "milestones": {}, "question": {}, "distribution": { "type": [ "array", "null" ], "items": { "$ref": "#\/components\/schemas\/QuestionDistributionBucketResource" } }, "summary": {}, "segments": {}, "defaultTab": { "type": "string" }, "thresholds": {}, "questionsListHref": { "type": "string" }, "surveyTabs": {}, "responseInsights": {} }, "required": [ "survey", "milestone", "milestones", "question", "distribution", "summary", "segments", "defaultTab", "thresholds", "questionsListHref", "surveyTabs", "responseInsights" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" }, "": { "type": "string" } }, "required": [ "path", null ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" }, "422": { "$ref": "#\/components\/responses\/ApiV1Error422" } } } }, "\/{org}\/surveys\/{survey}\/analytics\/milestones\/compare": { "get": { "operationId": "surveyAnalytics.compareMilestones", "description": "Returns a comparison payload for two survey milestones.", "summary": "Compare survey milestones", "tags": [ "analytics" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "survey", "in": "path", "required": true, "description": "The survey ID", "schema": { "type": "string" } }, { "name": "baseMilestoneId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "targetMilestoneId", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "summary": { "type": "string" }, "comparison": {}, "meta": {} }, "required": [ "summary", "comparison", "meta" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" }, "": { "type": "string" } }, "required": [ "path", null ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" }, "422": { "$ref": "#\/components\/responses\/ApiV1Error422" } } } }, "\/{org}\/surveys\/{survey}\/assistant\/messages": { "get": { "operationId": "surveyAssistant.index", "tags": [ "SurveyAssistant" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "survey", "in": "path", "required": true, "description": "The survey ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "messages": { "type": "object", "additionalProperties": { "type": "object", "properties": { "role": { "type": "string" }, "content": { "type": "string" }, "createdAt": { "type": "string" } }, "required": [ "role", "content", "createdAt" ] } } }, "required": [ "messages" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" } } }, "post": { "operationId": "surveyAssistant.store", "tags": [ "SurveyAssistant" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "survey", "in": "path", "required": true, "description": "The survey ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "maxLength": 5000 } }, "required": [ "message" ] } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "message": { "type": "object", "properties": { "role": { "type": "string" }, "content": { "type": "string" }, "createdAt": { "type": "string" } }, "required": [ "role", "content", "createdAt" ] } }, "required": [ "message" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "503": { "description": "An error", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "" } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" }, "422": { "$ref": "#\/components\/responses\/ApiV1Error422" } } } }, "\/{org}\/surveys": { "get": { "operationId": "surveyAuthoring.index", "description": "Returns organization surveys with optional search and status filters.", "summary": "List surveys", "tags": [ "surveys" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "q", "in": "query", "description": "Search by survey title or description. `all` or an empty value clears the filter.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Survey status filter. `all` or an empty value clears the filter.", "schema": { "type": "string", "enum": [ "draft", "active", "finalizing", "completed" ] } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "surveys": { "type": "array", "items": { "$ref": "#\/components\/schemas\/SurveyResource" } }, "hasSurveys": { "type": "boolean" }, "filters": { "type": "object", "properties": { "selected": { "type": "object", "properties": { "q": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] } }, "required": [ "q", "status" ] }, "options": { "type": "object", "properties": { "statuses": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "value": { "type": "string", "const": "draft" }, "label": { "type": "string" } }, "required": [ "value", "label" ] }, { "type": "object", "properties": { "value": { "type": "string", "const": "active" }, "label": { "type": "string" } }, "required": [ "value", "label" ] }, { "type": "object", "properties": { "value": { "type": "string", "const": "finalizing" }, "label": { "type": "string" } }, "required": [ "value", "label" ] }, { "type": "object", "properties": { "value": { "type": "string", "const": "completed" }, "label": { "type": "string" } }, "required": [ "value", "label" ] } ], "minItems": 4, "maxItems": 4, "additionalItems": false } }, "required": [ "statuses" ] } }, "required": [ "selected", "options" ] }, "permissions": { "type": "array", "items": {} } }, "required": [ "surveys", "hasSurveys", "filters", "permissions" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" } } }, "post": { "operationId": "surveyAuthoring.store", "description": "Creates a blank organization survey and returns its survey payload.", "summary": "Create survey", "tags": [ "surveys" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CreateSurveyRequest" } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "survey": { "type": "array", "items": {} } }, "required": [ "survey" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" }, "422": { "$ref": "#\/components\/responses\/ApiV1Error422" } } } }, "\/{org}\/surveys\/ai-create\/outline": { "post": { "operationId": "surveyAuthoring.aiOutline", "description": "Starts AI-assisted outline generation for a survey brief and returns the generation run payload.", "summary": "Draft AI survey outline", "tags": [ "surveys" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AiSurveyBriefRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "outline": { "type": "object", "additionalProperties": {} } }, "required": [ "outline" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" }, "422": { "$ref": "#\/components\/responses\/ApiV1Error422" } } } }, "\/{org}\/surveys\/ai-create\/confirm": { "post": { "operationId": "surveyAuthoring.aiConfirm", "description": "Creates a survey from a confirmed AI outline and returns the created survey payload.", "summary": "Confirm AI survey creation", "tags": [ "surveys" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ConfirmAiSurveyCreationRequest" } } } }, "responses": { "202": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "runId": { "type": "string" }, "progress": { "type": "object", "properties": { "state": { "type": "string" }, "brief": { "type": [ "string", "null" ] }, "outline": { "type": [ "string", "null" ] }, "progress": { "type": [ "string", "null" ] }, "aiUsage": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] } }, "required": [ "state", "brief", "outline", "progress", "aiUsage" ] } }, "required": [ "runId", "progress" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" }, "422": { "$ref": "#\/components\/responses\/ApiV1Error422" } } } }, "\/{org}\/surveys\/ai-generation\/{run}": { "get": { "operationId": "surveyAuthoring.aiProgress", "description": "Returns the current progress payload for an AI survey generation run.", "summary": "Read AI survey generation progress", "tags": [ "surveys" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "run", "in": "path", "required": true, "description": "The run ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "state": { "type": "string" }, "brief": { "type": [ "string", "null" ] }, "outline": { "type": [ "string", "null" ] }, "progress": { "type": [ "string", "null" ] }, "aiUsage": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] } }, "required": [ "state", "brief", "outline", "progress", "aiUsage" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" } } } }, "\/{org}\/templates": { "get": { "operationId": "surveyAuthoring.templates", "description": "Returns survey templates visible to the organization.", "summary": "List survey templates", "tags": [ "templates" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "templates": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TemplateResource" } }, "permissions": { "type": "array", "items": {} } }, "required": [ "templates", "permissions" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" } } } }, "\/{org}\/templates\/{template}": { "get": { "operationId": "surveyAuthoring.template", "description": "Returns one survey template with its categories, questions, and taxons.", "summary": "Read survey template", "tags": [ "templates" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "template", "in": "path", "required": true, "description": "The template ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "template": { "type": "array", "items": {} }, "permissions": { "type": "array", "items": {} } }, "required": [ "template", "permissions" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" } } } }, "\/{org}\/surveys\/{survey}": { "get": { "operationId": "surveyAuthoring.show", "description": "Returns survey authoring details for one organization survey.", "summary": "Read survey", "tags": [ "surveys" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "survey", "in": "path", "required": true, "description": "The survey ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "survey": { "type": "array", "items": {} }, "lifecycle": { "type": "object", "properties": { "state": { "type": "string" }, "label": { "type": "string" }, "description": { "type": "string" }, "primaryAction": { "type": [ "string", "null" ], "enum": [ "configure", "share", "review", null ] }, "intermediateReportAvailable": { "type": "string" }, "finalReportAvailable": { "type": "string" }, "pipeline": { "type": [ "object", "null" ], "properties": { "state": { "type": "string" }, "stage": { "type": "string" }, "humanStage": { "type": "string" }, "completedSteps": { "type": [ "object", "null" ] }, "totalSteps": { "type": "integer", "enum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9 ] }, "errors": { "anyOf": [ { "type": "array", "prefixItems": [ { "type": "string" } ], "minItems": 1, "maxItems": 1, "additionalItems": false }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "canRestart": { "type": "boolean" }, "startedAt": { "type": "string" } }, "required": [ "state", "stage", "humanStage", "completedSteps", "totalSteps", "errors", "canRestart", "startedAt" ] } }, "required": [ "state", "label", "description", "primaryAction", "intermediateReportAvailable", "finalReportAvailable", "pipeline" ] }, "milestones": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MilestoneSummaryResource" } }, "currentMilestone": { "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "value": { "type": "integer" }, "status": { "type": "string" }, "startedCount": { "type": "integer" }, "completedCount": { "type": "integer" }, "startedAt": { "type": [ "string", "null" ] }, "closedAt": { "type": [ "string", "null" ] }, "hasReport": { "type": "boolean" } }, "required": [ "id", "value", "status", "startedCount", "completedCount", "startedAt", "closedAt", "hasReport" ] }, "pipeline": { "type": [ "object", "null" ], "properties": { "state": { "type": "string" }, "stage": { "type": "string" }, "humanStage": { "type": "string" }, "completedSteps": { "type": [ "object", "null" ] }, "totalSteps": { "type": "integer", "enum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9 ] }, "errors": { "anyOf": [ { "type": "array", "prefixItems": [ { "type": "string" } ], "minItems": 1, "maxItems": 1, "additionalItems": false }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "canRestart": { "type": "boolean" }, "startedAt": { "type": "string" } }, "required": [ "state", "stage", "humanStage", "completedSteps", "totalSteps", "errors", "canRestart", "startedAt" ] }, "permissions": { "type": "array", "items": {} } }, "required": [ "survey", "lifecycle", "milestones", "currentMilestone", "pipeline", "permissions" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" } } }, "patch": { "operationId": "surveyAuthoring.update", "description": "Updates survey metadata and returns the refreshed survey payload.", "summary": "Update survey", "tags": [ "surveys" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "survey", "in": "path", "required": true, "description": "The survey ID", "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UpdateSurveyRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "survey": { "type": "array", "items": {} } }, "required": [ "survey" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" }, "422": { "$ref": "#\/components\/responses\/ApiV1Error422" } } }, "delete": { "operationId": "surveyAuthoring.destroy", "description": "Deletes one survey and returns an acknowledgement envelope.", "summary": "Delete survey", "tags": [ "surveys" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "survey", "in": "path", "required": true, "description": "The survey ID", "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string", "maxLength": 120 } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" }, "422": { "$ref": "#\/components\/responses\/ApiV1Error422" } } } }, "\/{org}\/surveys\/{survey}\/publish": { "post": { "operationId": "surveyAuthoring.publish", "description": "Publishes a survey and returns the refreshed survey payload.", "summary": "Publish survey", "tags": [ "surveys" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "survey", "in": "path", "required": true, "description": "The survey ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "survey": { "type": "array", "items": {} } }, "required": [ "survey" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" } } } }, "\/{org}\/surveys\/{survey}\/milestones": { "post": { "operationId": "surveyAuthoring.storeMilestone", "description": "Creates a survey milestone and returns the refreshed survey payload.", "summary": "Create survey milestone", "tags": [ "surveys" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "survey", "in": "path", "required": true, "description": "The survey ID", "schema": { "type": "string" } } ], "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "milestone": { "type": "object", "properties": { "id": { "type": "string" }, "value": { "type": "integer" }, "status": { "type": "string" }, "startedCount": { "type": "integer" }, "completedCount": { "type": "integer" }, "startedAt": { "type": [ "string", "null" ] }, "closedAt": { "type": [ "string", "null" ] }, "hasReport": { "type": "boolean" } }, "required": [ "id", "value", "status", "startedCount", "completedCount", "startedAt", "closedAt", "hasReport" ] } }, "required": [ "milestone" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" } } } }, "\/{org}\/surveys\/{survey}\/milestones\/{milestone}\/close": { "post": { "operationId": "surveyAuthoring.closeMilestone", "description": "Closes one survey milestone and returns the updated milestone payload.", "summary": "Close survey milestone", "tags": [ "surveys" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "survey", "in": "path", "required": true, "description": "The survey ID", "schema": { "type": "string" } }, { "name": "milestone", "in": "path", "required": true, "description": "The milestone ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "ok": { "type": "boolean" }, "milestoneId": { "type": "string" }, "surveyId": { "type": "string" } }, "required": [ "ok", "milestoneId", "surveyId" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" } } } }, "\/{org}\/milestones\/{milestone}\/summarize": { "post": { "operationId": "surveyAuthoring.summarizeMilestone", "description": "Starts summary generation for a milestone and returns the updated milestone payload.", "summary": "Summarize milestone", "tags": [ "surveys" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "milestone", "in": "path", "required": true, "description": "The milestone ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "ok": { "type": "boolean" }, "milestoneId": { "type": "string" }, "surveyId": { "type": "string" } }, "required": [ "ok", "milestoneId", "surveyId" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" } } } }, "\/{org}\/milestones\/{milestone}\/restart-pipeline": { "post": { "operationId": "surveyAuthoring.restartPipeline", "description": "Restarts the diagnostic pipeline for a milestone and returns an acknowledgement envelope.", "summary": "Restart milestone pipeline", "tags": [ "surveys" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "milestone", "in": "path", "required": true, "description": "The milestone ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" } } } }, "\/{org}\/surveys\/{survey}\/categories": { "post": { "operationId": "surveyAuthoring.storeCategory", "description": "Creates a survey category and returns the created category payload.", "summary": "Create survey category", "tags": [ "surveys" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "survey", "in": "path", "required": true, "description": "The survey ID", "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "name": { "type": [ "string", "null" ], "maxLength": 120 }, "instruction": { "type": [ "string", "null" ], "maxLength": 2000 } } } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "category": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "instruction": { "type": [ "string", "null" ] }, "sortOrder": { "type": "integer" }, "questions": { "type": "array", "items": { "$ref": "#\/components\/schemas\/QuestionResource" } } }, "required": [ "id", "name", "instruction", "sortOrder", "questions" ] } }, "required": [ "category" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" }, "422": { "$ref": "#\/components\/responses\/ApiV1Error422" } } } }, "\/{org}\/surveys\/{survey}\/categories\/{category}": { "patch": { "operationId": "surveyAuthoring.updateCategory", "description": "Updates a survey category and returns the refreshed category payload.", "summary": "Update survey category", "tags": [ "surveys" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "survey", "in": "path", "required": true, "description": "The survey ID", "schema": { "type": "string" } }, { "name": "category", "in": "path", "required": true, "description": "The category ID", "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 120 }, "instruction": { "type": [ "string", "null" ], "maxLength": 2000 } } } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "category": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "instruction": { "type": [ "string", "null" ] }, "sortOrder": { "type": "integer" }, "questions": { "type": "array", "items": { "$ref": "#\/components\/schemas\/QuestionResource" } } }, "required": [ "id", "name", "instruction", "sortOrder", "questions" ] } }, "required": [ "category" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" }, "422": { "$ref": "#\/components\/responses\/ApiV1Error422" } } }, "delete": { "operationId": "surveyAuthoring.destroyCategory", "description": "Deletes a survey category and returns an acknowledgement envelope.", "summary": "Delete survey category", "tags": [ "surveys" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "survey", "in": "path", "required": true, "description": "The survey ID", "schema": { "type": "string" } }, { "name": "category", "in": "path", "required": true, "description": "The category ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" } } } }, "\/{org}\/surveys\/{survey}\/categories\/reorder": { "post": { "operationId": "surveyAuthoring.reorderCategories", "description": "Persists survey category order and returns the ordered category identifiers.", "summary": "Reorder survey categories", "tags": [ "surveys" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "survey", "in": "path", "required": true, "description": "The survey ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" }, "minItems": 1 } }, "required": [ "ids" ] } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "ids": { "type": "array", "items": {} } }, "required": [ "ids" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" }, "422": { "$ref": "#\/components\/responses\/ApiV1Error422" } } } }, "\/{org}\/surveys\/{survey}\/categories\/{category}\/questions": { "post": { "operationId": "surveyAuthoring.storeQuestion", "description": "Creates a question inside a survey category and returns the created question payload.", "summary": "Create survey question", "tags": [ "surveys" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "survey", "in": "path", "required": true, "description": "The survey ID", "schema": { "type": "string" } }, { "name": "category", "in": "path", "required": true, "description": "The category ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UpsertQuestionRequest" } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "question": { "type": "object", "properties": { "id": { "type": "string" }, "text": { "type": "string" }, "intent": { "type": "string" }, "keywords": { "type": "array", "items": {} }, "displayMode": { "type": "string" }, "isInverted": { "type": "boolean" }, "sortOrder": { "type": "integer" }, "answers": { "type": "array", "items": { "$ref": "#\/components\/schemas\/AnswerResource" } } }, "required": [ "id", "text", "intent", "keywords", "displayMode", "isInverted", "sortOrder", "answers" ] } }, "required": [ "question" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" }, "422": { "$ref": "#\/components\/responses\/ApiV1Error422" } } } }, "\/{org}\/surveys\/{survey}\/questions\/{question}": { "patch": { "operationId": "surveyAuthoring.updateQuestion", "description": "Updates a survey question and returns the refreshed question payload.", "summary": "Update survey question", "tags": [ "surveys" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "survey", "in": "path", "required": true, "description": "The survey ID", "schema": { "type": "string" } }, { "name": "question", "in": "path", "required": true, "description": "The question ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UpsertQuestionRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "question": { "type": "object", "properties": { "id": { "type": "string" }, "text": { "type": "string" }, "intent": { "type": "string" }, "keywords": { "type": "array", "items": {} }, "displayMode": { "type": "string" }, "isInverted": { "type": "boolean" }, "sortOrder": { "type": "integer" }, "answers": { "type": "array", "items": { "$ref": "#\/components\/schemas\/AnswerResource" } } }, "required": [ "id", "text", "intent", "keywords", "displayMode", "isInverted", "sortOrder", "answers" ] } }, "required": [ "question" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" }, "422": { "$ref": "#\/components\/responses\/ApiV1Error422" } } }, "delete": { "operationId": "surveyAuthoring.destroyQuestion", "description": "Deletes a survey question and returns an acknowledgement envelope.", "summary": "Delete survey question", "tags": [ "surveys" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "survey", "in": "path", "required": true, "description": "The survey ID", "schema": { "type": "string" } }, { "name": "question", "in": "path", "required": true, "description": "The question ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" } } } }, "\/{org}\/surveys\/{survey}\/categories\/{category}\/questions\/reorder": { "post": { "operationId": "surveyAuthoring.reorderQuestions", "description": "Persists question order inside a survey category and returns the ordered question identifiers.", "summary": "Reorder survey questions", "tags": [ "surveys" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "survey", "in": "path", "required": true, "description": "The survey ID", "schema": { "type": "string" } }, { "name": "category", "in": "path", "required": true, "description": "The category ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ReorderRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "ids": { "type": "array", "items": {} } }, "required": [ "ids" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" }, "422": { "$ref": "#\/components\/responses\/ApiV1Error422" } } } }, "\/{org}\/surveys\/{survey}\/categories\/{category}\/draft-question": { "post": { "operationId": "surveyAuthoring.draftQuestion", "description": "Generates a draft question for a survey category and returns the draft payload.", "summary": "Draft survey question with AI", "tags": [ "surveys" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "survey", "in": "path", "required": true, "description": "The survey ID", "schema": { "type": "string" } }, { "name": "category", "in": "path", "required": true, "description": "The category ID", "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/DraftQuestionRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "draft": { "type": "object", "additionalProperties": {} } }, "required": [ "draft" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" }, "422": { "$ref": "#\/components\/responses\/ApiV1Error422" } } } }, "\/{org}\/surveys\/{survey}\/analytics\/export.json": { "get": { "operationId": "v1.surveys.analytics.export-json", "description": "Downloads the survey analytics export as JSON.", "summary": "Export survey analytics JSON", "tags": [ "analytics" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "survey", "in": "path", "required": true, "description": "The survey ID", "schema": { "type": "string" } }, { "name": "milestoneId", "in": "query", "schema": { "type": [ "string", "null" ] } } ], "responses": { "200": { "description": "", "content": { "application\/json; charset=UTF-8": { "schema": { "anyOf": [ { "type": "string" }, { "type": "object" } ] } } }, "headers": { "Content-Disposition": { "schema": { "type": "string" } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" }, "422": { "$ref": "#\/components\/responses\/ApiV1Error422" } } } }, "\/{org}\/surveys\/{survey}\/result": { "get": { "operationId": "surveyResult.show", "description": "Returns the aggregate result payload for one organization survey.", "summary": "Read survey result", "tags": [ "analytics" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "survey", "in": "path", "required": true, "description": "The survey ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "survey": {}, "milestone": {}, "completedAt": {}, "analysis": {}, "insights": { "type": "object", "properties": { "ready": { "type": "string" }, "answerCount": { "type": "integer", "minimum": 0 }, "analyzedAnswerCount": { "type": "integer", "minimum": 0 }, "responses": { "type": "array", "items": { "type": [ "object", "null" ], "properties": { "responseId": { "type": "string" }, "questionId": { "type": "string" }, "categoryId": { "type": "string" }, "signalType": { "type": "string" }, "sentiment": { "type": "string" }, "driverTags": { "type": "array", "items": { "type": [ "string", "null" ] } }, "suggestion": { "type": [ "string", "null" ] } }, "required": [ "responseId", "questionId", "categoryId", "signalType", "sentiment", "driverTags", "suggestion" ] } }, "aggregates": { "type": "object", "properties": { "sentiment": { "type": "object", "properties": { "negative": { "type": "number" }, "neutral": { "type": "number" }, "positive": { "type": "number" }, "mixed": { "type": "number" } }, "required": [ "negative", "neutral", "positive", "mixed" ] }, "signals": { "type": "object", "properties": { "problem": { "type": "integer", "minimum": 0 }, "strength": { "type": "integer", "minimum": 0 }, "idea": { "type": "integer", "minimum": 0 }, "neutral": { "type": "integer", "minimum": 0 } }, "required": [ "problem", "strength", "idea", "neutral" ] }, "topDrivers": { "type": "array", "items": {} }, "scope": { "type": "string" }, "persistence": { "type": "string" } }, "required": [ "sentiment", "signals", "topDrivers", "scope", "persistence" ] }, "taxons": { "type": "string" } }, "required": [ "ready", "answerCount", "analyzedAnswerCount", "responses", "aggregates", "taxons" ] }, "mirror": {}, "personalSummary": {}, "categoryScores": {}, "hasCompleted": {}, "surveyLink": {} }, "required": [ "survey", "milestone", "completedAt", "analysis", "insights", "mirror", "personalSummary", "categoryScores", "hasCompleted", "surveyLink" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" } } } }, "\/payments\/{payment}": { "get": { "operationId": "workspace.paymentStatus", "tags": [ "Workspace" ], "parameters": [ { "name": "payment", "in": "path", "required": true, "description": "The payment ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "amountCents": { "type": "integer" }, "orgId": { "type": [ "string", "null" ] } }, "required": [ "id", "status", "amountCents", "orgId" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" } } } }, "\/{org}\/teams": { "get": { "operationId": "workspace.teams", "description": "Returns the organization team list for the authenticated bearer token.", "summary": "List teams", "tags": [ "teams" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "teams": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TeamResource" } }, "anonymousCount": { "type": "integer" }, "permissions": { "type": "object", "properties": { "canCreate": { "type": "boolean" } }, "required": [ "canCreate" ] } }, "required": [ "teams", "anonymousCount", "permissions" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" } } }, "post": { "operationId": "workspace.storeTeam", "description": "Creates an organization team and returns its team detail payload.", "summary": "Create team", "tags": [ "teams" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CreateTeamRequest" } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "icon": {}, "color": {}, "owner": {}, "membersCount": { "type": "integer" }, "anonymousCount": { "type": "integer" }, "members": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MemberResource" } }, "surveys": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TeamSurveyResource" } }, "childTeams": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ChildTeamResource" } }, "permissions": { "type": "object", "properties": { "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" }, "canJoin": { "type": "boolean" }, "canLeave": { "type": "boolean" } }, "required": [ "canEdit", "canDelete", "canJoin", "canLeave" ] }, "teamsHref": { "type": "string" } }, "required": [ "id", "name", "icon", "color", "owner", "membersCount", "anonymousCount", "members", "surveys", "childTeams", "permissions", "teamsHref" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" }, "422": { "$ref": "#\/components\/responses\/ApiV1Error422" } } } }, "\/{org}\/teams\/{team}": { "get": { "operationId": "workspace.team", "description": "Returns team details, members, children, and survey context for one organization team.", "summary": "Read team", "tags": [ "teams" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "team", "in": "path", "required": true, "description": "The team ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "icon": {}, "color": {}, "owner": {}, "membersCount": { "type": "integer" }, "anonymousCount": { "type": "integer" }, "members": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MemberResource" } }, "surveys": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TeamSurveyResource" } }, "childTeams": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ChildTeamResource" } }, "permissions": { "type": "object", "properties": { "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" }, "canJoin": { "type": "boolean" }, "canLeave": { "type": "boolean" } }, "required": [ "canEdit", "canDelete", "canJoin", "canLeave" ] }, "teamsHref": { "type": "string" } }, "required": [ "id", "name", "icon", "color", "owner", "membersCount", "anonymousCount", "members", "surveys", "childTeams", "permissions", "teamsHref" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" } } }, "patch": { "operationId": "workspace.updateTeam", "description": "Updates an organization team and returns the refreshed team detail payload.", "summary": "Update team", "tags": [ "teams" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "team", "in": "path", "required": true, "description": "The team ID", "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UpdateTeamRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "icon": {}, "color": {}, "owner": {}, "membersCount": { "type": "integer" }, "anonymousCount": { "type": "integer" }, "members": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MemberResource" } }, "surveys": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TeamSurveyResource" } }, "childTeams": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ChildTeamResource" } }, "permissions": { "type": "object", "properties": { "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" }, "canJoin": { "type": "boolean" }, "canLeave": { "type": "boolean" } }, "required": [ "canEdit", "canDelete", "canJoin", "canLeave" ] }, "teamsHref": { "type": "string" } }, "required": [ "id", "name", "icon", "color", "owner", "membersCount", "anonymousCount", "members", "surveys", "childTeams", "permissions", "teamsHref" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" }, "422": { "$ref": "#\/components\/responses\/ApiV1Error422" } } }, "delete": { "operationId": "workspace.destroyTeam", "description": "Deletes an organization team and returns an acknowledgement envelope.", "summary": "Delete team", "tags": [ "teams" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "team", "in": "path", "required": true, "description": "The team ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" } } } }, "\/{org}\/teams\/{team}\/join": { "post": { "operationId": "workspace.joinTeam", "description": "Adds the authenticated user to the organization team and returns the refreshed team detail payload.", "summary": "Join team", "tags": [ "teams" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "team", "in": "path", "required": true, "description": "The team ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "icon": {}, "color": {}, "owner": {}, "membersCount": { "type": "integer" }, "anonymousCount": { "type": "integer" }, "members": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MemberResource" } }, "surveys": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TeamSurveyResource" } }, "childTeams": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ChildTeamResource" } }, "permissions": { "type": "object", "properties": { "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" }, "canJoin": { "type": "boolean" }, "canLeave": { "type": "boolean" } }, "required": [ "canEdit", "canDelete", "canJoin", "canLeave" ] }, "teamsHref": { "type": "string" } }, "required": [ "id", "name", "icon", "color", "owner", "membersCount", "anonymousCount", "members", "surveys", "childTeams", "permissions", "teamsHref" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" } } } }, "\/{org}\/teams\/{team}\/leave": { "post": { "operationId": "workspace.leaveTeam", "description": "Removes the authenticated user from the organization team and returns the refreshed team detail payload.", "summary": "Leave team", "tags": [ "teams" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "team", "in": "path", "required": true, "description": "The team ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "icon": {}, "color": {}, "owner": {}, "membersCount": { "type": "integer" }, "anonymousCount": { "type": "integer" }, "members": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MemberResource" } }, "surveys": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TeamSurveyResource" } }, "childTeams": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ChildTeamResource" } }, "permissions": { "type": "object", "properties": { "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" }, "canJoin": { "type": "boolean" }, "canLeave": { "type": "boolean" } }, "required": [ "canEdit", "canDelete", "canJoin", "canLeave" ] }, "teamsHref": { "type": "string" } }, "required": [ "id", "name", "icon", "color", "owner", "membersCount", "anonymousCount", "members", "surveys", "childTeams", "permissions", "teamsHref" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" } } } }, "\/{org}\/teams\/{team}\/surveys\/{survey}": { "get": { "operationId": "workspace.teamSurveySlice", "description": "Returns survey analytics scoped to one organization team.", "summary": "Read team survey slice", "tags": [ "teams" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "team", "in": "path", "required": true, "description": "The team ID", "schema": { "type": "string" } }, { "name": "survey", "in": "path", "required": true, "description": "The survey ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "team": {}, "survey": {}, "milestone": {}, "previousMilestone": {}, "score": {}, "orgScore": {}, "delta": {}, "categories": {}, "privacy": {}, "milestones": {}, "teamsHref": { "type": "string" } }, "required": [ "team", "survey", "milestone", "previousMilestone", "score", "orgScore", "delta", "categories", "privacy", "milestones", "teamsHref" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" } } } }, "\/{org}\/people": { "get": { "operationId": "workspace.people", "description": "Returns a paginated organization people list with optional search.", "summary": "List people", "tags": [ "people" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "search", "in": "query", "description": "Searches people by the organization people-list query.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "People list page number.", "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "employees": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EmployeeResource" } }, "anonymousCount": { "type": "integer" }, "viewerIsGuest": { "type": "boolean" }, "permissions": { "type": "object", "properties": { "canInvite": { "type": "boolean" }, "canChangeRole": { "type": "boolean" }, "canRemove": { "type": "boolean" } }, "required": [ "canInvite", "canChangeRole", "canRemove" ] }, "search": {}, "pagination": {} }, "required": [ "employees", "anonymousCount", "viewerIsGuest", "permissions", "search", "pagination" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" } } } }, "\/{org}\/people\/{user}": { "get": { "operationId": "workspace.person", "description": "Returns organization membership and profile context for one user.", "summary": "Read person", "tags": [ "people" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "user", "in": "path", "required": true, "description": "The user ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organizationName": { "type": "string" }, "avatar": {}, "team": {}, "role": { "type": "string" }, "surveys": {}, "permissions": { "type": "object", "properties": { "canChangeRole": { "type": "boolean" }, "canRemove": { "type": "boolean" }, "canTransferOwnership": { "type": "boolean" } }, "required": [ "canChangeRole", "canRemove", "canTransferOwnership" ] }, "updateRoleHref": { "type": "string" }, "transferOwnershipHref": { "type": "string" }, "destroyHref": { "type": "string" } }, "required": [ "id", "name", "organizationName", "avatar", "team", "role", "surveys", "permissions", "updateRoleHref", "transferOwnershipHref", "destroyHref" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" } } }, "delete": { "operationId": "workspace.destroyPerson", "description": "Removes a person from the organization and returns an acknowledgement envelope.", "summary": "Remove person", "tags": [ "people" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "user", "in": "path", "required": true, "description": "The user ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" } } } }, "\/{org}\/people\/{user}\/role": { "patch": { "operationId": "workspace.updatePersonRole", "description": "Changes a user role inside the organization and returns the refreshed person payload.", "summary": "Update person role", "tags": [ "people" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "user", "in": "path", "required": true, "description": "The user ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ChangeRoleRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organizationName": { "type": "string" }, "avatar": {}, "team": {}, "role": { "type": "string" }, "surveys": {}, "permissions": { "type": "object", "properties": { "canChangeRole": { "type": "boolean" }, "canRemove": { "type": "boolean" }, "canTransferOwnership": { "type": "boolean" } }, "required": [ "canChangeRole", "canRemove", "canTransferOwnership" ] }, "updateRoleHref": { "type": "string" }, "transferOwnershipHref": { "type": "string" }, "destroyHref": { "type": "string" } }, "required": [ "id", "name", "organizationName", "avatar", "team", "role", "surveys", "permissions", "updateRoleHref", "transferOwnershipHref", "destroyHref" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" }, "422": { "$ref": "#\/components\/responses\/ApiV1Error422" } } } }, "\/{org}\/people\/{user}\/ownership": { "patch": { "operationId": "workspace.transferOwnership", "description": "Transfers organization ownership to the selected person and returns the refreshed person payload.", "summary": "Transfer organization ownership", "tags": [ "people" ], "parameters": [ { "name": "org", "in": "path", "required": true, "description": "The org ID", "schema": { "type": "string" } }, { "name": "user", "in": "path", "required": true, "description": "The user ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TransferOrganizationOwnershipRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organizationName": { "type": "string" }, "avatar": {}, "team": {}, "role": { "type": "string" }, "surveys": {}, "permissions": { "type": "object", "properties": { "canChangeRole": { "type": "boolean" }, "canRemove": { "type": "boolean" }, "canTransferOwnership": { "type": "boolean" } }, "required": [ "canChangeRole", "canRemove", "canTransferOwnership" ] }, "updateRoleHref": { "type": "string" }, "transferOwnershipHref": { "type": "string" }, "destroyHref": { "type": "string" } }, "required": [ "id", "name", "organizationName", "avatar", "team", "role", "surveys", "permissions", "updateRoleHref", "transferOwnershipHref", "destroyHref" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "meta": { "type": "object", "properties": { "path": { "type": "string" } }, "required": [ "path" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/ApiV1Error401" }, "403": { "$ref": "#\/components\/responses\/ApiV1Error403" }, "404": { "$ref": "#\/components\/responses\/ApiV1Error404" }, "422": { "$ref": "#\/components\/responses\/ApiV1Error422" } } } } }, "components": { "securitySchemes": { "http": { "type": "http", "description": "Personal API token passed as `Authorization: Bearer `.", "scheme": "bearer" } }, "schemas": { "AiSurveyBriefRequest": { "type": "object", "properties": { "topic": { "type": "string", "minLength": 3, "maxLength": 200 }, "goal": { "type": "string", "minLength": 3, "maxLength": 1000 }, "respondents": { "type": "string", "minLength": 3, "maxLength": 500 }, "problemFocus": { "type": "string", "minLength": 3, "maxLength": 1000 }, "expectedOutcome": { "type": "string", "minLength": 3, "maxLength": 1000 }, "organizationContext": { "type": [ "string", "null" ], "maxLength": 2000 }, "sensitiveBoundaries": { "type": [ "string", "null" ], "maxLength": 1000 }, "categoryCount": { "type": "integer", "minimum": 3, "maximum": 7 }, "questionsPerCategory": { "type": "integer", "minimum": 2, "maximum": 5 } }, "required": [ "topic", "goal", "respondents", "problemFocus", "expectedOutcome", "categoryCount", "questionsPerCategory" ], "title": "AiSurveyBriefRequest" }, "AnalyticsCategoryResource": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "score": {}, "delta": {}, "summary": {}, "history": {}, "belowThreshold": { "type": "boolean" }, "questionsHref": { "type": "string" } }, "required": [ "id", "name", "score", "delta", "summary", "history", "belowThreshold", "questionsHref" ], "title": "AnalyticsCategoryResource" }, "AnalyticsTaxonResource": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "signalsCount": { "type": "integer" }, "delta": {}, "issuesHref": { "type": "string" }, "issueHref": {} }, "required": [ "key", "name", "signalsCount", "delta", "issuesHref", "issueHref" ], "title": "AnalyticsTaxonResource" }, "AnswerResource": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "position": { "type": "integer" }, "weight": { "type": "integer" }, "label": { "type": [ "string", "null" ] }, "clarifyingQuestion": { "type": [ "string", "null" ] } }, "required": [ "id", "position", "weight", "label", "clarifyingQuestion" ], "title": "AnswerResource" }, "ArtifactTypeResource": { "type": "object", "properties": { "type": { "type": "string" }, "label": { "type": "string" }, "settings": { "type": "array", "items": {} } }, "required": [ "type", "label", "settings" ], "title": "ArtifactTypeResource" }, "ChangeIssuePriorityRequest": { "type": "object", "properties": { "priority": { "$ref": "#\/components\/schemas\/IssuePriority" } }, "required": [ "priority" ], "title": "ChangeIssuePriorityRequest" }, "ChangeIssueStatusRequest": { "type": "object", "properties": { "status": { "$ref": "#\/components\/schemas\/IssueStatus" } }, "required": [ "status" ], "title": "ChangeIssueStatusRequest" }, "ChangeRoleRequest": { "type": "object", "properties": { "role": { "$ref": "#\/components\/schemas\/MemberRole" } }, "required": [ "role" ], "title": "ChangeRoleRequest" }, "ChildTeamResource": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "icon": {}, "color": {}, "membersCount": { "type": "integer" }, "href": { "type": "string" } }, "required": [ "id", "name", "icon", "color", "membersCount", "href" ], "title": "ChildTeamResource" }, "ConfirmAiSurveyCreationRequest": { "type": "object", "properties": { "title": { "type": "string", "minLength": 3, "maxLength": 120 }, "topic": { "type": "string", "minLength": 3, "maxLength": 200 }, "researchIntent": { "type": "string", "minLength": 3, "maxLength": 1000 }, "brief": { "type": "object", "properties": { "topic": { "type": "string", "minLength": 3, "maxLength": 200 }, "goal": { "type": "string", "minLength": 3, "maxLength": 1000 }, "respondents": { "type": "string", "minLength": 3, "maxLength": 500 }, "problemFocus": { "type": "string", "minLength": 3, "maxLength": 1000 }, "expectedOutcome": { "type": "string", "minLength": 3, "maxLength": 1000 }, "organizationContext": { "type": [ "string", "null" ], "maxLength": 2000 }, "sensitiveBoundaries": { "type": [ "string", "null" ], "maxLength": 1000 }, "categoryCount": { "type": "integer", "minimum": 3, "maximum": 7 }, "questionsPerCategory": { "type": "integer", "minimum": 2, "maximum": 5 } }, "required": [ "topic", "goal", "respondents", "problemFocus", "expectedOutcome", "categoryCount", "questionsPerCategory" ] }, "categories": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "questions": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string", "minLength": 1, "maxLength": 250 } }, "required": [ "text" ] }, "minItems": 1 } }, "required": [ "name", "questions" ] }, "minItems": 1 } }, "required": [ "title", "topic", "researchIntent", "brief", "categories" ], "title": "ConfirmAiSurveyCreationRequest" }, "CreateSurveyRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 3, "maxLength": 120 }, "templateId": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ], "maxLength": 512 }, "respondent": { "type": [ "string", "null" ], "maxLength": 2000 } }, "required": [ "name" ], "title": "CreateSurveyRequest" }, "CreateTeamRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 2, "maxLength": 80 }, "icon": { "$ref": "#\/components\/schemas\/TeamIcon" }, "color": { "$ref": "#\/components\/schemas\/TeamColor" }, "parentId": { "type": [ "string", "null" ] } }, "required": [ "name" ], "title": "CreateTeamRequest" }, "DraftQuestionRequest": { "type": "object", "properties": { "prompt": { "type": [ "string", "null" ], "maxLength": 500 } }, "title": "DraftQuestionRequest" }, "EmployeeResource": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "avatar": {}, "isOwner": { "type": "boolean" }, "teamName": {}, "teamColor": {}, "role": { "type": "string" }, "surveysCompleted": { "type": "integer" }, "canChangeRole": { "type": "boolean" }, "canRemove": { "type": "boolean" }, "href": { "type": "string" } }, "required": [ "id", "name", "avatar", "isOwner", "teamName", "teamColor", "role", "surveysCompleted", "canChangeRole", "canRemove", "href" ], "title": "EmployeeResource" }, "FaqItemResource": { "type": "object", "properties": { "question": { "type": "string" }, "answer": { "type": "string" } }, "required": [ "question", "answer" ], "title": "FaqItemResource" }, "GuestAnswerOptionResource": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "position": { "type": "integer" }, "weight": { "type": "integer" }, "comment": { "type": [ "string", "null" ] }, "clarifying": { "type": [ "string", "null" ] } }, "required": [ "id", "position", "weight", "comment", "clarifying" ], "title": "GuestAnswerOptionResource" }, "IdeaReactionType": { "type": "string", "enum": [ "like", "dislike" ], "title": "IdeaReactionType" }, "IssueCommentResource": { "type": "object", "properties": { "id": { "type": "string" }, "text": { "type": "string" }, "author": { "type": "string" }, "createdAt": { "type": "string" }, "canDelete": { "type": "boolean" }, "isSystem": { "type": "boolean" } }, "required": [ "id", "text", "author", "createdAt", "canDelete", "isSystem" ], "title": "IssueCommentResource" }, "IssueIdeaResource": { "type": "object", "properties": { "id": { "type": "string" }, "text": { "type": "string" }, "author": { "type": "string" }, "isSystem": { "type": "boolean" }, "likes": { "type": "integer" }, "dislikes": { "type": "integer" }, "userReaction": { "type": [ "string", "null" ] }, "createdAt": { "type": "string" } }, "required": [ "id", "text", "author", "isSystem", "likes", "dislikes", "userReaction", "createdAt" ], "title": "IssueIdeaResource" }, "IssueListItemResource": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "taxon": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" } }, "required": [ "key", "name" ] } ] }, "status": { "type": "string" }, "priority": { "type": "string" }, "owner": { "type": "string" }, "ideasCount": { "type": "integer" }, "commentsCount": { "type": "integer" }, "surveys": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "createdAt": { "type": "string" } }, "required": [ "id", "title", "taxon", "status", "priority", "owner", "ideasCount", "commentsCount", "surveys", "createdAt" ], "title": "IssueListItemResource" }, "IssueOptionResource": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" } }, "required": [ "value", "label" ], "title": "IssueOptionResource" }, "IssuePriority": { "type": "string", "enum": [ "low", "medium", "high" ], "title": "IssuePriority" }, "IssueStatus": { "type": "string", "enum": [ "open", "in_progress", "implemented" ], "title": "IssueStatus" }, "KnowledgeCardCompactResource": { "type": "object", "properties": { "key": { "type": "string" }, "title": { "type": "string" }, "summary": { "type": "string" }, "href": { "type": "string" } }, "required": [ "key", "title", "summary", "href" ], "title": "KnowledgeCardCompactResource" }, "MemberResource": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "avatar": {}, "role": { "type": "string" } }, "required": [ "id", "name", "avatar", "role" ], "title": "MemberResource" }, "MemberRole": { "type": "string", "enum": [ "assistant", "admin", "manager", "member", "guest" ], "title": "MemberRole" }, "MilestoneSummaryResource": { "type": "object", "properties": { "id": { "type": "string" }, "value": { "type": "integer" }, "status": { "type": "string" }, "startedCount": { "type": "integer" }, "completedCount": { "type": "integer" }, "startedAt": { "type": [ "string", "null" ] }, "closedAt": { "type": [ "string", "null" ] }, "hasReport": { "type": "boolean" } }, "required": [ "id", "value", "status", "startedCount", "completedCount", "startedAt", "closedAt", "hasReport" ], "title": "MilestoneSummaryResource" }, "QuestionDistributionBucketResource": { "type": "object", "properties": { "label": { "type": "string" }, "count": { "type": "integer" }, "percent": { "type": "integer" }, "position": { "type": "integer" } }, "required": [ "label", "count", "percent", "position" ], "title": "QuestionDistributionBucketResource" }, "QuestionResource": { "type": "object", "properties": { "id": { "type": "string" }, "text": { "type": "string" }, "intent": { "type": "string" }, "keywords": { "type": "array", "items": {} }, "displayMode": { "type": "string" }, "isInverted": { "type": "boolean" }, "sortOrder": { "type": "integer" }, "answers": { "type": "array", "items": { "$ref": "#\/components\/schemas\/AnswerResource" } } }, "required": [ "id", "text", "intent", "keywords", "displayMode", "isInverted", "sortOrder", "answers" ], "title": "QuestionResource" }, "ReactToIdeaRequest": { "type": "object", "properties": { "type": { "$ref": "#\/components\/schemas\/IdeaReactionType" } }, "required": [ "type" ], "title": "ReactToIdeaRequest" }, "ReorderRequest": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" }, "minItems": 1 } }, "required": [ "ids" ], "title": "ReorderRequest" }, "ReportArtifactResource": { "type": "object", "properties": { "id": { "type": "string" }, "parentId": { "type": [ "string", "null" ] }, "milestoneId": { "type": [ "string", "null" ] }, "revision": { "type": "integer" }, "title": { "type": [ "string", "null" ] }, "type": { "type": "string" }, "settings": { "type": "array", "items": {} }, "status": { "type": "string" }, "sections": { "type": "array", "items": {} }, "error": { "type": [ "string", "null" ], "const": "\u041e\u0442\u0447\u0451\u0442 \u043d\u0435 \u0441\u043e\u0431\u0440\u0430\u043d. \u041f\u0440\u043e\u0432\u0435\u0440\u044c\u0442\u0435 \u043d\u0430\u0441\u0442\u0440\u043e\u0439\u043a\u0438 \u0438 \u043f\u043e\u043f\u0440\u043e\u0431\u0443\u0439\u0442\u0435 \u0441\u0433\u0435\u043d\u0435\u0440\u0438\u0440\u043e\u0432\u0430\u0442\u044c \u0437\u0430\u043d\u043e\u0432\u043e." }, "downloadHref": { "type": [ "string", "null" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "parentId", "milestoneId", "revision", "title", "type", "settings", "status", "sections", "error", "downloadHref", "createdAt", "updatedAt" ], "title": "ReportArtifactResource" }, "RevealIdentityRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 2, "maxLength": 120 } }, "required": [ "name" ], "title": "RevealIdentityRequest" }, "SaveAnswerRequest": { "type": "object", "properties": { "questionId": { "type": "string" }, "value": { "type": "string", "maxLength": 255 }, "comment": { "type": [ "string", "null" ], "maxLength": 500 }, "aiResponse": { "type": [ "string", "null" ], "maxLength": 500 }, "skipAiFollowUp": { "type": "boolean" } }, "required": [ "questionId", "value" ], "title": "SaveAnswerRequest" }, "StoreIdeaRequest": { "type": "object", "properties": { "text": { "type": "string", "maxLength": 2000 } }, "required": [ "text" ], "title": "StoreIdeaRequest" }, "StoreIssueCommentRequest": { "type": "object", "properties": { "text": { "type": "string", "maxLength": 5000 } }, "required": [ "text" ], "title": "StoreIssueCommentRequest" }, "SubmitFinalCommentRequest": { "type": "object", "properties": { "comment": { "type": [ "string", "null" ], "maxLength": 500 } }, "title": "SubmitFinalCommentRequest" }, "SurveyResource": { "type": "array", "items": {}, "title": "SurveyResource" }, "TaxonResource": { "type": "object", "properties": { "key": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" } }, "required": [ "key", "title", "description" ], "title": "TaxonResource" }, "TeamColor": { "type": "string", "enum": [ "red", "orange", "yellow", "green", "aqua", "blue", "purple" ], "title": "TeamColor" }, "TeamIcon": { "type": "string", "enum": [ "building-2", "scale", "bar-chart-3", "users", "megaphone", "sparkles", "clipboard-list", "calculator", "user-round", "shield-check", "briefcase", "rocket", "target", "flag", "star", "heart", "book", "code-2", "palette", "compass" ], "title": "TeamIcon" }, "TeamLeaderboardEntryResource": { "type": "object", "properties": { "id": { "type": "string" }, "rank": { "type": "integer" }, "name": { "type": "string" }, "score": {}, "delta": {}, "completedCount": { "type": "integer" }, "respondentsCount": { "type": "integer" }, "history": {}, "teamHref": {} }, "required": [ "id", "rank", "name", "score", "delta", "completedCount", "respondentsCount", "history", "teamHref" ], "title": "TeamLeaderboardEntryResource" }, "TeamResource": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "icon": {}, "color": {}, "membersCount": { "type": "integer" }, "ownerName": {}, "isUserMember": { "type": "boolean" }, "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" }, "canJoin": { "type": "boolean" }, "href": { "type": "string" }, "children": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TeamResource" } } }, "required": [ "id", "name", "icon", "color", "membersCount", "ownerName", "isUserMember", "canEdit", "canDelete", "canJoin", "href", "children" ], "title": "TeamResource" }, "TeamSurveyResource": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "teamScore": {}, "passedCount": { "type": "integer" }, "totalCount": { "type": "integer" }, "delta": {}, "href": { "type": "string" } }, "required": [ "id", "name", "teamScore", "passedCount", "totalCount", "delta", "href" ], "title": "TeamSurveyResource" }, "TemplateResource": { "type": "array", "items": {}, "title": "TemplateResource" }, "TransferOrganizationOwnershipRequest": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 64 } }, "required": [ "name" ], "title": "TransferOrganizationOwnershipRequest" }, "UpdateIssueOwnerRequest": { "type": "object", "properties": { "owner_id": { "type": [ "string", "null" ] } }, "title": "UpdateIssueOwnerRequest" }, "UpdateSurveyRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 3, "maxLength": 120 }, "description": { "type": [ "string", "null" ], "maxLength": 512 }, "respondent": { "type": [ "string", "null" ], "maxLength": 2000 } }, "title": "UpdateSurveyRequest" }, "UpdateTeamRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 2, "maxLength": 80 }, "icon": { "$ref": "#\/components\/schemas\/TeamIcon" }, "color": { "$ref": "#\/components\/schemas\/TeamColor" } }, "title": "UpdateTeamRequest" }, "UpsertQuestionRequest": { "type": "object", "properties": { "text": { "type": "string", "minLength": 3, "maxLength": 250 }, "intent": { "type": [ "string", "null" ], "maxLength": 250 }, "displayMode": { "type": "string", "enum": [ "scale", "list" ] }, "isInverted": { "type": "boolean" }, "keywords": { "type": [ "array", "null" ], "items": { "type": "string", "maxLength": 64 }, "maxItems": 10 }, "answers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "position": { "type": "integer", "enum": [ "0", "1", "2", "3", "4" ] }, "label": { "type": [ "string", "null" ], "maxLength": 120 }, "clarifyingQuestion": { "type": [ "string", "null" ], "maxLength": 500 } }, "required": [ "position" ] }, "minItems": 5, "maxItems": 5 } }, "required": [ "text", "displayMode", "isInverted", "answers" ], "title": "UpsertQuestionRequest" } }, "responses": { "ValidationException": { "description": "Validation error", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Errors overview." }, "errors": { "type": "object", "description": "A detailed description of each field that failed validation.", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "required": [ "message", "errors" ] } } } }, "AuthorizationException": { "description": "Authorization error", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview." } }, "required": [ "message" ] } } } }, "ModelNotFoundException": { "description": "Not found", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview." } }, "required": [ "message" ] } } } }, "AuthenticationException": { "description": "Unauthenticated", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview." } }, "required": [ "message" ] } } } }, "ApiV1Error401": { "description": "Unauthenticated.", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "required": [ "status", "message", "errors" ] } } } }, "ApiV1Error403": { "description": "Forbidden.", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "required": [ "status", "message", "errors" ] } } } }, "ApiV1Error404": { "description": "Not found.", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "required": [ "status", "message", "errors" ] } } } }, "ApiV1Error422": { "description": "Validation error.", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "required": [ "status", "message", "errors" ] } } } } } } }