{ "components": { "schemas": { "CohortRequest": { "properties": { "capacity": { "format": "int32", "type": "integer" }, "endDate": { "$ref": "#/components/schemas/LocalDate" }, "name": { "type": "string" }, "startDate": { "$ref": "#/components/schemas/LocalDate" } }, "type": "object" }, "CompleteMilestoneRequest": { "properties": { "evidenceUrl": { "type": "string" }, "notes": { "type": "string" } }, "type": "object" }, "EnrollRequest": { "properties": { "founderId": { "$ref": "#/components/schemas/UUID" }, "ventureId": { "$ref": "#/components/schemas/UUID" } }, "type": "object" }, "FileUpload": { "type": "object" }, "GraduationRequest": { "properties": { "approvedBy": { "type": "string" }, "cohortId": { "$ref": "#/components/schemas/UUID" }, "notes": { "type": "string" }, "programId": { "$ref": "#/components/schemas/UUID" }, "ventureId": { "$ref": "#/components/schemas/UUID" }, "ventureName": { "type": "string" } }, "type": "object" }, "LocalDate": { "example": "2022-03-10", "format": "date", "type": "string" }, "MilestonePlanRequest": { "properties": { "programId": { "$ref": "#/components/schemas/UUID" }, "startDate": { "$ref": "#/components/schemas/LocalDate" } }, "type": "object" }, "ProgrammeRequest": { "properties": { "description": { "type": "string" }, "durationWeeks": { "format": "int32", "type": "integer" }, "minTrlForGraduation": { "format": "int32", "type": "integer" }, "name": { "type": "string" }, "requiredMilestones": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "ReviewMilestoneRequest": { "properties": { "decision": { "type": "string" }, "feedback": { "type": "string" }, "reviewerId": { "type": "string" } }, "type": "object" }, "StageGateRequest": { "properties": { "minTrl": { "format": "int32", "type": "integer" }, "name": { "type": "string" }, "requiredMilestoneTitles": { "items": { "type": "string" }, "type": "array" }, "sequence": { "format": "int32", "type": "integer" } }, "type": "object" }, "UUID": { "format": "uuid", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "type": "string" } }, "securitySchemes": { "keycloak-bearer": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Access token issued by the Keycloak realm `startupos`. Send it as `Authorization: Bearer `. A missing, expired or invalid token returns 401; a valid token without the required role returns 403." }, "stream-token": { "type": "apiKey", "in": "query", "name": "token", "description": "Short-lived, enrolment-scoped stream token minted by the matching authenticated `stream-token` operation. Used because a cross-origin video element cannot send an Authorization header." }, "livekit-signature": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "JWT signed by the LiveKit server, sent without a `Bearer ` prefix and verified by the service. Only the LiveKit server calls this operation." } } }, "info": { "title": "StartupOS program service", "version": "a54687de", "description": "Generated at build time from the service's JAX-RS resources (SmallRye OpenAPI) and annotated by the overlay in docs-site/openapi/overlays. Every operation requires a Keycloak access token unless the operation says otherwise. Health and metrics endpoints are internal and are not documented." }, "openapi": "3.0.3", "paths": { "/api/v1/cohorts": { "get": { "operationId": "ProgrammeResource_listCohorts", "parameters": [ { "in": "query", "name": "programmeId", "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "description": "OK" } }, "tags": [ "Programmes and cohorts" ], "summary": "List cohorts" } }, "/api/v1/cohorts/{id}": { "delete": { "operationId": "ProgrammeResource_deleteCohort", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "description": "OK" } }, "tags": [ "Programmes and cohorts" ], "summary": "Delete cohort" }, "get": { "operationId": "ProgrammeResource_getCohort", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "description": "OK" } }, "tags": [ "Programmes and cohorts" ], "summary": "Get cohort" }, "put": { "operationId": "ProgrammeResource_updateCohort", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CohortRequest" } } } }, "responses": { "200": { "description": "OK" } }, "tags": [ "Programmes and cohorts" ], "summary": "Update cohort" } }, "/api/v1/cohorts/{id}/enroll": { "post": { "operationId": "ProgrammeResource_enroll", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrollRequest" } } } }, "responses": { "200": { "description": "OK" } }, "tags": [ "Programmes and cohorts" ], "summary": "Enroll" } }, "/api/v1/cohorts/{id}/enrollments": { "get": { "operationId": "ProgrammeResource_listEnrollments", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "description": "OK" } }, "tags": [ "Programmes and cohorts" ], "summary": "List enrollments" } }, "/api/v1/health/at-risk": { "get": { "operationId": "ProgramResource_atRisk", "responses": { "200": { "description": "OK" } }, "tags": [ "Venture health and milestones" ], "summary": "At risk" } }, "/api/v1/health/recalculate": { "post": { "operationId": "ProgramResource_recalculate", "responses": { "200": { "description": "OK" } }, "tags": [ "Venture health and milestones" ], "summary": "Recalculate" } }, "/api/v1/health/venture/{ventureId}": { "get": { "operationId": "ProgramResource_getVentureHealthThroughProgramPrefix", "parameters": [ { "in": "path", "name": "ventureId", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "description": "OK" } }, "tags": [ "Venture health and milestones" ], "summary": "Get venture health through program prefix" } }, "/api/v1/health/venture/{ventureId}/at-risk": { "get": { "operationId": "ProgramResource_getVentureAtRisk", "parameters": [ { "in": "path", "name": "ventureId", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "description": "OK" } }, "tags": [ "Venture health and milestones" ], "summary": "Get venture at risk" } }, "/api/v1/health/venture/{ventureId}/history": { "get": { "operationId": "ProgramResource_getVentureHealthHistory", "parameters": [ { "in": "path", "name": "ventureId", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } }, { "in": "query", "name": "limit", "schema": { "format": "int32", "type": "integer" } } ], "responses": { "200": { "description": "OK" } }, "tags": [ "Venture health and milestones" ], "summary": "Get venture health history" } }, "/api/v1/health/ventures": { "get": { "operationId": "ProgramResource_getVentureHealthBatch", "parameters": [ { "in": "query", "name": "ids", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "tags": [ "Venture health and milestones" ], "summary": "Get venture health batch" } }, "/api/v1/milestones/templates": { "get": { "operationId": "ProgramResource_getMilestoneLadder", "responses": { "200": { "description": "OK" } }, "tags": [ "Venture health and milestones" ], "summary": "Get milestone ladder" } }, "/api/v1/milestones/venture/{ventureId}": { "get": { "operationId": "ProgramResource_getMilestonesThroughProgramPrefix", "parameters": [ { "in": "path", "name": "ventureId", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } }, { "in": "query", "name": "status", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "tags": [ "Venture health and milestones" ], "summary": "Get milestones through program prefix" } }, "/api/v1/milestones/venture/{ventureId}/plan": { "post": { "operationId": "ProgramResource_ensureMilestonePlan", "parameters": [ { "in": "path", "name": "ventureId", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MilestonePlanRequest" } } } }, "responses": { "200": { "description": "OK" } }, "tags": [ "Venture health and milestones" ], "summary": "Ensure milestone plan" } }, "/api/v1/milestones/ventures": { "get": { "operationId": "ProgramResource_getMilestonesBatch", "parameters": [ { "in": "query", "name": "ids", "schema": { "type": "string" } }, { "in": "query", "name": "status", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "tags": [ "Venture health and milestones" ], "summary": "Get milestones batch" } }, "/api/v1/milestones/{milestoneId}/complete": { "put": { "operationId": "ProgramResource_completeMilestone", "parameters": [ { "in": "path", "name": "milestoneId", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompleteMilestoneRequest" } } } }, "responses": { "200": { "description": "OK" } }, "tags": [ "Venture health and milestones" ], "summary": "Complete milestone" } }, "/api/v1/milestones/{milestoneId}/evidence": { "get": { "operationId": "ProgramResource_downloadMilestoneEvidence", "parameters": [ { "in": "path", "name": "milestoneId", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "description": "OK" } }, "tags": [ "Venture health and milestones" ], "summary": "Download milestone evidence" }, "put": { "operationId": "ProgramResource_uploadMilestoneEvidence", "parameters": [ { "in": "path", "name": "milestoneId", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "file": { "$ref": "#/components/schemas/FileUpload" }, "notes": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK" } }, "tags": [ "Venture health and milestones" ], "summary": "Upload milestone evidence" } }, "/api/v1/milestones/{milestoneId}/review": { "put": { "operationId": "ProgramResource_reviewMilestone", "parameters": [ { "in": "path", "name": "milestoneId", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewMilestoneRequest" } } } }, "responses": { "200": { "description": "OK" } }, "tags": [ "Venture health and milestones" ], "summary": "Review milestone" } }, "/api/v1/programmes": { "get": { "operationId": "ProgrammeResource_listProgrammes", "parameters": [ { "in": "query", "name": "includeRetired", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "description": "OK" } }, "tags": [ "Programmes and cohorts" ], "summary": "List programmes" }, "post": { "operationId": "ProgrammeResource_createProgramme", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgrammeRequest" } } } }, "responses": { "200": { "description": "OK" } }, "tags": [ "Programmes and cohorts" ], "summary": "Create programme" } }, "/api/v1/programmes/graduation-candidates": { "get": { "operationId": "ProgramResource_graduationCandidates", "parameters": [ { "in": "query", "name": "limit", "schema": { "format": "int32", "type": "integer" } }, { "in": "query", "name": "programId", "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "description": "OK" } }, "tags": [ "Venture health and milestones" ], "summary": "Graduation candidates" } }, "/api/v1/programmes/graduations": { "get": { "operationId": "ProgramResource_listGraduations", "parameters": [ { "in": "query", "name": "limit", "schema": { "format": "int32", "type": "integer" } }, { "in": "query", "name": "programId", "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "description": "OK" } }, "tags": [ "Venture health and milestones" ], "summary": "List graduations" } }, "/api/v1/programmes/ventures/{ventureId}/evaluate-graduation": { "post": { "operationId": "ProgramResource_evaluateGraduationThroughProgramPrefix", "parameters": [ { "in": "path", "name": "ventureId", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GraduationRequest" } } } }, "responses": { "200": { "description": "OK" } }, "tags": [ "Venture health and milestones" ], "summary": "Evaluate graduation through program prefix" } }, "/api/v1/programmes/ventures/{ventureId}/graduate": { "post": { "operationId": "ProgramResource_graduateThroughProgramPrefix", "parameters": [ { "in": "path", "name": "ventureId", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GraduationRequest" } } } }, "responses": { "200": { "description": "OK" } }, "tags": [ "Venture health and milestones" ], "summary": "Graduate through program prefix" } }, "/api/v1/programmes/ventures/{ventureId}/graduations": { "get": { "operationId": "ProgramResource_getVentureGraduations", "parameters": [ { "in": "path", "name": "ventureId", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "description": "OK" } }, "tags": [ "Venture health and milestones" ], "summary": "Get venture graduations" } }, "/api/v1/programmes/{id}": { "delete": { "operationId": "ProgrammeResource_deleteProgramme", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "description": "OK" } }, "tags": [ "Programmes and cohorts" ], "summary": "Delete programme" }, "get": { "operationId": "ProgrammeResource_getProgramme", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "description": "OK" } }, "tags": [ "Programmes and cohorts" ], "summary": "Get programme" }, "put": { "operationId": "ProgrammeResource_updateProgramme", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgrammeRequest" } } } }, "responses": { "200": { "description": "OK" } }, "tags": [ "Programmes and cohorts" ], "summary": "Update programme" } }, "/api/v1/programmes/{id}/cohorts": { "get": { "operationId": "ProgrammeResource_listCohortsForProgramme", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "description": "OK" } }, "tags": [ "Programmes and cohorts" ], "summary": "List cohorts for programme" }, "post": { "operationId": "ProgrammeResource_createCohort", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CohortRequest" } } } }, "responses": { "200": { "description": "OK" } }, "tags": [ "Programmes and cohorts" ], "summary": "Create cohort" } }, "/api/v1/programmes/{id}/stage-gates": { "get": { "operationId": "ProgrammeResource_listStageGates", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "description": "OK" } }, "tags": [ "Programmes and cohorts" ], "summary": "List stage gates" }, "post": { "operationId": "ProgrammeResource_addStageGate", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StageGateRequest" } } } }, "responses": { "200": { "description": "OK" } }, "tags": [ "Programmes and cohorts" ], "summary": "Add stage gate" } }, "/api/v1/schemes": { "get": { "operationId": "SchemeResource_search", "parameters": [ { "in": "query", "name": "maximumAmount", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "minimumAmount", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "query", "schema": { "type": "string" } }, { "in": "query", "name": "sector", "schema": { "type": "string" } }, { "in": "query", "name": "stage", "schema": { "type": "string" } }, { "in": "query", "name": "state", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "tags": [ "Schemes" ], "summary": "Search" } }, "/api/v1/schemes/matches/venture/{ventureId}": { "get": { "operationId": "SchemeResource_matchesForVenture", "parameters": [ { "in": "path", "name": "ventureId", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "description": "OK" } }, "tags": [ "Schemes" ], "summary": "Matches for venture" } }, "/api/v1/ventures/{ventureId}/evaluate-graduation": { "post": { "operationId": "ProgramResource_evaluateGraduation", "parameters": [ { "in": "path", "name": "ventureId", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GraduationRequest" } } } }, "responses": { "200": { "description": "OK" } }, "tags": [ "Venture health and milestones" ], "summary": "Evaluate graduation" } }, "/api/v1/ventures/{ventureId}/graduate": { "post": { "operationId": "ProgramResource_graduate", "parameters": [ { "in": "path", "name": "ventureId", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GraduationRequest" } } } }, "responses": { "200": { "description": "OK" } }, "tags": [ "Venture health and milestones" ], "summary": "Graduate" } }, "/api/v1/ventures/{ventureId}/health": { "get": { "operationId": "ProgramResource_getVentureHealth", "parameters": [ { "in": "path", "name": "ventureId", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } } ], "responses": { "200": { "description": "OK" } }, "tags": [ "Venture health and milestones" ], "summary": "Get venture health" } }, "/api/v1/ventures/{ventureId}/milestones": { "get": { "operationId": "ProgramResource_getMilestones", "parameters": [ { "in": "path", "name": "ventureId", "required": true, "schema": { "$ref": "#/components/schemas/UUID" } }, { "in": "query", "name": "status", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "tags": [ "Venture health and milestones" ], "summary": "Get milestones" } } }, "security": [ { "keycloak-bearer": [] } ], "tags": [ { "name": "Venture health and milestones", "description": "Venture health scores and at-risk lists, milestone plans, evidence and review, and graduation evaluation." }, { "name": "Programmes and cohorts", "description": "Programmes, stage gates, cohorts and enrolments, and graduations." }, { "name": "Schemes", "description": "Government schemes and their matches to ventures." } ] }