summaryrefslogtreecommitdiff
path: root/data/sophonsoar/2025-09-03/api-docs.php
diff options
context:
space:
mode:
Diffstat (limited to 'data/sophonsoar/2025-09-03/api-docs.php')
-rw-r--r--data/sophonsoar/2025-09-03/api-docs.php968
1 files changed, 968 insertions, 0 deletions
diff --git a/data/sophonsoar/2025-09-03/api-docs.php b/data/sophonsoar/2025-09-03/api-docs.php
new file mode 100644
index 0000000..feb980c
--- /dev/null
+++ b/data/sophonsoar/2025-09-03/api-docs.php
@@ -0,0 +1,968 @@
+<?php return [
+ 'version' => '1.0',
+ 'info' => [
+ 'style' => 'RPC',
+ 'product' => 'sophonsoar',
+ 'version' => '2025-09-03',
+ ],
+ 'components' => [
+ 'schemas' => [
+ 'FieldInputConfig' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'FieldName' => [
+ 'type' => 'string',
+ ],
+ 'FieldType' => [
+ 'type' => 'string',
+ ],
+ 'DefaultValue' => [
+ 'type' => 'string',
+ ],
+ 'Required' => [
+ 'type' => 'boolean',
+ ],
+ 'Arrayed' => [
+ 'type' => 'boolean',
+ ],
+ 'FieldPath' => [
+ 'type' => 'string',
+ ],
+ 'FieldCheckRegex' => [
+ 'type' => 'string',
+ ],
+ 'FieldExample' => [
+ 'type' => 'string',
+ ],
+ 'FieldClass' => [
+ 'type' => 'string',
+ ],
+ 'FieldDescription' => [
+ 'type' => 'string',
+ ],
+ 'FieldConfigs' => [
+ 'type' => 'array',
+ 'items' => [
+ '$ref' => '#/components/schemas/FieldInputConfig',
+ ],
+ ],
+ ],
+ ],
+ 'FieldOutputConfig' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'FieldName' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'FieldType' => [
+ 'type' => 'string',
+ ],
+ 'FieldDescription' => [
+ 'type' => 'string',
+ ],
+ 'DefaultValue' => [
+ 'type' => 'string',
+ ],
+ 'FieldExample' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'apis' => [
+ 'ListComponents' => [
+ 'path' => '',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'parameters' => [
+ [
+ 'name' => 'Lang',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'RoleFor',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'ComponentName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ ],
+ ],
+ 'CreateComponentAsset' => [
+ 'path' => '',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'parameters' => [
+ [
+ 'name' => 'ComponentName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'ComponentAssetName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'Lang',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'ComponentAssetValues',
+ 'in' => 'formData',
+ 'style' => 'flat',
+ 'schema' => [
+ 'type' => 'array',
+ 'required' => true,
+ 'items' => [
+ 'type' => 'object',
+ 'required' => false,
+ 'properties' => [
+ 'FieldName' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'FieldValue' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ ],
+ ],
+ ],
+ [
+ 'name' => 'RoleFor',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ ],
+ ],
+ ],
+ ],
+ 'DeleteComponentAsset' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'parameters' => [
+ [
+ 'name' => 'Lang',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'RoleFor',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'ComponentAssetUuid',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ ],
+ ],
+ 'UpdateComponentAsset' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'parameters' => [
+ [
+ 'name' => 'Lang',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'ComponentAssetUuid',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'ComponentAssetValues',
+ 'in' => 'formData',
+ 'style' => 'flat',
+ 'schema' => [
+ 'type' => 'array',
+ 'required' => false,
+ 'items' => [
+ 'type' => 'object',
+ 'required' => false,
+ 'properties' => [
+ 'FieldName' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'FieldValue' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ ],
+ ],
+ ],
+ [
+ 'name' => 'RoleFor',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'ComponentAssetName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ ],
+ ],
+ 'ListComponentAssets' => [
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'parameters' => [
+ [
+ 'name' => 'Lang',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'RoleFor',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'ComponentName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'ComponentAssetUuid',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ ],
+ ],
+ 'GetPlaybook' => [
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'parameters' => [
+ [
+ 'name' => 'Lang',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'RoleFor',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'PlaybookUuid',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'PlaybookVersionType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'PlaybookVersion',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ ],
+ ],
+ 'ListPlaybooks' => [
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'parameters' => [
+ [
+ 'name' => 'Lang',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'RoleFor',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'minimum' => '1',
+ 'maximum' => '100',
+ ],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'PlaybookStatus',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'PlaybookUuids',
+ 'in' => 'formData',
+ 'style' => 'simple',
+ 'schema' => [
+ 'type' => 'array',
+ 'deprecated' => false,
+ 'required' => false,
+ 'items' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'minItems' => 0,
+ 'maxItems' => 1,
+ ],
+ ],
+ [
+ 'name' => 'PlaybookName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'PlaybookParamTypes',
+ 'in' => 'formData',
+ 'style' => 'simple',
+ 'schema' => [
+ 'type' => 'array',
+ 'required' => false,
+ 'items' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ ],
+ [
+ 'name' => 'PlaybookExecutionStartTime',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'PlaybookExecutionEndTime',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'OrderField',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'Order',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'PlaybookType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ ],
+ ],
+ 'CreatePlaybook' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'parameters' => [
+ [
+ 'name' => 'Lang',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'RoleFor',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'PlaybookName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ 'minLength' => 2,
+ 'maxLength' => 128,
+ ],
+ ],
+ [
+ 'name' => 'PlaybookDescription',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ 'minLength' => 0,
+ 'maxLength' => 512,
+ ],
+ ],
+ [
+ 'name' => 'PlaybookInputConfigs',
+ 'in' => 'formData',
+ 'style' => 'flat',
+ 'schema' => [
+ 'type' => 'array',
+ 'required' => false,
+ 'items' => [
+ '$ref' => '#/components/schemas/FieldInputConfig',
+ 'required' => false,
+ ],
+ ],
+ ],
+ [
+ 'name' => 'PlaybookOutputConfigs',
+ 'in' => 'formData',
+ 'style' => 'flat',
+ 'schema' => [
+ 'type' => 'array',
+ 'required' => false,
+ 'items' => [
+ '$ref' => '#/components/schemas/FieldOutputConfig',
+ 'required' => false,
+ ],
+ ],
+ ],
+ [
+ 'name' => 'SrcPlaybookUuid',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'PlaybookTaskFlow',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'PlaybookParamType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ ],
+ ],
+ 'DeletePlaybook' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'parameters' => [
+ [
+ 'name' => 'Lang',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'RoleFor',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'PlaybookUuid',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ ],
+ ],
+ 'UpdatePlaybook' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'parameters' => [
+ [
+ 'name' => 'Lang',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'RoleFor',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'PlaybookName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'PlaybookDescription',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'PlaybookInputConfigs',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'type' => 'array',
+ 'required' => false,
+ 'items' => [
+ '$ref' => '#/components/schemas/FieldInputConfig',
+ 'required' => false,
+ ],
+ ],
+ ],
+ [
+ 'name' => 'PlaybookOutputConfigs',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'type' => 'array',
+ 'required' => false,
+ 'items' => [
+ '$ref' => '#/components/schemas/FieldOutputConfig',
+ 'required' => false,
+ ],
+ ],
+ ],
+ [
+ 'name' => 'PlaybookTaskFlow',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'PlaybookParamType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'PlaybookUuid',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ ],
+ ],
+ 'ExecuteComponent' => [
+ 'path' => '',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'parameters' => [
+ [
+ 'name' => 'PlaybookUuid',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'PlayBookNodeName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'ComponentName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'ComponentActionName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'ComponentAssetUuid',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'ComponentInput',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'Lang',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'endpoints' => [
+ [
+ 'regionId' => 'public',
+ 'endpoint' => 'sophonsoar.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-southeast-1',
+ 'endpoint' => 'sophonsoar.ap-southeast-1.aliyuncs.com',
+ ],
+ ],
+];
generated by cgit v1.2.3 (git 2.46.0) at 2026-03-07 15:22:53 +0000