/api/post-v1-projects-projectuuid-scripts-scriptuuid-documentation-5f24c28ac5
Войти
Все методы ScriptScriptController
manifest 0.0.0.118 • 19 июн. 2026 г., 10:15
POST/v1/projects/{projectUuid}/scripts/{scriptUuid}/documentationAuthenticated

POST documentation

Создаёт knowledge page и anchor cdp_script/SCRIPT/{scriptUuid}.

Operation ID
ScriptController.createDocumentation.POST.v1_projects__projectUuid__scripts__scriptUuid__documentation
Handler
cdp.gateway.cdp_gateway.company.features.script.controller.ScriptController#createDocumentation
Consumes—
Produces—
Параметры2
Request bodyScriptDocumentationCreateGatewayRequestDTO
Response bodyResponseWrapper<Object>
Request map

Маршрут и контракт запроса

POST/v1/projects/{projectUuid}/scripts/{scriptUuid}/documentation
Path segments
v1projects{projectUuid}scripts{scriptUuid}documentation
Security
isAuthenticated()
Parameters

Параметры

ИмяИсточникТипОбязательныйNullableSchema
projectUuid
pathStringДаНет—
scriptUuid
pathStringДаНет—
Request / Response

Тела запроса и ответа

Request bodyScriptDocumentationCreateGatewayRequestDTO
Nullable: Нет
ScriptDocumentationCreateGatewayRequestDTO
object • ScriptDocumentationCreateGatewayRequestDTO
title
String
required • not-null
editorJson
String
optional • nullable
renderedHtml
String
optional • nullable
plainText
String
optional • nullable
Response bodyResponseWrapper<Object>
Nullable: Нет
ResponseWrapper<Object>
object • ResponseWrapper<Object>
success
boolean
required • not-null
data
T
optional • nullable
error
CdpErrorResponse
optional • nullable • schema=CdpErrorResponse
CdpErrorResponse
object • CdpErrorResponse
errorId
String
required • not-null
code
String
required • not-null
message
String
required • not-null
details
Map<String, Object>
optional • not-null
fieldErrors
List<CdpFieldError>
optional • not-null
timestamp
long
optional • not-null
meta
Map<String, Object>
optional • not-null