Skip to content

armgit / kaneo

Public Imported from GitHub
0

⚡ Project management that doesn't become the project. Boards, Gantt charts, and GitHub integration. Self-host it or use Kaneo Cloud.

fix: outdated openapi.json

LAZIC Erwanca70c72c4ed5
diff --git a/apps/docs/openapi.json b/apps/docs/openapi.json
index b3bbacde6..f4f27f221 100644
--- a/apps/docs/openapi.json
+++ b/apps/docs/openapi.json
@@ -763,6 +763,24 @@
"createdAt": {
"type": "string",
"format": "date-time"
+ },
+ "customFields": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "fieldId": {
+ "type": "string"
+ },
+ "value": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "fieldId",
+ "value"
+ ]
+ }
}
},
"required": [
@@ -3114,6 +3132,147 @@
"role"
]
},
+ "CustomFieldDefinition": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "projectId": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "required": {
+ "type": "boolean"
+ },
+ "defaultValue": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "options": {},
+ "position": {
+ "type": "number"
+ },
+ "createdAt": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "updatedAt": {
+ "type": "string",
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "id",
+ "projectId",
+ "name",
+ "type",
+ "required",
+ "defaultValue",
+ "position",
+ "createdAt",
+ "updatedAt"
+ ]
+ },
+ "CustomFieldValue": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "taskId": {
+ "type": "string"
+ },
+ "fieldId": {
+ "type": "string"
+ },
+ "value": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "fieldName": {
+ "type": "string"
+ },
+ "fieldPosition": {
+ "type": "number"
+ },
+ "fieldType": {
+ "type": "string"
+ },
+ "fieldOptions": {}
+ },
+ "required": [
+ "id",
+ "taskId",
+ "fieldId",
+ "value",
+ "fieldName",
+ "fieldPosition",
+ "fieldType"
+ ]
+ },
+ "CustomFieldFilterValues": {
+ "type": "object",
+ "properties": {
+ "fieldId": {
+ "type": "string"
+ },
+ "fieldName": {
+ "type": "string"
+ },
+ "fieldType": {
+ "type": "string"
+ },
+ "values": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "fieldId",
+ "fieldName",
+ "fieldType",
+ "values"
+ ]
+ },
+ "ReorderCustomFieldsResponse": {},
+ "SetCustomFieldValueResponse": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "taskId": {
+ "type": "string"
+ },
+ "fieldId": {
+ "type": "string"
+ },
+ "value": {
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "taskId",
+ "fieldId",
+ "value"
+ ]
+ },
"UserAvatar": {
"type": "object",
"properties": {
@@ -6405,6 +6564,24 @@
"userId": {
"type": "string",
"description": "Assignee, if any."
+ },
+ "customFields": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "fieldId": {
+ "type": "string"
+ },
+ "value": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "fieldId",
+ "value"
+ ]
+ }
}
},
"required": [
@@ -13395,6 +13572,543 @@
}
}
},
+ "/custom-field/project/{projectId}": {
+ "get": {
+ "operationId": "getCustomFieldsByProject",
+ "tags": [
+ "Custom Fields"
+ ],
+ "summary": "Get custom fields",
+ "description": "Get all custom field definitions for a project.",
+ "parameters": [
+ {
+ "schema": {
+ "type": "string"
+ },
+ "required": true,
+ "name": "projectId",
+ "in": "path"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "List of custom field definitions",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CustomFieldDefinition"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Unknown project, or its workspace could not be determined",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Missing or invalid credentials"
+ },
+ "403": {
+ "description": "No access to the project's workspace",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/custom-field/project/{projectId}/values": {
+ "get": {
+ "operationId": "getCustomFieldValuesByProject",
+ "tags": [
+ "Custom Fields"
+ ],
+ "summary": "Get project custom field values",
+ "description": "Get all custom field values for every task in a project.",
+ "parameters": [
+ {
+ "schema": {
+ "type": "string"
+ },
+ "required": true,
+ "name": "projectId",
+ "in": "path"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "List of custom field values for the project",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CustomFieldValue"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Unknown project, or its workspace could not be determined",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Missing or invalid credentials"
+ },
+ "403": {
+ "description": "No access to the project's workspace",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/custom-field/task/{taskId}": {
+ "get": {
+ "operationId": "getCustomFieldValuesByTask",
+ "tags": [
+ "Custom Fields"
+ ],
+ "summary": "Get task custom field values",
+ "description": "Get all custom field values for a task with their definitions.",
+ "parameters": [
+ {
+ "schema": {
+ "type": "string"
+ },
+ "required": true,
+ "name": "taskId",
+ "in": "path"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "List of custom field values for the task",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CustomFieldValue"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Unknown task, or its workspace could not be determined",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Missing or invalid credentials"
+ },
+ "403": {
+ "description": "No access to the task's workspace",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/custom-field/project/{projectId}/filter-values": {
+ "get": {
+ "operationId": "getCustomFieldFilterValues",
+ "tags": [
+ "Custom Fields"
+ ],
+ "summary": "Get custom field filter values",
+ "description": "Get distinct values used by tasks for each custom field of a project.",
+ "parameters": [
+ {
+ "schema": {
+ "type": "string"
+ },
+ "required": true,
+ "name": "projectId",
+ "in": "path"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Distinct values used for each custom field",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CustomFieldFilterValues"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Unknown project, or its workspace could not be determined",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Missing or invalid credentials"
+ },
+ "403": {
+ "description": "No access to the project's workspace",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/custom-field": {
+ "post": {
+ "operationId": "createCustomField",
+ "tags": [
+ "Custom Fields"
+ ],
+ "summary": "Create custom field",
+ "description": "Create a custom field definition for a project.",
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "projectId": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "text",
+ "number",
+ "date",
+ "dropdown",
+ "boolean"
+ ]
+ },
+ "required": {
+ "type": "boolean",
+ "default": false
+ },
+ "defaultValue": {
+ "type": "string"
+ },
+ "options": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "projectId",
+ "name",
+ "type"
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "The created custom field",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CustomFieldDefinition"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Invalid body, or unknown project",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Missing or invalid credentials"
+ },
+ "403": {
+ "description": "No workspace access, or missing project:update permission",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/custom-field/reorder/{projectId}": {
+ "put": {
+ "operationId": "reorderCustomFields",
+ "tags": [
+ "Custom Fields"
+ ],
+ "summary": "Reorder custom fields",
+ "description": "Set new positions for a project's custom fields.",
+ "parameters": [
+ {
+ "schema": {
+ "type": "string"
+ },
+ "required": true,
+ "name": "projectId",
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "fields": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "position": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "id",
+ "position"
+ ]
+ }
+ }
+ },
+ "required": [
+ "fields"
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "The reordered custom fields",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ReorderCustomFieldsResponse"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "A custom field does not belong to this project",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Missing or invalid credentials"
+ },
+ "403": {
+ "description": "No workspace access, or missing project:update permission",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/custom-field/value": {
+ "put": {
+ "operationId": "setCustomFieldValue",
+ "tags": [
+ "Custom Fields"
+ ],
+ "summary": "Set custom field value",
+ "description": "Create or update a custom field value for a task.",
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "taskId": {
+ "type": "string"
+ },
+ "fieldId": {
+ "type": "string"
+ },
+ "value": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "taskId",
+ "fieldId",
+ "value"
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "The saved custom field value",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SetCustomFieldValueResponse"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Invalid body, unknown task, or unknown custom field",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Missing or invalid credentials"
+ },
+ "403": {
+ "description": "No workspace access, or missing task:update permission",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/custom-field/{id}": {
+ "delete": {
+ "operationId": "deleteCustomField",
+ "tags": [
+ "Custom Fields"
+ ],
+ "summary": "Delete custom field",
+ "description": "Delete a custom field definition by ID.",
+ "parameters": [
+ {
+ "schema": {
+ "type": "string"
+ },
+ "required": true,
+ "name": "id",
+ "in": "path"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The deleted custom field",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CustomFieldDefinition"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Unknown custom field, or its workspace could not be determined",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Missing or invalid credentials"
+ },
+ "403": {
+ "description": "No workspace access, or missing project:update permission",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
"/user/avatar": {
"put": {
"operationId": "uploadUserAvatar",