first commitHEADv1.0.0+20260212main

1 files changed, 506 insertions, 0 deletions

diff --git a/data/en_us/paiplugin/2021-03-19/api-docs.php b/data/en_us/paiplugin/2021-03-19/api-docs.php
new file mode 100644
index 0000000..00bb06a
--- /dev/null
+++ b/data/en_us/paiplugin/2021-03-19/api-docs.php
@@ -0,0 +1,506 @@
+<?php return [
+    'version' => '1.0',
+    'info' => [
+        'style' => 'ROA',
+        'product' => 'PaiPlugin',
+        'version' => '2021-03-19',
+    ],
+    'directories' => [
+        [
+            'id' => 0,
+            'title' => '其它',
+            'type' => 'directory',
+            'children' => [
+                'ListSchedules',
+                'ListTemplates',
+                'GetVersion',
+                'ListSignatures',
+                'GetHealth',
+            ],
+        ],
+    ],
+    'components' => [
+        'schemas' => [],
+    ],
+    'apis' => [
+        'ListSchedules' => [
+            'summary' => 'ListSchedules',
+            'path' => '/api/v1/schedules',
+            'methods' => [
+                'get',
+            ],
+            'schemes' => [
+                'http',
+                'https',
+            ],
+            'security' => [
+                [
+                    'AK' => [],
+                ],
+            ],
+            'produces' => [
+                'application/json',
+            ],
+            'operationType' => 'readAndWrite',
+            'deprecated' => false,
+            'parameters' => [
+                [
+                    'name' => 'Name',
+                    'in' => 'query',
+                    'schema' => [
+                        'title' => '发送计划名称，用于检查是否重复',
+                        'type' => 'string',
+                        'example' => '用户增长',
+                    ],
+                ],
+                [
+                    'name' => 'PageNumber',
+                    'in' => 'query',
+                    'schema' => [
+                        'title' => '分页数，从1开始，默认为1',
+                        'type' => 'integer',
+                        'format' => 'int32',
+                        'example' => '1',
+                    ],
+                ],
+                [
+                    'name' => 'PageSize',
+                    'in' => 'query',
+                    'schema' => [
+                        'title' => '分页大小，默认为10',
+                        'type' => 'integer',
+                        'format' => 'int32',
+                        'example' => '10',
+                    ],
+                ],
+            ],
+            'responses' => [
+                200 => [
+                    'schema' => [
+                        'title' => '成功',
+                        'type' => 'object',
+                        'properties' => [
+                            'Data' => [
+                                'type' => 'array',
+                                'items' => [
+                                    'type' => 'object',
+                                    'properties' => [
+                                        'CreatedTime' => [
+                                            'title' => '创建时间 (UTC)',
+                                            'type' => 'string',
+                                            'example' => '2020-01-01 12:00:00',
+                                        ],
+                                        'ID' => [
+                                            'title' => 'ID UUID',
+                                            'type' => 'string',
+                                            'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
+                                        ],
+                                        'Name' => [
+                                            'title' => '发送计划名称',
+                                            'type' => 'string',
+                                            'example' => '20200101发送',
+                                        ],
+                                        'SendTime' => [
+                                            'title' => '发布时间 (UTC)',
+                                            'type' => 'string',
+                                            'example' => '2020-01-01 12:00:00',
+                                        ],
+                                        'UpdatedTime' => [
+                                            'title' => '更新时间 (UTC)',
+                                            'type' => 'string',
+                                            'example' => '2020-01-01 12:00:00',
+                                        ],
+                                    ],
+                                ],
+                            ],
+                            'ErrorCode' => [
+                                'type' => 'integer',
+                                'format' => 'int32',
+                                'example' => '0',
+                            ],
+                            'ErrorMessage' => [
+                                'type' => 'string',
+                                'example' => 'OK',
+                            ],
+                        ],
+                    ],
+                ],
+                400 => [
+                    'schema' => [
+                        'title' => '失败,原因见errmsg',
+                        'type' => 'object',
+                        'properties' => [
+                            'Data' => [
+                                'type' => 'string',
+                            ],
+                            'ErrorCode' => [
+                                'type' => 'integer',
+                                'format' => 'int32',
+                                'example' => '0',
+                            ],
+                            'ErrorMessage' => [
+                                'type' => 'string',
+                                'example' => 'OK',
+                            ],
+                        ],
+                    ],
+                ],
+            ],
+        ],
+        'ListTemplates' => [
+            'summary' => 'ListTemplates',
+            'path' => '/api/v1/templates',
+            'methods' => [
+                'get',
+            ],
+            'schemes' => [
+                'http',
+                'https',
+            ],
+            'security' => [
+                [
+                    'AK' => [],
+                ],
+            ],
+            'produces' => [
+                'application/json',
+            ],
+            'operationType' => 'readAndWrite',
+            'deprecated' => false,
+            'parameters' => [
+                [
+                    'name' => 'Name',
+                    'in' => 'query',
+                    'schema' => [
+                        'title' => '模板名称，用于检查模板唯一性',
+                        'type' => 'string',
+                        'example' => '用户增长',
+                    ],
+                ],
+                [
+                    'name' => 'PageNumber',
+                    'in' => 'query',
+                    'schema' => [
+                        'title' => '分页数，从1开始，默认为1',
+                        'type' => 'integer',
+                        'format' => 'int32',
+                        'example' => '1',
+                    ],
+                ],
+                [
+                    'name' => 'PageSize',
+                    'in' => 'query',
+                    'schema' => [
+                        'title' => '分页大小，默认为10',
+                        'type' => 'integer',
+                        'format' => 'int32',
+                        'example' => '10',
+                    ],
+                ],
+            ],
+            'responses' => [
+                200 => [
+                    'schema' => [
+                        'title' => '成功',
+                        'type' => 'object',
+                        'properties' => [
+                            'Data' => [
+                                'type' => 'array',
+                                'items' => [
+                                    'type' => 'object',
+                                    'properties' => [
+                                        'CreatedTime' => [
+                                            'title' => '创建时间 (UTC)',
+                                            'type' => 'string',
+                                            'example' => '2020-01-01 12:00:00',
+                                        ],
+                                        'ID' => [
+                                            'title' => 'ID UUID',
+                                            'type' => 'string',
+                                            'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
+                                        ],
+                                        'Name' => [
+                                            'title' => '签名名称',
+                                            'type' => 'string',
+                                            'example' => '用户增长',
+                                        ],
+                                        'Status' => [
+                                            'title' => '审核状态'."\n"
+                                                .'- 0 : Reviewing'."\n"
+                                                .'- 1 : Passed'."\n"
+                                                .'- 2 : Rejected',
+                                            'type' => 'integer',
+                                            'format' => 'int32',
+                                            'example' => '0',
+                                        ],
+                                        'TemplateCode' => [
+                                            'title' => '模板Code',
+                                            'type' => 'string',
+                                            'example' => 'SMS_123456',
+                                        ],
+                                        'UpdatedTime' => [
+                                            'title' => '更新时间 (UTC)',
+                                            'type' => 'string',
+                                            'example' => '2020-01-01 12:00:00',
+                                        ],
+                                    ],
+                                ],
+                            ],
+                            'ErrorCode' => [
+                                'type' => 'integer',
+                                'format' => 'int32',
+                                'example' => '0',
+                            ],
+                            'ErrorMessage' => [
+                                'type' => 'string',
+                                'example' => 'OK',
+                            ],
+                        ],
+                    ],
+                ],
+                400 => [
+                    'schema' => [
+                        'title' => '失败,原因见errmsg',
+                        'type' => 'object',
+                        'properties' => [
+                            'Data' => [
+                                'type' => 'string',
+                            ],
+                            'ErrorCode' => [
+                                'type' => 'integer',
+                                'format' => 'int32',
+                                'example' => '0',
+                            ],
+                            'ErrorMessage' => [
+                                'type' => 'string',
+                                'example' => 'OK',
+                            ],
+                        ],
+                    ],
+                ],
+            ],
+        ],
+        'GetVersion' => [
+            'summary' => 'GetVersion',
+            'path' => '/api/v1/version',
+            'methods' => [
+                'get',
+            ],
+            'schemes' => [
+                'http',
+                'https',
+            ],
+            'security' => [
+                [
+                    'AK' => [],
+                ],
+            ],
+            'produces' => [
+                'application/json',
+            ],
+            'operationType' => 'readAndWrite',
+            'deprecated' => false,
+            'parameters' => [],
+            'responses' => [
+                200 => [
+                    'schema' => [
+                        'title' => '1.0',
+                        'type' => 'object',
+                        'properties' => [
+                            'Data' => [
+                                'type' => 'string',
+                            ],
+                            'ErrorCode' => [
+                                'type' => 'integer',
+                                'format' => 'int32',
+                                'example' => '0',
+                            ],
+                            'ErrorMessage' => [
+                                'type' => 'string',
+                                'example' => 'OK',
+                            ],
+                        ],
+                    ],
+                ],
+            ],
+        ],
+        'ListSignatures' => [
+            'summary' => 'ListSignatures',
+            'path' => '/api/v1/signatures',
+            'methods' => [
+                'get',
+            ],
+            'schemes' => [
+                'http',
+                'https',
+            ],
+            'security' => [
+                [
+                    'AK' => [],
+                ],
+            ],
+            'produces' => [
+                'application/json',
+            ],
+            'operationType' => 'readAndWrite',
+            'deprecated' => false,
+            'parameters' => [
+                [
+                    'name' => 'Name',
+                    'in' => 'query',
+                    'schema' => [
+                        'title' => '签名名称，用于检查签名唯一性',
+                        'type' => 'string',
+                        'example' => '用户增长',
+                    ],
+                ],
+                [
+                    'name' => 'PageNumber',
+                    'in' => 'query',
+                    'schema' => [
+                        'title' => '分页数，从1开始，默认为1',
+                        'type' => 'integer',
+                        'format' => 'int32',
+                        'example' => '1',
+                    ],
+                ],
+                [
+                    'name' => 'PageSize',
+                    'in' => 'query',
+                    'schema' => [
+                        'title' => '分页大小，默认为10',
+                        'type' => 'integer',
+                        'format' => 'int32',
+                        'example' => '10',
+                    ],
+                ],
+            ],
+            'responses' => [
+                200 => [
+                    'schema' => [
+                        'title' => '成功',
+                        'type' => 'object',
+                        'properties' => [
+                            'Data' => [
+                                'type' => 'array',
+                                'items' => [
+                                    'type' => 'object',
+                                    'properties' => [
+                                        'CreatedTime' => [
+                                            'title' => '创建时间 (UTC)',
+                                            'type' => 'string',
+                                            'example' => '2020-01-01 12:00:00',
+                                        ],
+                                        'ID' => [
+                                            'title' => 'ID UUID',
+                                            'type' => 'string',
+                                            'example' => '0a54e195-03e2-40bd-869d-b71cb302783e',
+                                        ],
+                                        'Name' => [
+                                            'title' => '签名名称',
+                                            'type' => 'string',
+                                            'example' => '用户增长',
+                                        ],
+                                        'Status' => [
+                                            'title' => '审核状态'."\n"
+                                                .'- 0 : Reviewing'."\n"
+                                                .'- 1 : Passed'."\n"
+                                                .'- 2 : Rejected',
+                                            'type' => 'integer',
+                                            'format' => 'int32',
+                                            'example' => '0',
+                                        ],
+                                        'UpdatedTime' => [
+                                            'title' => '更新时间 (UTC)',
+                                            'type' => 'string',
+                                            'example' => '2020-01-01 12:00:00',
+                                        ],
+                                    ],
+                                ],
+                            ],
+                            'ErrorCode' => [
+                                'type' => 'integer',
+                                'format' => 'int32',
+                                'example' => '0',
+                            ],
+                            'ErrorMessage' => [
+                                'type' => 'string',
+                                'example' => 'OK',
+                            ],
+                        ],
+                    ],
+                ],
+                400 => [
+                    'schema' => [
+                        'title' => '失败,原因见errmsg',
+                        'type' => 'object',
+                        'properties' => [
+                            'Data' => [
+                                'type' => 'string',
+                            ],
+                            'ErrorCode' => [
+                                'type' => 'integer',
+                                'format' => 'int32',
+                                'example' => '0',
+                            ],
+                            'ErrorMessage' => [
+                                'type' => 'string',
+                                'example' => 'OK',
+                            ],
+                        ],
+                    ],
+                ],
+            ],
+        ],
+        'GetHealth' => [
+            'summary' => 'GetHealth',
+            'path' => '/api/v1/',
+            'methods' => [
+                'get',
+            ],
+            'schemes' => [
+                'http',
+                'https',
+            ],
+            'security' => [
+                [
+                    'AK' => [],
+                ],
+            ],
+            'produces' => [
+                'application/json',
+            ],
+            'operationType' => 'readAndWrite',
+            'deprecated' => false,
+            'parameters' => [],
+            'responses' => [
+                200 => [
+                    'schema' => [
+                        'title' => 'alive',
+                        'type' => 'object',
+                        'properties' => [
+                            'Data' => [
+                                'type' => 'string',
+                            ],
+                            'ErrorCode' => [
+                                'type' => 'integer',
+                                'format' => 'int32',
+                                'example' => '0',
+                            ],
+                            'ErrorMessage' => [
+                                'type' => 'string',
+                                'example' => 'OK',
+                            ],
+                        ],
+                    ],
+                ],
+            ],
+        ],
+    ],
+    'endpoints' => [
+        [
+            'regionId' => 'cn-hangzhou',
+            'endpoint' => 'paiplugin.cn-hangzhou.aliyuncs.com',
+        ],
+    ],
+];