management-openapi.json•7.08 kB
{
"openapi": "3.1.0",
"info": {
"title": "Convex CLI API",
"description": "CLI-specific endpoints for Convex development tools.",
"license": {
"name": "LicenseRef-Convex",
"identifier": "LicenseRef-Convex"
},
"version": "1.0.0"
},
"paths": {
"/teams": {
"get": {
"operationId": "get_teams_for_member",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Team"
}
}
}
}
}
}
}
},
"/teams/{team_slug}/projects": {
"get": {
"operationId": "get_cli_projects_for_team",
"parameters": [
{
"name": "team_slug",
"in": "path",
"description": "Team slug identifier",
"required": true
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectDetails"
}
}
}
}
}
}
}
},
"/workos/provision_associated_workos_team": {
"post": {
"description": "Provision a WorkOS team for a Convex team",
"operationId": "provision_associated_workos_team",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProvisionWorkOSTeamRequest"
}
}
},
"required": true
},
"responses": {}
}
},
"/workos/get_or_provision_workos_environment": {
"post": {
"description": "Get or provision a WorkOS environment for a deployment",
"operationId": "get_or_provision_workos_environment",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetOrProvisionEnvironmentRequest"
}
}
},
"required": true
},
"responses": {}
}
},
"/workos/has_associated_workos_team": {
"post": {
"description": "Check if a deployment has an associated WorkOS team",
"operationId": "has_associated_workos_team",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HasAssociatedWorkOSTeamRequest"
}
}
},
"required": true
},
"responses": {}
}
},
"/workos/available_workos_team_emails": {
"get": {
"description": "Get candidate email addresses to be WorkOS admins.",
"operationId": "get_available_workos_team_emails",
"responses": {}
}
}
},
"components": {
"schemas": {
"GetOrProvisionEnvironmentRequest": {
"type": "object",
"required": [
"deploymentName"
],
"properties": {
"deploymentName": {
"type": "string"
}
}
},
"HasAssociatedWorkOSTeamRequest": {
"type": "object",
"required": [
"deploymentName"
],
"properties": {
"deploymentName": {
"type": "string"
}
}
},
"MemberId": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"ProjectDetails": {
"type": "object",
"required": [
"id",
"name",
"slug",
"isDemo",
"teamId",
"createTime"
],
"properties": {
"createTime": {
"type": "integer",
"format": "int64"
},
"devDeploymentName": {
"type": [
"string",
"null"
]
},
"id": {
"$ref": "#/components/schemas/ProjectId"
},
"isDemo": {
"type": "boolean"
},
"name": {
"$ref": "#/components/schemas/ProjectName"
},
"prodDeploymentName": {
"type": [
"string",
"null"
]
},
"slug": {
"$ref": "#/components/schemas/ProjectSlug"
},
"teamId": {
"$ref": "#/components/schemas/TeamId"
}
}
},
"ProjectId": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"ProjectName": {
"type": "string"
},
"ProjectSlug": {
"type": "string"
},
"ProvisionWorkOSTeamRequest": {
"type": "object",
"required": [
"teamId",
"email"
],
"properties": {
"email": {
"type": "string",
"description": "Email address to use for the WorkOS team admin,\nmust be a verified email address associated with the user's account"
},
"teamId": {
"$ref": "#/components/schemas/TeamId",
"description": "Convex team ID, no WorkOS team exists at this point"
}
}
},
"ReferralCode": {
"type": "string"
},
"Team": {
"type": "object",
"required": [
"id",
"name",
"slug",
"suspended",
"referralCode"
],
"properties": {
"creator": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/MemberId"
}
]
},
"id": {
"$ref": "#/components/schemas/TeamId"
},
"managedBy": {
"type": [
"string",
"null"
]
},
"name": {
"$ref": "#/components/schemas/TeamName"
},
"referralCode": {
"$ref": "#/components/schemas/ReferralCode"
},
"referredBy": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/TeamId"
}
]
},
"slug": {
"$ref": "#/components/schemas/TeamSlug"
},
"suspended": {
"type": "boolean"
}
}
},
"TeamId": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"TeamName": {
"type": "string"
},
"TeamSlug": {
"type": "string"
}
}
}
}