Uploaded image for project: 'SonarQube'
  1. SonarQube
  2. SONAR-7968

Create /api/settings/list_definitions WS

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 6.1
    • Component/s: Settings, Web API
    • Labels:

      Description

      Return all properties definitions.
      The WS will be internal in 6.1, to be sure it's answering to all needs.

      Definition

      • componentKey[Id] : if set, return only properties applicable for given component, otherwise return global properties

      Example of result

      {
        "definitions": [
          {
            "key": "sonar.string",
            "deprecatedKey": "string",
            "name": "String",
            "description": "String property",
            "type": "STRING",
            "category": "general",
            "subCategory": "test",
            "multiValues": false,
            "defaultValue": "123",
            "options": [],
            "fields": []
          },
          {
            "key": "sonar.list",
            "name": "List",
            "description": "List property",
            "type": "SINGLE_SELECT_LIST",
            "category": "general",
            "subCategory": "general",
            "multiValues": false,
            "options": ["a", "b"],
            "fields": []
          },
          {
            "key": "sonar.multiValues",
            "name": "Multi values",
            "description": "Multi values property",
            "type": "STRING",
            "category": "general",
            "subCategory": "general",
            "multiValues": true,
            "options": [],
            "fields": []
          },
          {
            "key": "sonar.propertySet",
            "name": "Property Set",
            "description": "Property Set property",
            "type": "PROPERTY_SET",
            "category": "property",
            "subCategory": "set",
            "multiValues": false,
            "options": [],
            "fields": [
              {
                "key": "text",
                "name": "Text",
                "type": "TEXT",
                "indicativeSize": 10,
                "options": []
              },
              {
                "key": "list",
                "name": "List",
                "type": "SINGLE_SELECT_LIST",
                "indicativeSize": 20,
                "options": ["value1", "value2"]
              }
            ]
          }
        ]
      }
      

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              julien.lancelot Julien Lancelot
              Reporter:
              julien.lancelot Julien Lancelot
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Dates

                Due:
                Created:
                Updated:
                Resolved: