source.dussan.org Git - sonarqube.git/blob

   1 {
   2   "webServices": [
   3     {
   4       "path": "api/metric",
   5       "since": "3.2",
   6       "description": "Metrics",
   7       "actions": [
   8         {
   9           "key": "create",
  10           "description": "Create metric",
  11           "since": "4.1",
  12           "internal": false,
  13           "post": true,
  14           "hasResponseExample": true,
  15           "params": [
  16             {
  17               "key": "constrained_numeric_param",
  18               "required": false,
  19               "internal": false,
  20               "maximumValue": 12
  21             },
  22             {
  23               "key": "constrained_string_param",
  24               "required": false,
  25               "internal": false,
  26               "maximumLength": 64,
  27               "minimumLength": 3
  28             },
  29             {
  30               "key": "name",
  31               "required": false,
  32               "internal": false
  33             },
  34             {
  35               "key": "severity",
  36               "description": "Severity",
  37               "required": false,
  38               "internal": false,
  39               "defaultValue": "BLOCKER",
  40               "exampleValue": "INFO",
  41               "possibleValues": [
  42                 "BLOCKER",
  43                 "INFO"
  44               ]
  45             },
  46             {
  47               "key": "internal",
  48               "required": false,
  49               "internal": true
  50             }
  51           ]
  52         },
  53         {
  54           "key": "internal_action",
  55           "since": "5.3",
  56           "internal": true,
  57           "post": false,
  58           "hasResponseExample": true
  59         },
  60         {
  61           "key": "show",
  62           "since": "3.2",
  63           "internal": false,
  64           "post": false,
  65           "hasResponseExample": true
  66         }
  67       ]
  68     },
  69     {
  70       "path": "api/webservices",
  71       "description": "Get information on the web api supported on this instance.",
  72       "since": "4.2",
  73       "actions": [
  74         {
  75           "key": "list",
  76           "since": "4.2",
  77           "description": "List web services",
  78           "internal": false,
  79           "post": false,
  80           "hasResponseExample": true,
  81           "params": [
  82             {
  83               "key": "include_internals",
  84               "description": "Include web services that are implemented for internal use only. Their forward-compatibility is not assured",
  85               "required": false,
  86               "internal": false,
  87               "defaultValue": "false",
  88               "possibleValues": [
  89                 "true",
  90                 "false",
  91                 "yes",
  92                 "no"
  93               ]
  94             }
  95           ]
  96         },
  97         {
  98           "key": "response_example",
  99           "since": "4.4",
 100           "description": "Display web service response example",
 101           "internal": false,
 102           "post": false,
 103           "hasResponseExample": true,
 104           "params": [
 105             {
 106               "key": "action",
 107               "required": true,
 108               "internal": false,
 109               "description": "Action of the web service",
 110               "exampleValue": "search"
 111             },
 112             {
 113               "key": "controller",
 114               "required": true,
 115               "internal": false,
 116               "description": "Controller of the web service",
 117               "exampleValue": "api/issues"
 118             }
 119           ]
 120         }
 121       ]
 122     }
 123   ]
 124 }