inspector/scripts/tests/commands-with-async-attribute.json

   1 {
   2     "domain": "Database",
   3     "types": [
   4         {
   5             "id": "DatabaseId",
   6             "type": "integer",
   7             "description": "Unique identifier of Database object."
   8         },
   9         {
  10             "id": "PrimaryColors",
  11             "type": "string",
  12             "enum": ["red", "green", "blue"]
  13         },
  14         {
  15             "id": "ColorList",
  16             "type": "array",
  17             "items": { "$ref": "PrimaryColors" }
  18         },
  19         {
  20             "id": "Error",
  21             "type": "object",
  22             "description": "Database error.",
  23             "properties": [
  24                 { "name": "message", "type": "string", "description": "Error message." },
  25                 { "name": "code", "type": "integer", "description": "Error code." }
  26             ]
  27         }
  28     ],
  29     "commands": [
  30         {
  31             "name": "executeSQLSyncOptionalReturnValues",
  32             "parameters": [
  33                 { "name": "databaseId", "$ref": "DatabaseId" },
  34                 { "name": "query", "type": "string" }
  35             ],
  36             "returns": [
  37                 { "name": "columnNames", "type": "array", "optional": true, "items": { "type": "string" } },
  38                 { "name": "notes", "type": "string", "optional": true },
  39                 { "name": "timestamp", "type": "number", "optional": true },
  40                 { "name": "values", "type": "object", "optional": true },
  41                 { "name": "payload", "type": "any", "optional": true },
  42                 { "name": "databaseId", "$ref": "DatabaseId", "optional": true },
  43                 { "name": "sqlError", "$ref": "Error", "optional": true },
  44                 { "name": "screenColor", "$ref": "PrimaryColors", "optional": true },
  45                 { "name": "alternateColors", "$ref": "ColorList", "optional": true },
  46                 { "name": "printColor", "type": "string", "enum": ["cyan", "magenta", "yellow", "black"], "optional": true }
  47             ]
  48         },
  49         {
  50             "name": "executeSQLAsyncOptionalReturnValues",
  51             "async": true,
  52             "parameters": [
  53                 { "name": "databaseId", "$ref": "DatabaseId" },
  54                 { "name": "query", "type": "string" }
  55             ],
  56             "returns": [
  57                 { "name": "columnNames", "type": "array", "optional": true, "items": { "type": "string" } },
  58                 { "name": "notes", "type": "string", "optional": true },
  59                 { "name": "timestamp", "type": "number", "optional": true },
  60                 { "name": "values", "type": "object", "optional": true },
  61                 { "name": "payload", "type": "any", "optional": true },
  62                 { "name": "databaseId", "$ref": "DatabaseId", "optional": true },
  63                 { "name": "sqlError", "$ref": "Error", "optional": true },
  64                 { "name": "screenColor", "$ref": "PrimaryColors", "optional": true },
  65                 { "name": "alternateColors", "$ref": "ColorList", "optional": true },
  66                 { "name": "printColor", "type": "string", "enum": ["cyan", "magenta", "yellow", "black"], "optional": true }
  67             ]
  68         },
  69         {
  70             "name": "executeSQLSync",
  71             "parameters": [
  72                 { "name": "databaseId", "$ref": "DatabaseId" },
  73                 { "name": "query", "type": "string" }
  74             ],
  75             "returns": [
  76                 { "name": "columnNames", "type": "array", "items": { "type": "string" } },
  77                 { "name": "notes", "type": "string" },
  78                 { "name": "timestamp", "type": "number" },
  79                 { "name": "values", "type": "object" },
  80                 { "name": "payload", "type": "any" },
  81                 { "name": "databaseId", "$ref": "DatabaseId" },
  82                 { "name": "sqlError", "$ref": "Error" },
  83                 { "name": "alternateColors", "$ref": "ColorList" },
  84                 { "name": "screenColor", "$ref": "PrimaryColors" },
  85                 { "name": "printColor", "type": "string", "enum": ["cyan", "magenta", "yellow", "black"] }
  86             ]
  87         },
  88         {
  89             "name": "executeSQLAsync",
  90             "async": true,
  91             "parameters": [
  92                 { "name": "databaseId", "$ref": "DatabaseId" },
  93                 { "name": "query", "type": "string" }
  94             ],
  95             "returns": [
  96                 { "name": "columnNames", "type": "array", "items": { "type": "string" } },
  97                 { "name": "notes", "type": "string" },
  98                 { "name": "timestamp", "type": "number" },
  99                 { "name": "values", "type": "object" },
 100                 { "name": "payload", "type": "any" },
 101                 { "name": "databaseId", "$ref": "DatabaseId" },
 102                 { "name": "sqlError", "$ref": "Error" },
 103                 { "name": "screenColor", "$ref": "PrimaryColors" },
 104                 { "name": "alternateColors", "$ref": "ColorList" },
 105                 { "name": "printColor", "type": "string", "enum": ["cyan", "magenta", "yellow", "black"] }
 106             ]
 107         }
 108     ]
 109 }