org.sonar.server.ws.list-example.json Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-server Show documentation
There is a newer version: 7.2.1
{
  "webServices": [
    {
      "path": "api/metric",
      "since": "3.2",
      "description": "Metrics",
      "actions": [
        {
          "key": "create",
          "description": "Create metric",
          "since": "4.1",
          "deprecatedSince": "5.3",
          "internal": false,
          "post": true,
          "hasResponseExample": true,
          "params": [
            {
              "key": "name",
              "required": false
            },
            {
              "key": "severity",
              "description": "Severity",
              "required": false,
              "defaultValue": "BLOCKER",
              "exampleValue": "INFO",
              "since": "4.4",
              "deprecatedSince": "5.2",
              "possibleValues": [
                "BLOCKER",
                "INFO"
              ]
            }
          ]
        },
        {
          "key": "show",
          "since": "3.2",
          "internal": false,
          "post": false,
          "hasResponseExample": true
        }
      ]
    },
    {
      "path": "api/webservices",
      "description": "List web services",
      "since": "4.2",
      "actions": [
        {
          "key": "list",
          "since": "4.2",
          "description": "List web services",
          "internal": false,
          "post": false,
          "hasResponseExample": true,
          "params": [
            {
              "key": "include_internals",
              "description": "Include web services that are implemented for internal use only. Their forward-compatibility is not assured",
              "required": false,
              "defaultValue": "false",
              "possibleValues": [
                "true",
                "false",
                "yes",
                "no"
              ]
            }
          ]
        },
        {
          "key": "response_example",
          "since": "4.4",
          "description": "Display web service response example",
          "internal": false,
          "post": false,
          "hasResponseExample": true,
          "params": [
            {
              "key": "action",
              "required": true,
              "description": "Action of the web service",
              "exampleValue": "search"
            },
            {
              "key": "controller",
              "required": true,
              "description": "Controller of the web service",
              "exampleValue": "api/issues"
            }
          ]
        }
      ]
    }
  ]
}