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

Create new WS api/measures/component to display measures of a component

    Details

    • Type: New Feature
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 5.4
    • Component/s: Web API
    • Labels:
      None

      Description

      The goal is to display a component with its details and the provided metrics

      • URL: api/measures/component
      • Method: GET
      • Description: Show one component details with provided metrics. The componentId or componentKey parameter must be provided
      • Permissions: Requires one of the following permissions:
        • 'Administer System' permission
        • 'Administer' rights on the specified project
        • 'Browse' and 'See Source Code' on the specified project
      • Errors:
        • 404 if the component is not found
        • 400 if at least one metric from the list does not exist
      • Parameters:
        • componentId
        • componentKey
        • metricKeys: list of metric keys
      • Response fields:
        • component:
          • id: uuid
          • key
          • projectId
          • name
          • qualifier
          • path
          • measures: list of measures. When a component is supposed to have a measure it will be returned (the actual value or the best value if no value)
            • metricKey
            • value: a string, whatever the value
            • valueP1: value for period 1
            • valueP2: value for period 2
            • valueP3: value for period 3
            • valueP4: value for period 4
            • valueP5: value for period 5
        • periods: list of periods, like in api/qualitygates/project_status
        • metrics: list of metrics with details
          • key
          • name
          • description: string
          • domain: string
          • type: string
          • direction: int
          • qualitative: boolean
          • hidden: boolean
          • custom: boolean

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                teryk.bellahsene Teryk Bellahsene (Inactive)
                Reporter:
                teryk.bellahsene Teryk Bellahsene (Inactive)
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Due:
                  Created:
                  Updated:
                  Resolved: