diff options
Diffstat (limited to 'data/iot/2017-06-20/api-docs.php')
| -rw-r--r-- | data/iot/2017-06-20/api-docs.php | 413 |
1 files changed, 413 insertions, 0 deletions
diff --git a/data/iot/2017-06-20/api-docs.php b/data/iot/2017-06-20/api-docs.php new file mode 100644 index 0000000..ec7d420 --- /dev/null +++ b/data/iot/2017-06-20/api-docs.php @@ -0,0 +1,413 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'ROA', + 'product' => 'Iot', + 'version' => '2017-06-20', + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'BatchGetDeviceState' => [ + 'path' => '/batchGetDeviceState/{ProductKey}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'parameters' => [ + [ + 'name' => 'ProductKey', + 'in' => 'path', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'required' => true, + 'items' => [ + 'type' => 'string', + ], + 'maxItems' => 51, + ], + ], + ], + ], + 'GetDeviceShadow' => [ + 'path' => '/getDeviceShadow/{ProductKey}/{DeviceName}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'parameters' => [ + [ + 'name' => 'ProductKey', + 'in' => 'path', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'path', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'ShadowMessage', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + ], + 'GetCats' => [ + 'path' => '/getCats/{RootId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'parameters' => [ + [ + 'name' => 'RootId', + 'in' => 'path', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + ], + ], + ], + ], + 'Pub' => [ + 'path' => '/pub/{ProductKey}', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'parameters' => [ + [ + 'name' => 'ProductKey', + 'in' => 'path', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Qos', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enum' => [ + '0', + '1', + ], + ], + ], + [ + 'name' => 'TopicFullName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'MessageContent', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + ], + 'PubBroadcast' => [ + 'path' => '/pubBroadcast/{ProductKey}', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'parameters' => [ + [ + 'name' => 'ProductKey', + 'in' => 'path', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'TopicFullName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'MessageContent', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + ], + 'QueryApplyStatus' => [ + 'path' => '/queryApplyStatus/{ApplyId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'parameters' => [ + [ + 'name' => 'ApplyId', + 'in' => 'path', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + ], + ], + ], + ], + 'QueryDevice' => [ + 'path' => '/queryDevice/{ProductKey}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'ProductKey', + 'in' => 'path', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + ], + ], + 'QueryDeviceByName' => [ + 'path' => '/queryDeviceByName/{DeviceName}/{ProductKey}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'parameters' => [ + [ + 'name' => 'ProductKey', + 'in' => 'path', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'path', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + ], + 'RegistDevice' => [ + 'path' => '/registDevice/{ProductKey}', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'parameters' => [ + [ + 'name' => 'ProductKey', + 'in' => 'path', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + ], + 'UpdateDeviceShadow' => [ + 'path' => '/updateDeviceShadow/{ProductKey}/{DeviceName}', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'parameters' => [ + [ + 'name' => 'ProductKey', + 'in' => 'path', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'path', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'ShadowMessage', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'iot.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'iot.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'iot.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'iot.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'iot.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'iot.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'iot.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'iot.eu-central-1.aliyuncs.com', + ], + ], +]; |