sonarqube-api.yaml

openapi: 3.0.1
info:
  description: |
    The SonarQube API v2 is a REST API which enables you to interact with SonarQube programmatically. Endpoint listed here should work as expected.
    However, you should not consider the API stable for now as it is still under development. New releases of SonarQube can bring changes to existing endpoint definitions.
  title: SonarQube Web API v2
  version: 10.8.0.97868
servers:
- description: Generated server url
  url: http://next.sonarqube.com/sonarqube
paths:
  /v2/authorizations/groups/{id}:
    delete:
      description: Deletes a group.
      operationId: deleteGroup
      parameters:
      - description: The ID of the group to delete.
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      responses:
        "204":
          description: No Content
      summary: Deletes a group
      tags:
      - group-controller
    get:
      description: Fetch a single group.
      operationId: fetchGroup
      parameters:
      - description: The id of the group to fetch.
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupRestResponse'
          description: OK
      summary: Fetch a single group
      tags:
      - group-controller
    patch:
      description: |
        Update a group name or description.
      operationId: updateGroup
      parameters:
      - explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/GroupUpdateRestRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupRestResponse'
          description: OK
      summary: Update a group
      tags:
      - group-controller
  /v2/dop-translation/bound-projects:
    post:
      description: |
        Create a SonarQube project with the information from the provided DevOps platform project.
        Autoconfigure Pull-Request decoration mechanism.
        Requires the 'Create Projects' permission and setting a Personal Access Token with api/alm_integrations/set_pat for a user who will be using this endpoint
      operationId: createBoundProject
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BoundProjectCreateRestRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BoundProjectCreateRestResponse'
          description: Created
      summary: Create a SonarQube project with the information from the provided DevOps
        platform project.
      tags:
      - bound-projects-controller
  /v2/authorizations/group-memberships/{id}:
    delete:
      description: Remove a user from a group
      operationId: delete
      parameters:
      - description: The ID of the group membership to delete.
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      responses:
        "204":
          description: No Content
      summary: Remove a group membership
      tags:
      - group-membership-controller
  /v2/dop-translation/github-configurations/{id}:
    delete:
      description: |
        Delete a GitHub configuration.
        Requires 'Administer System' permission.
      operationId: deleteGithubConfiguration
      parameters:
      - description: The id of the configuration to delete.
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      responses:
        "204":
          description: No Content
      summary: Delete a GitHub configuration
      tags:
      - github-configuration-controller
      x-internal: "true"
    get:
      description: |
        Fetch a GitHub configuration. Requires 'Administer System' permission.
      operationId: getGithubConfiguration
      parameters:
      - description: The id of the configuration to fetch.
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GithubConfigurationResource'
          description: OK
      summary: Fetch a GitHub configuration
      tags:
      - github-configuration-controller
      x-internal: "true"
    patch:
      description: |
        Update a GitHub configuration. Requires 'Administer System' permission.
      operationId: updateGithubConfiguration
      parameters:
      - explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/GithubConfigurationUpdateRestRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GithubConfigurationResource'
          description: OK
      summary: Update a GitHub configuration
      tags:
      - github-configuration-controller
      x-internal: "true"
  /v2/users-management/users/{id}:
    delete:
      description: Deactivates a user. Requires Administer System permission.
      operationId: deactivate
      parameters:
      - description: The ID of the user to delete.
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - description: Anonymize user in addition to deactivating it.
        explode: true
        in: query
        name: anonymize
        required: false
        schema:
          default: false
          type: boolean
        style: form
      responses:
        "204":
          description: No Content
      summary: Deactivate a user
      tags:
      - user-controller
    get:
      description: |
        Fetch a single user.
        The following fields are only returned when user has Administer System permission or for logged-in in user :
            'email'
            'externalIdentity'
            'externalProvider'
            'groups'
            'lastConnectionDate'
            'sonarLintLastConnectionDate'
            'tokensCount'
          Field 'sonarqubeLastConnectionDate' is only updated every hour, so it may not be accurate, for instance when a user authenticates many times in less than one hour.
      operationId: fetchUser
      parameters:
      - description: The id of the user to fetch.
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserRestResponseForAdmins'
          description: OK
      summary: Fetch a single user
      tags:
      - user-controller
    patch:
      description: |
        Update a user.
        Allows updating user's name, email and SCM accounts.
      operationId: updateUser
      parameters:
      - explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/UserUpdateRestRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserRestResponseForAdmins'
          description: OK
      summary: Update a user
      tags:
      - user-controller
  /v2/system/email-configurations:
    get:
      description: |2
          Get the list of email configurations.
          Note that a single configuration is supported at this time.
          Requires 'Administer System' permission.
      operationId: searchEmailConfigurations
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailConfigurationSearchRestResponse'
          description: OK
      summary: Search email configurations
      tags:
      - email-configuration-controller
      x-internal: "true"
    post:
      description: |2
          Create a new email configuration.
          Note that only a single configuration can exist at a time.
          Requires 'Administer System' permission.
      operationId: createEmailConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailConfigurationCreateRestRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailConfigurationResource'
          description: OK
      summary: Create an email configuration
      tags:
      - email-configuration-controller
      x-internal: "true"
  /v2/dop-translation/github-permission-mappings/{role}:
    delete:
      description: Requires 'Administer System' permission.
      operationId: deleteMapping_1
      parameters:
      - description: The name of the role to delete
        explode: false
        in: path
        name: role
        required: true
        schema:
          type: string
        style: simple
      responses:
        "204":
          description: No Content
      summary: Delete a single permission mappings
      tags:
      - github-permission-mappings-controller
      x-internal: "true"
    patch:
      description: Requires 'Administer System' permission.
      operationId: updateMapping_1
      parameters:
      - description: The name of the role to update
        explode: false
        in: path
        name: role
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/DevOpsPermissionMappingUpdateRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PermissionMappingsResource'
          description: OK
      summary: Update a single permission mapping
      tags:
      - github-permission-mappings-controller
      x-internal: "true"
  /v2/authorizations/groups:
    get:
      description: |2
          Get the list of groups.
          The results are sorted alphabetically by group name.
      operationId: search_1
      parameters:
      - description: "Return managed or non-managed groups. Only available for managed\
          \ instances, throws for non-managed instances"
        explode: true
        in: query
        name: managed
        required: false
        schema:
          description: "Return managed or non-managed groups. Only available for managed\
            \ instances, throws for non-managed instances"
          type: string
        style: form
      - description: |-
          Filter on name.
          This parameter performs a partial match (contains), it is case insensitive.
        explode: true
        in: query
        name: q
        required: false
        schema:
          description: |-
            Filter on name.
            This parameter performs a partial match (contains), it is case insensitive.
          type: string
        style: form
      - description: Number of results per page. A value of 0 will only return the
          pagination information.
        explode: true
        in: query
        name: pageSize
        required: false
        schema:
          default: "50"
          description: Number of results per page. A value of 0 will only return the
            pagination information.
          maximum: 500
          minimum: 0
          type: string
        style: form
      - description: 1-based page index
        explode: true
        in: query
        name: pageIndex
        required: false
        schema:
          default: "1"
          description: 1-based page index
          minimum: 1
          type: string
        style: form
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupsSearchRestResponse'
          description: OK
      summary: Group search
      tags:
      - group-controller
    post:
      description: Create a new group.
      operationId: create_6
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupCreateRestRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupRestResponse'
          description: Created
      summary: Create a new group
      tags:
      - group-controller
  /v2/system/liveness:
    get:
      description: |2
          Require 'Administer System' permission or authentication with passcode.

          When SonarQube is fully started, liveness check for database connectivity, Compute Engine status, and, except for DataCenter Edition, if ElasticSearch is Green or Yellow.

          When SonarQube is on Safe Mode (for example when a database migration is running), liveness check only for database connectivity
      operationId: livenessCheck
      parameters:
      - description: "Passcode can be provided, see SonarQube documentation"
        explode: false
        in: header
        name: X-Sonar-Passcode
        required: false
        schema:
          type: string
        style: simple
      responses:
        default:
          description: This SonarQube node is not alive and should be rescheduled
        "204":
          description: This SonarQube node is alive
      summary: "Provide liveness of SonarQube, meant to be used as a liveness probe\
        \ on Kubernetes"
      tags:
      - liveness-controller
  /v2/users-management/users:
    get:
      description: |2
          Get a list of users. By default, only active users are returned.
          The following fields are only returned when user has Administer System permission or for logged-in in user :
            'email',
            'externalIdentity',
            'externalProvider',
            'groups',
            'lastConnectionDate',
            'sonarLintLastConnectionDate',
            'tokensCount'.
          Field 'sonarqubeLastConnectionDate' is only updated every hour, so it may not be accurate, for instance when a user authenticates many times in less than one hour.
          The results are sorted alphabetically by login.
      operationId: search
      parameters:
      - description: Return active/inactive users
        explode: true
        in: query
        name: active
        required: false
        schema:
          default: "true"
          description: Return active/inactive users
          type: string
        style: form
      - description: "Return managed or non-managed users. Only available for managed\
          \ instances, throws for non-managed instances"
        explode: true
        in: query
        name: managed
        required: false
        schema:
          description: "Return managed or non-managed users. Only available for managed\
            \ instances, throws for non-managed instances"
          type: string
        style: form
      - description: |-
          Filter on login, name and email.
          This parameter performs a partial match (contains), it is case insensitive.
        explode: true
        in: query
        name: q
        required: false
        schema:
          description: |-
            Filter on login, name and email.
            This parameter performs a partial match (contains), it is case insensitive.
          type: string
        style: form
      - description: |-
          Filter on externalIdentity.
          This parameter perform a case-sensitive exact match
        explode: true
        in: query
        name: externalIdentity
        required: false
        schema:
          description: |-
            Filter on externalIdentity.
            This parameter perform a case-sensitive exact match
          type: string
        style: form
      - description: Filter users based on the last connection date field. Only users
          who interacted with this instance at or after the date will be returned.
          The format must be ISO 8601 datetime format (YYYY-MM-DDThh:mm:ss±hhmm)
        example: 2020-01-01T00:00:00+0100
        explode: true
        in: query
        name: sonarQubeLastConnectionDateFrom
        required: false
        schema:
          description: Filter users based on the last connection date field. Only
            users who interacted with this instance at or after the date will be returned.
            The format must be ISO 8601 datetime format (YYYY-MM-DDThh:mm:ss±hhmm)
          example: 2020-01-01T00:00:00+0100
          type: string
        style: form
      - description: Filter users based on the last connection date field. Only users
          that never connected or who interacted with this instance at or before the
          date will be returned. The format must be ISO 8601 datetime format (YYYY-MM-DDThh:mm:ss±hhmm)
        example: 2020-01-01T00:00:00+0100
        explode: true
        in: query
        name: sonarQubeLastConnectionDateTo
        required: false
        schema:
          description: Filter users based on the last connection date field. Only
            users that never connected or who interacted with this instance at or
            before the date will be returned. The format must be ISO 8601 datetime
            format (YYYY-MM-DDThh:mm:ss±hhmm)
          example: 2020-01-01T00:00:00+0100
          type: string
        style: form
      - description: Filter users based on the SonarLint last connection date field
          Only users who interacted with this instance using SonarLint at or after
          the date will be returned. The format must be ISO 8601 datetime format (YYYY-MM-DDThh:mm:ss±hhmm)
        example: 2020-01-01T00:00:00+0100
        explode: true
        in: query
        name: sonarLintLastConnectionDateFrom
        required: false
        schema:
          description: Filter users based on the SonarLint last connection date field
            Only users who interacted with this instance using SonarLint at or after
            the date will be returned. The format must be ISO 8601 datetime format
            (YYYY-MM-DDThh:mm:ss±hhmm)
          example: 2020-01-01T00:00:00+0100
          type: string
        style: form
      - description: Filter users based on the SonarLint last connection date field.
          Only users that never connected or who interacted with this instance using
          SonarLint at or before the date will be returned. The format must be ISO
          8601 datetime format (YYYY-MM-DDThh:mm:ss±hhmm)
        example: 2020-01-01T00:00:00+0100
        explode: true
        in: query
        name: sonarLintLastConnectionDateTo
        required: false
        schema:
          description: Filter users based on the SonarLint last connection date field.
            Only users that never connected or who interacted with this instance using
            SonarLint at or before the date will be returned. The format must be ISO
            8601 datetime format (YYYY-MM-DDThh:mm:ss±hhmm)
          example: 2020-01-01T00:00:00+0100
          type: string
        style: form
      - description: Filter users belonging to group. Only available for system administrators.
          Using != operator will exclude users from this group.
        explode: true
        in: query
        name: groupId
        required: false
        schema:
          description: Filter users belonging to group. Only available for system
            administrators. Using != operator will exclude users from this group.
          type: string
          x-internal: "true"
        style: form
        x-internal: "true"
      - description: Number of results per page. A value of 0 will only return the
          pagination information.
        explode: true
        in: query
        name: pageSize
        required: false
        schema:
          default: "50"
          description: Number of results per page. A value of 0 will only return the
            pagination information.
          maximum: 500
          minimum: 0
          type: string
        style: form
      - description: 1-based page index
        explode: true
        in: query
        name: pageIndex
        required: false
        schema:
          default: "1"
          description: 1-based page index
          minimum: 1
          type: string
        style: form
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsersSearchRestResponse'
          description: OK
      summary: Users search
      tags:
      - user-controller
    post:
      description: |2
          Create a user.
          If a deactivated user account exists with the given login, it will be reactivated.
          Requires Administer System permission.
      operationId: create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserCreateRestRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserRestResponseForAdmins'
          description: OK
      summary: User creation
      tags:
      - user-controller
  /v2/dop-translation/github-permission-mappings:
    get:
      description: Get the list of all the existing roles with their permission mappings.
        Requires 'Administer System' permission.
      operationId: fetchAll_1
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PermissionMappingsSearchRestResponse'
          description: OK
      summary: Fetch permissions mapping
      tags:
      - github-permission-mappings-controller
      x-internal: "true"
    post:
      description: Requires 'Administer System' permission.
      operationId: createMapping_1
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PermissionMappingsPostRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PermissionMappingsResource'
          description: OK
      summary: Create a permission mapping for a custom role
      tags:
      - github-permission-mappings-controller
      x-internal: "true"
  /v2/analysis/cves/{id}:
    get:
      description: This endpoint returns the CVE details for a given CVE identifier.
      operationId: getCve
      parameters:
      - description: The CVE business identifier
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CveResource'
          description: OK
      summary: Get the CVE details
      tags:
      - t
  /v2/analysis/jres:
    get:
      description: Get metadata of all available JREs
      operationId: getJresMetadata
      parameters:
      - description: "Filter the JRE by operating system. Accepted values are 'windows',\
          \ 'linux', 'macos', 'alpine' (case-insensitive), with some aliases"
        explode: true
        in: query
        name: os
        required: false
        schema:
          type: string
        style: form
      - description: "Filter the JRE by CPU architecture. Accepted values are 'x64'\
          \ and 'aarch64' (case-insensitive), with some aliases."
        explode: true
        in: query
        name: arch
        required: false
        schema:
          type: string
        style: form
      responses:
        "200":
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/JreInfoRestResponse'
                type: array
          description: OK
      summary: All JREs metadata
      tags:
      - jres-controller
  /v2/analysis/jres/{id}:
    get:
      description: "This endpoint return the JRE metadata by default. To download\
        \ the JRE binary asset, set the Accept header of the request to 'application/octet-stream'."
      operationId: downloadJre_1
      parameters:
      - description: The ID of the JRE
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      responses:
        "200":
          content:
            application/octet-stream:
              schema:
                format: binary
                type: string
            application/json:
              schema:
                $ref: '#/components/schemas/JreInfoRestResponse'
          description: OK
      summary: JRE download/metadata
      tags:
      - jres-controller
  /v2/clean-code-policy/rules:
    post:
      description: |2
          Create a custom rule.
          Requires the 'Administer Quality Profiles' permission.
      operationId: create_5
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RuleCreateRestRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuleRestResponse'
          description: OK
      summary: Custom rule creation
      tags:
      - rule-controller
      x-internal: "true"
  /v2/dop-translation/gitlab-configurations/{id}:
    delete:
      description: |
        Delete a GitLab configuration.
        Requires 'Administer System' permission.
      operationId: deleteGitlabConfiguration
      parameters:
      - description: The id of the configuration to delete.
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      responses:
        "204":
          description: No Content
      summary: Delete a GitLab configuration
      tags:
      - gitlab-configuration-controller
      x-internal: "true"
    get:
      description: |
        Fetch a GitLab configuration. Requires 'Administer System' permission.
      operationId: getGitlabConfiguration
      parameters:
      - description: The id of the configuration to fetch.
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GitlabConfigurationResource'
          description: OK
      summary: Fetch a GitLab configuration
      tags:
      - gitlab-configuration-controller
      x-internal: "true"
    patch:
      description: |
        Update a Gitlab configuration. Requires 'Administer System' permission.
      operationId: updateGitlabConfiguration
      parameters:
      - explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/GitlabConfigurationUpdateRestRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GitlabConfigurationResource'
          description: OK
      summary: Update a Gitlab configuration
      tags:
      - gitlab-configuration-controller
      x-internal: "true"
  /v2/analysis/version:
    get:
      description: Get the version of the Scanner Engine
      operationId: getVersion
      responses:
        "200":
          content:
            text/plain:
              schema:
                type: string
          description: OK
      summary: Server version
      tags:
      - version-controller
  /v2/fix-suggestions/ai-suggestions:
    post:
      description: Requires Code Viewer permission.
      operationId: create_2
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FixSuggestionPostRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FixSuggestionResponse'
          description: OK
      summary: Suggest a fix for the given issueId
      tags:
      - fix-suggestion-controller
  /v2/fix-suggestions/service-status-checks:
    post:
      operationId: create_1
      requestBody:
        content:
          application/json:
            schema:
              type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceStatusCheckResponse'
          description: OK
      summary: Request a status check of AI CodeFix service
      tags:
      - service-status-check-controller
      x-internal: "true"
  /v2/dop-translation/github-configurations:
    get:
      description: |2
          Get the list of GitHub configurations.
          Note that a single configuration is supported at this time.
          Requires 'Administer System' permission.
      operationId: searchGithubConfiguration
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GithubConfigurationSearchRestResponse'
          description: OK
      summary: Search GitHub configs
      tags:
      - github-configuration-controller
      x-internal: "true"
    post:
      description: |2
          Create a new GitHub configuration.
          Note that only a single configuration can exist at a time.
          Requires 'Administer System' permission.
      operationId: createGithubConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GithubConfigurationCreateRestRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GithubConfigurationResource'
          description: OK
      summary: Create GitHub configuration
      tags:
      - github-configuration-controller
      x-internal: "true"
  /v2/system/health:
    get:
      operationId: getHealth
      parameters:
      - explode: false
        in: header
        name: X-Sonar-Passcode
        required: false
        schema:
          type: string
        style: simple
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Health'
          description: OK
      tags:
      - health-controller
  /v2/system/email-configurations/{id}:
    delete:
      description: |
        Delete an email configuration.
        Requires 'Administer System' permission.
      operationId: deleteEmailConfiguration
      parameters:
      - description: The id of the configuration to delete.
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      responses:
        "204":
          description: No Content
      summary: Delete an email configuration
      tags:
      - email-configuration-controller
      x-internal: "true"
    get:
      description: |
        Fetch a Email configuration. Requires 'Administer System' permission.
      operationId: getEmailConfiguration
      parameters:
      - description: The id of the configuration to fetch.
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailConfigurationResource'
          description: OK
      summary: Fetch an email configuration
      tags:
      - email-configuration-controller
      x-internal: "true"
    patch:
      description: |
        Update an email configuration. Requires 'Administer System' permission.
      operationId: updateEmailConfiguration
      parameters:
      - explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/EmailConfigurationUpdateRestRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailConfigurationResource'
          description: OK
      summary: Update an email configuration
      tags:
      - email-configuration-controller
      x-internal: "true"
  /v2/dop-translation/project-bindings:
    get:
      operationId: getProjectBindingByProjectId
      parameters:
      - description: |
          Filter on the repository name.
          This parameter performs an exact, case insensitive, match.
        explode: true
        in: query
        name: repository
        required: false
        schema:
          description: |
            Filter on the repository name.
            This parameter performs an exact, case insensitive, match.
          type: string
        style: form
      - description: Filter on the DevOps Platform setting id.
        explode: true
        in: query
        name: dopSettingId
        required: false
        schema:
          description: Filter on the DevOps Platform setting id.
          type: string
        style: form
      - description: Number of results per page. A value of 0 will only return the
          pagination information.
        explode: true
        in: query
        name: pageSize
        required: false
        schema:
          default: "50"
          description: Number of results per page. A value of 0 will only return the
            pagination information.
          maximum: 500
          minimum: 0
          type: string
        style: form
      - description: 1-based page index
        explode: true
        in: query
        name: pageIndex
        required: false
        schema:
          default: "1"
          description: 1-based page index
          minimum: 1
          type: string
        style: form
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectBindingsSearchRestResponse'
          description: OK
      summary: Search across project bindings
      tags:
      - project-bindings-controller
      x-internal: "true"
  /v2/fix-suggestions/issues/{issueId}:
    get:
      description: Requires Code Viewer permission.
      operationId: get
      parameters:
      - explode: false
        in: path
        name: issueId
        required: true
        schema:
          type: string
        style: simple
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FixSuggestionIssueResponse'
          description: OK
      summary: Fetch AI suggestion availability for the given issueId
      tags:
      - fix-suggestion-issue-controller
  /v2/dop-translation/project-bindings/{id}:
    get:
      operationId: getProjectBinding
      parameters:
      - description: The id of the project-bindings to fetch.
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectBinding'
          description: OK
      summary: Fetch a single Project Binding
      tags:
      - project-bindings-controller
      x-internal: "true"
  /v2/dop-translation/gitlab-permission-mappings:
    get:
      description: Get the list of all the existing roles with their permission mappings.
        Requires 'Administer System' permission.
      operationId: fetchAll
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PermissionMappingsSearchRestResponse'
          description: OK
      summary: Fetch permissions mapping
      tags:
      - gitlab-permission-mappings-controller
      x-internal: "true"
    post:
      description: Requires 'Administer System' permission.
      operationId: createMapping
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PermissionMappingsPostRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PermissionMappingsResource'
          description: OK
      summary: Create a permission mapping for a custom role
      tags:
      - gitlab-permission-mappings-controller
      x-internal: "true"
  /v2/dop-translation/dop-settings:
    get:
      description: 'Requires the ''Create Projects'' permission '
      operationId: fetchAllDopSettings
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DopSettingsRestResponse'
          description: OK
      summary: List all DevOps Platform Integration settings
      tags:
      - dop-settings-controller
  /v2/system/migrations-status:
    get:
      description: Return the detailed status of ongoing database migrations including
        starting date. If no migration is ongoing or needed it is still possible to
        call this endpoint and receive appropriate information.
      operationId: getStatus
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseMigrationsResponse'
          description: OK
      summary: "Gets the status of ongoing database migrations, if any"
      tags:
      - database-migrations-controller
  /v2/analysis/engine:
    get:
      description: "This endpoint return the Scanner Engine metadata by default. To\
        \ download the Scanner Engine, set the Accept header of the request to 'application/octet-stream'."
      operationId: downloadScannerEngine_1
      responses:
        "200":
          content:
            application/octet-stream:
              schema:
                format: binary
                type: string
            application/json:
              schema:
                $ref: '#/components/schemas/EngineInfoRestResponse'
          description: OK
      summary: Scanner engine download/metadata
      tags:
      - scanner-engine-controller
  /v2/dop-translation/gitlab-synchronization-runs:
    post:
      description: |2
          Adds a new GitLab synchronization run in the background tasks. Requires sys-admins permissions.
      operationId: create_3
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GitlabSynchronizationRunResource'
          description: OK
      summary: Starts a GitLab synchronization run.
      tags:
      - gitlab-synchronization-run-controller
      x-internal: "true"
  /v2/authorizations/group-memberships:
    get:
      description: |2
          Get the list of groups and members matching the query.
      operationId: search_2
      parameters:
      - description: "ID of the user for which to search groups. If not set, all groups\
          \ are returned."
        explode: true
        in: query
        name: userId
        required: false
        schema:
          description: "ID of the user for which to search groups. If not set, all\
            \ groups are returned."
          type: string
        style: form
      - description: "ID of the group for which to search members. If not set, all\
          \ groups are returned."
        explode: true
        in: query
        name: groupId
        required: false
        schema:
          description: "ID of the group for which to search members. If not set, all\
            \ groups are returned."
          type: string
        style: form
      - description: Number of results per page. A value of 0 will only return the
          pagination information.
        explode: true
        in: query
        name: pageSize
        required: false
        schema:
          default: "50"
          description: Number of results per page. A value of 0 will only return the
            pagination information.
          maximum: 500
          minimum: 0
          type: string
        style: form
      - description: 1-based page index
        explode: true
        in: query
        name: pageIndex
        required: false
        schema:
          default: "1"
          description: 1-based page index
          minimum: 1
          type: string
        style: form
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupsMembershipSearchRestResponse'
          description: OK
      summary: Search across group memberships
      tags:
      - group-membership-controller
    post:
      description: Add a user to a group.
      operationId: create_7
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupMembershipCreateRestRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupMembershipRestResponse'
          description: Created
      summary: Add a group membership
      tags:
      - group-membership-controller
  /v2/dop-translation/gitlab-configurations:
    get:
      description: |2
          Get the list of GitLab configurations.
          Note that a single configuration is supported at this time.
          Requires 'Administer System' permission.
      operationId: searchGitlabConfiguration
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GitlabConfigurationSearchRestResponse'
          description: OK
      summary: Search GitLab configs
      tags:
      - gitlab-configuration-controller
      x-internal: "true"
    post:
      description: |2
          Create a new Gitlab configuration.
          Note that only a single configuration can exist at a time.
          Requires 'Administer System' permission.
      operationId: create_4
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GitlabConfigurationCreateRestRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GitlabConfigurationResource'
          description: OK
      summary: Create Gitlab configuration
      tags:
      - gitlab-configuration-controller
      x-internal: "true"
  /v2/dop-translation/gitlab-permission-mappings/{role}:
    delete:
      description: Requires 'Administer System' permission.
      operationId: deleteMapping
      parameters:
      - description: The name of the role to delete
        explode: false
        in: path
        name: role
        required: true
        schema:
          type: string
        style: simple
      responses:
        "204":
          description: No Content
      summary: Delete a single permission mappings
      tags:
      - gitlab-permission-mappings-controller
      x-internal: "true"
    patch:
      description: Requires 'Administer System' permission.
      operationId: updateMapping
      parameters:
      - description: The name of the role to update
        explode: false
        in: path
        name: role
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/DevOpsPermissionMappingUpdateRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PermissionMappingsResource'
          description: OK
      summary: Update a single permission mapping
      tags:
      - gitlab-permission-mappings-controller
      x-internal: "true"
  /api/alm_integrations/import_azure_project:
    description: Manage DevOps Platform Integrations
    post:
      description: Create a SonarQube project with the information from the provided
        Azure DevOps project.<br/>Autoconfigure pull request decoration mechanism.<br/>Requires
        the 'Create Projects' permission
      externalDocs:
        description: Sonarqube Documentation for import_azure_project
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/alm_integrations/import_azure_project
      operationId: v1_get_api_alm_integrations_import_azure_project
      parameters:
      - description: DevOps Platform configuration key. This parameter is optional
          if you have only one Azure integration.
        explode: true
        in: query
        name: almSetting
        required: false
        schema:
          type: string
        style: form
      - description: Project New Code Definition Type<br/>New code definitions of
          the following types are allowed:<ul><li>PREVIOUS_VERSION</li><li>NUMBER_OF_DAYS</li><li>REFERENCE_BRANCH
          - will default to the main branch.</li></ul>
        explode: true
        in: query
        name: newCodeDefinitionType
        required: false
        schema:
          type: string
        style: form
      - description: "Project New Code Definition Value<br/>For each new code definition\
          \ type, a different value is expected:<ul><li>no value, when the new code\
          \ definition type is PREVIOUS_VERSION and REFERENCE_BRANCH</li><li>a number\
          \ between 1 and 90, when the new code definition type is NUMBER_OF_DAYS</li></ul>"
        explode: true
        in: query
        name: newCodeDefinitionValue
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Azure project name
        explode: true
        in: query
        name: projectName
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Azure repository name
        explode: true
        in: query
        name: repositoryName
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: import azure project
  /api/alm_integrations/import_bitbucketcloud_repo:
    description: Manage DevOps Platform Integrations
    post:
      description: Create a SonarQube project with the information from the provided
        Bitbucket Cloud repository.<br/>Autoconfigure pull request decoration mechanism.<br/>Requires
        the 'Create Projects' permission
      externalDocs:
        description: Sonarqube Documentation for import_bitbucketcloud_repo
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/alm_integrations/import_bitbucketcloud_repo
      operationId: v1_get_api_alm_integrations_import_bitbucketcloud_repo
      parameters:
      - description: DevOps Platform configuration key. This parameter is optional
          if you have only one BitBucket Cloud integration.
        explode: true
        in: query
        name: almSetting
        required: false
        schema:
          type: string
        style: form
      - description: Project New Code Definition Type<br/>New code definitions of
          the following types are allowed:<ul><li>PREVIOUS_VERSION</li><li>NUMBER_OF_DAYS</li><li>REFERENCE_BRANCH
          - will default to the main branch.</li></ul>
        explode: true
        in: query
        name: newCodeDefinitionType
        required: false
        schema:
          type: string
        style: form
      - description: "Project New Code Definition Value<br/>For each new code definition\
          \ type, a different value is expected:<ul><li>no value, when the new code\
          \ definition type is PREVIOUS_VERSION and REFERENCE_BRANCH</li><li>a number\
          \ between 1 and 90, when the new code definition type is NUMBER_OF_DAYS</li></ul>"
        explode: true
        in: query
        name: newCodeDefinitionValue
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Bitbucket Cloud repository slug
        explode: true
        in: query
        name: repositorySlug
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: import bitbucketcloud repo
  /api/alm_integrations/import_bitbucketserver_project:
    description: Manage DevOps Platform Integrations
    post:
      description: Create a SonarQube project with the information from the provided
        BitbucketServer project.<br/>Autoconfigure pull request decoration mechanism.<br/>Requires
        the 'Create Projects' permission
      externalDocs:
        description: Sonarqube Documentation for import_bitbucketserver_project
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/alm_integrations/import_bitbucketserver_project
      operationId: v1_get_api_alm_integrations_import_bitbucketserver_project
      parameters:
      - description: DevOps Platform configuration key. This parameter is optional
          if you have only one BitBucket Server integration.
        explode: true
        in: query
        name: almSetting
        required: false
        schema:
          type: string
        style: form
      - description: Project New Code Definition Type<br/>New code definitions of
          the following types are allowed:<ul><li>PREVIOUS_VERSION</li><li>NUMBER_OF_DAYS</li><li>REFERENCE_BRANCH
          - will default to the main branch.</li></ul>
        explode: true
        in: query
        name: newCodeDefinitionType
        required: false
        schema:
          type: string
        style: form
      - description: "Project New Code Definition Value<br/>For each new code definition\
          \ type, a different value is expected:<ul><li>no value, when the new code\
          \ definition type is PREVIOUS_VERSION and REFERENCE_BRANCH</li><li>a number\
          \ between 1 and 90, when the new code definition type is NUMBER_OF_DAYS</li></ul>"
        explode: true
        in: query
        name: newCodeDefinitionValue
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: BitbucketServer project key
        explode: true
        in: query
        name: projectKey
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: BitbucketServer repository slug
        explode: true
        in: query
        name: repositorySlug
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: import bitbucketserver project
  /api/alm_integrations/import_github_project:
    description: Manage DevOps Platform Integrations
    post:
      description: "Create a SonarQube project with the information from the provided\
        \ GitHub repository.<br/>Autoconfigure pull request decoration mechanism.\
        \ If Automatic Provisioning is enable for GitHub, it will also synchronize\
        \ permissions from the repository.<br/>Requires the 'Create Projects' permission"
      externalDocs:
        description: Sonarqube Documentation for import_github_project
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/alm_integrations/import_github_project
      operationId: v1_get_api_alm_integrations_import_github_project
      parameters:
      - description: DevOps Platform configuration key. This parameter is optional
          if you have only one GitHub integration.
        explode: true
        in: query
        name: almSetting
        required: false
        schema:
          type: string
        style: form
      - description: Project New Code Definition Type<br/>New code definitions of
          the following types are allowed:<ul><li>PREVIOUS_VERSION</li><li>NUMBER_OF_DAYS</li><li>REFERENCE_BRANCH
          - will default to the main branch.</li></ul>
        explode: true
        in: query
        name: newCodeDefinitionType
        required: false
        schema:
          type: string
        style: form
      - description: "Project New Code Definition Value<br/>For each new code definition\
          \ type, a different value is expected:<ul><li>no value, when the new code\
          \ definition type is PREVIOUS_VERSION and REFERENCE_BRANCH</li><li>a number\
          \ between 1 and 90, when the new code definition type is NUMBER_OF_DAYS</li></ul>"
        explode: true
        in: query
        name: newCodeDefinitionValue
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: GitHub repository key (organization/repoSlug
        explode: true
        in: query
        name: repositoryKey
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: import github project
  /api/alm_integrations/import_gitlab_project:
    description: Manage DevOps Platform Integrations
    post:
      description: "Import a GitLab project to SonarQube, creating a new project and\
        \ configuring MR decoration<br/>Requires the 'Create Projects' permission"
      externalDocs:
        description: Sonarqube Documentation for import_gitlab_project
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/alm_integrations/import_gitlab_project
      operationId: v1_get_api_alm_integrations_import_gitlab_project
      parameters:
      - description: DevOps Platform configuration key. This parameter is optional
          if you have only one GitLab integration.
        explode: true
        in: query
        name: almSetting
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: GitLab project ID
        explode: true
        in: query
        name: gitlabProjectId
        required: true
        schema:
          type: string
        style: form
      - description: Project New Code Definition Type<br/>New code definitions of
          the following types are allowed:<ul><li>PREVIOUS_VERSION</li><li>NUMBER_OF_DAYS</li><li>REFERENCE_BRANCH
          - will default to the main branch.</li></ul>
        explode: true
        in: query
        name: newCodeDefinitionType
        required: false
        schema:
          type: string
        style: form
      - description: "Project New Code Definition Value<br/>For each new code definition\
          \ type, a different value is expected:<ul><li>no value, when the new code\
          \ definition type is PREVIOUS_VERSION and REFERENCE_BRANCH</li><li>a number\
          \ between 1 and 90, when the new code definition type is NUMBER_OF_DAYS</li></ul>"
        explode: true
        in: query
        name: newCodeDefinitionValue
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: import gitlab project
  /api/alm_integrations/list_azure_projects:
    description: Manage DevOps Platform Integrations
    get:
      description: List Azure projects<br/>Requires the 'Create Projects' permission
      externalDocs:
        description: Sonarqube Documentation for list_azure_projects
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/alm_integrations/list_azure_projects
      operationId: v1_post_api_alm_integrations_list_azure_projects
      parameters:
      - allowEmptyValue: true
        description: DevOps Platform setting key
        explode: true
        in: query
        name: almSetting
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: list azure projects
  /api/alm_integrations/list_bitbucketserver_projects:
    description: Manage DevOps Platform Integrations
    get:
      description: List the Bitbucket Server projects<br/>Requires the 'Create Projects'
        permission
      externalDocs:
        description: Sonarqube Documentation for list_bitbucketserver_projects
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/alm_integrations/list_bitbucketserver_projects
      operationId: v1_post_api_alm_integrations_list_bitbucketserver_projects
      parameters:
      - allowEmptyValue: true
        description: DevOps Platform setting key
        explode: true
        in: query
        name: almSetting
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: list bitbucketserver projects
  /api/alm_integrations/search_azure_repos:
    description: Manage DevOps Platform Integrations
    get:
      description: Search the Azure repositories<br/>Requires the 'Create Projects'
        permission
      externalDocs:
        description: Sonarqube Documentation for search_azure_repos
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/alm_integrations/search_azure_repos
      operationId: v1_post_api_alm_integrations_search_azure_repos
      parameters:
      - allowEmptyValue: true
        description: DevOps Platform setting key
        explode: true
        in: query
        name: almSetting
        required: true
        schema:
          type: string
        style: form
      - description: Project name filter
        explode: true
        in: query
        name: projectName
        required: false
        schema:
          type: string
        style: form
      - description: Search query filter
        explode: true
        in: query
        name: searchQuery
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: search azure repos
  /api/alm_integrations/search_bitbucketcloud_repos:
    description: Manage DevOps Platform Integrations
    get:
      description: Search the Bitbucket Cloud repositories<br/>Requires the 'Create
        Projects' permission
      externalDocs:
        description: Sonarqube Documentation for search_bitbucketcloud_repos
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/alm_integrations/search_bitbucketcloud_repos
      operationId: v1_post_api_alm_integrations_search_bitbucketcloud_repos
      parameters:
      - allowEmptyValue: true
        description: DevOps Platform setting key
        explode: true
        in: query
        name: almSetting
        required: true
        schema:
          type: string
        style: form
      - description: 1-based page number
        explode: true
        in: query
        name: p
        required: false
        schema:
          type: string
        style: form
      - description: Page size. Must be greater than 0 and less or equal than 100
        explode: true
        in: query
        name: ps
        required: false
        schema:
          type: string
        style: form
      - description: Repository name filter
        explode: true
        in: query
        name: repositoryName
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: search bitbucketcloud repos
  /api/alm_integrations/search_bitbucketserver_repos:
    description: Manage DevOps Platform Integrations
    get:
      description: Search the Bitbucket Server repositories with REPO_ADMIN access<br/>Requires
        the 'Create Projects' permission
      externalDocs:
        description: Sonarqube Documentation for search_bitbucketserver_repos
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/alm_integrations/search_bitbucketserver_repos
      operationId: v1_post_api_alm_integrations_search_bitbucketserver_repos
      parameters:
      - allowEmptyValue: true
        description: DevOps Platform setting key
        explode: true
        in: query
        name: almSetting
        required: true
        schema:
          type: string
        style: form
      - description: Project name filter
        explode: true
        in: query
        name: projectName
        required: false
        schema:
          type: string
        style: form
      - description: Repository name filter
        explode: true
        in: query
        name: repositoryName
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: search bitbucketserver repos
  /api/alm_integrations/search_gitlab_repos:
    description: Manage DevOps Platform Integrations
    get:
      description: Search the GitLab projects.<br/>Requires the 'Create Projects'
        permission
      externalDocs:
        description: Sonarqube Documentation for search_gitlab_repos
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/alm_integrations/search_gitlab_repos
      operationId: v1_post_api_alm_integrations_search_gitlab_repos
      parameters:
      - allowEmptyValue: true
        description: DevOps Platform setting key
        explode: true
        in: query
        name: almSetting
        required: true
        schema:
          type: string
        style: form
      - description: 1-based page number
        explode: true
        in: query
        name: p
        required: false
        schema:
          type: string
        style: form
      - description: Project name filter
        explode: true
        in: query
        name: projectName
        required: false
        schema:
          type: string
        style: form
      - description: Page size. Must be greater than 0 and less or equal than 500
        explode: true
        in: query
        name: ps
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: search gitlab repos
  /api/alm_integrations/set_pat:
    description: Manage DevOps Platform Integrations
    post:
      description: Set a Personal Access Token for the given DevOps Platform setting<br/>Requires
        the 'Create Projects' permission
      externalDocs:
        description: Sonarqube Documentation for set_pat
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/alm_integrations/set_pat
      operationId: v1_get_api_alm_integrations_set_pat
      parameters:
      - description: DevOps Platform configuration key. This parameter is optional
          if you have only one single DevOps Platform integration.
        explode: true
        in: query
        name: almSetting
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Personal Access Token
        explode: true
        in: query
        name: pat
        required: true
        schema:
          type: string
        style: form
      - description: Username
        explode: true
        in: query
        name: username
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: set pat
  /api/alm_settings/count_binding:
    description: Manage DevOps Platform Settings
    get:
      description: Count number of project bound to an DevOps Platform setting.<br/>Requires
        the 'Administer System' permission
      externalDocs:
        description: Sonarqube Documentation for count_binding
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/alm_settings/count_binding
      operationId: v1_post_api_alm_settings_count_binding
      parameters:
      - allowEmptyValue: true
        description: DevOps Platform setting key
        explode: true
        in: query
        name: almSetting
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: count binding
  /api/alm_settings/create_azure:
    description: Manage DevOps Platform Settings
    post:
      description: Create Azure instance Setting. <br/>Requires the 'Administer System'
        permission
      externalDocs:
        description: Sonarqube Documentation for create_azure
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/alm_settings/create_azure
      operationId: v1_get_api_alm_settings_create_azure
      parameters:
      - allowEmptyValue: true
        description: Unique key of the Azure Devops instance setting
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Azure Devops personal access token
        explode: true
        in: query
        name: personalAccessToken
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Azure API URL
        explode: true
        in: query
        name: url
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: create azure
  /api/alm_settings/create_bitbucket:
    description: Manage DevOps Platform Settings
    post:
      description: Create Bitbucket instance Setting. <br/>Requires the 'Administer
        System' permission
      externalDocs:
        description: Sonarqube Documentation for create_bitbucket
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/alm_settings/create_bitbucket
      operationId: v1_get_api_alm_settings_create_bitbucket
      parameters:
      - allowEmptyValue: true
        description: Unique key of the Bitbucket instance setting
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Bitbucket personal access token
        explode: true
        in: query
        name: personalAccessToken
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: BitBucket server API URL
        explode: true
        in: query
        name: url
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: create bitbucket
  /api/alm_settings/create_bitbucketcloud:
    description: Manage DevOps Platform Settings
    post:
      description: Configure a new instance of Bitbucket Cloud. <br/>Requires the
        'Administer System' permission
      externalDocs:
        description: Sonarqube Documentation for create_bitbucketcloud
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/alm_settings/create_bitbucketcloud
      operationId: v1_get_api_alm_settings_create_bitbucketcloud
      parameters:
      - allowEmptyValue: true
        description: Bitbucket Cloud Client ID
        explode: true
        in: query
        name: clientId
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Bitbucket Cloud Client Secret
        explode: true
        in: query
        name: clientSecret
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Unique key of the Bitbucket Cloud setting
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Bitbucket Cloud workspace ID
        explode: true
        in: query
        name: workspace
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: create bitbucketcloud
  /api/alm_settings/create_github:
    description: Manage DevOps Platform Settings
    post:
      description: Create GitHub instance Setting. <br/>Requires the 'Administer System'
        permission
      externalDocs:
        description: Sonarqube Documentation for create_github
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/alm_settings/create_github
      operationId: v1_get_api_alm_settings_create_github
      parameters:
      - allowEmptyValue: true
        description: GitHub App ID
        explode: true
        in: query
        name: appId
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: GitHub App Client ID
        explode: true
        in: query
        name: clientId
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: GitHub App Client Secret
        explode: true
        in: query
        name: clientSecret
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Unique key of the GitHub instance setting
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: GitHub App private key
        explode: true
        in: query
        name: privateKey
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: GitHub API URL
        explode: true
        in: query
        name: url
        required: true
        schema:
          type: string
        style: form
      - description: GitHub App Webhook Secret
        explode: true
        in: query
        name: webhookSecret
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: create github
  /api/alm_settings/create_gitlab:
    description: Manage DevOps Platform Settings
    post:
      description: Create GitLab instance Setting. <br/>Requires the 'Administer System'
        permission
      externalDocs:
        description: Sonarqube Documentation for create_gitlab
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/alm_settings/create_gitlab
      operationId: v1_get_api_alm_settings_create_gitlab
      parameters:
      - allowEmptyValue: true
        description: Unique key of the GitLab instance setting
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: GitLab personal access token
        explode: true
        in: query
        name: personalAccessToken
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: GitLab API URL
        explode: true
        in: query
        name: url
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: create gitlab
  /api/alm_settings/delete:
    description: Manage DevOps Platform Settings
    post:
      description: Delete an DevOps Platform Setting.<br/>Requires the 'Administer
        System' permission
      externalDocs:
        description: Sonarqube Documentation for delete
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/alm_settings/delete
      operationId: v1_get_api_alm_settings_delete
      parameters:
      - allowEmptyValue: true
        description: DevOps Platform Setting key
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: delete
  /api/alm_settings/delete_binding:
    description: Manage DevOps Platform Settings
    post:
      description: Delete the DevOps Platform binding of a project.<br/>Requires the
        'Administer' permission on the project
      externalDocs:
        description: Sonarqube Documentation for delete_binding
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/alm_settings/delete_binding
      operationId: v1_get_api_alm_settings_delete_binding
      parameters:
      - allowEmptyValue: true
        description: Project key
        explode: true
        in: query
        name: project
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: delete binding
  /api/alm_settings/get_binding:
    description: Manage DevOps Platform Settings
    get:
      description: Get DevOps Platform binding of a given project.<br/>Requires the
        'Browse' permission on the project
      externalDocs:
        description: Sonarqube Documentation for get_binding
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/alm_settings/get_binding
      operationId: v1_post_api_alm_settings_get_binding
      parameters:
      - allowEmptyValue: true
        description: Project key
        explode: true
        in: query
        name: project
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: get binding
  /api/alm_settings/list:
    description: Manage DevOps Platform Settings
    get:
      description: "List DevOps Platform setting available for a given project, sorted\
        \ by DevOps Platform key<br/>Requires the 'Administer project' permission\
        \ if the 'project' parameter is provided, requires the 'Create Projects' permission\
        \ otherwise."
      externalDocs:
        description: Sonarqube Documentation for list
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/alm_settings/list
      operationId: v1_post_api_alm_settings_list
      parameters:
      - description: Project key
        explode: true
        in: query
        name: project
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: list
  /api/alm_settings/list_definitions:
    description: Manage DevOps Platform Settings
    get:
      description: "List DevOps Platform Settings, sorted by created date.<br/>Requires\
        \ the 'Administer System' permission"
      externalDocs:
        description: Sonarqube Documentation for list_definitions
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/alm_settings/list_definitions
      operationId: v1_post_api_alm_settings_list_definitions
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: list definitions
  /api/alm_settings/set_azure_binding:
    description: Manage DevOps Platform Settings
    post:
      description: "Bind a Azure DevOps instance to a project.<br/>If the project\
        \ was already bound to a previous Azure DevOps instance, the binding will\
        \ be updated to the new one.Requires the 'Administer' permission on the project"
      externalDocs:
        description: Sonarqube Documentation for set_azure_binding
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/alm_settings/set_azure_binding
      operationId: v1_get_api_alm_settings_set_azure_binding
      parameters:
      - allowEmptyValue: true
        description: Azure DevOps setting key
        explode: true
        in: query
        name: almSetting
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Is this project part of a monorepo
        explode: true
        in: query
        name: monorepo
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: SonarQube project key
        explode: true
        in: query
        name: project
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Azure project name
        explode: true
        in: query
        name: projectName
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Azure repository name
        explode: true
        in: query
        name: repositoryName
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: set azure binding
  /api/alm_settings/set_bitbucket_binding:
    description: Manage DevOps Platform Settings
    post:
      description: "Bind a Bitbucket instance to a project.<br/>If the project was\
        \ already bound to a previous Bitbucket instance, the binding will be updated\
        \ to the new one.Requires the 'Administer' permission on the project"
      externalDocs:
        description: Sonarqube Documentation for set_bitbucket_binding
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/alm_settings/set_bitbucket_binding
      operationId: v1_get_api_alm_settings_set_bitbucket_binding
      parameters:
      - allowEmptyValue: true
        description: Bitbucket Server setting key
        explode: true
        in: query
        name: almSetting
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Is this project part of a monorepo
        explode: true
        in: query
        name: monorepo
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Project key
        explode: true
        in: query
        name: project
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Bitbucket Server repository key
        explode: true
        in: query
        name: repository
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Bitbucket repository slug
        explode: true
        in: query
        name: slug
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: set bitbucket binding
  /api/alm_settings/set_bitbucketcloud_binding:
    description: Manage DevOps Platform Settings
    post:
      description: "Bind a Bitbucket Cloud setting to a project.<br/>If the project\
        \ was already bound to a different Bitbucket Cloud setting, the binding will\
        \ be updated to the new one.Requires the 'Administer' permission on the project"
      externalDocs:
        description: Sonarqube Documentation for set_bitbucketcloud_binding
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/alm_settings/set_bitbucketcloud_binding
      operationId: v1_get_api_alm_settings_set_bitbucketcloud_binding
      parameters:
      - allowEmptyValue: true
        description: Bitbucket Cloud setting key
        explode: true
        in: query
        name: almSetting
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Is this project part of a monorepo
        explode: true
        in: query
        name: monorepo
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Project key
        explode: true
        in: query
        name: project
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Bitbucket Cloud repository key
        explode: true
        in: query
        name: repository
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: set bitbucketcloud binding
  /api/alm_settings/set_github_binding:
    description: Manage DevOps Platform Settings
    post:
      description: "Bind a GitHub instance to a project.<br/>If the project was already\
        \ bound to a previous GitHub instance, the binding will be updated to the\
        \ new one.Requires the 'Administer' permission on the project"
      externalDocs:
        description: Sonarqube Documentation for set_github_binding
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/alm_settings/set_github_binding
      operationId: v1_get_api_alm_settings_set_github_binding
      parameters:
      - allowEmptyValue: true
        description: GitHub setting key
        explode: true
        in: query
        name: almSetting
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Is this project part of a monorepo
        explode: true
        in: query
        name: monorepo
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Project key
        explode: true
        in: query
        name: project
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: GitHub Repository
        explode: true
        in: query
        name: repository
        required: true
        schema:
          type: string
        style: form
      - description: Enable/disable summary in PR discussion tab
        explode: true
        in: query
        name: summaryCommentEnabled
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: set github binding
  /api/alm_settings/set_gitlab_binding:
    description: Manage DevOps Platform Settings
    post:
      description: "Bind a GitLab instance to a project.<br/>If the project was already\
        \ bound to a previous Gitlab instance, the binding will be updated to the\
        \ new one.Requires the 'Administer' permission on the project"
      externalDocs:
        description: Sonarqube Documentation for set_gitlab_binding
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/alm_settings/set_gitlab_binding
      operationId: v1_get_api_alm_settings_set_gitlab_binding
      parameters:
      - allowEmptyValue: true
        description: GitLab setting key
        explode: true
        in: query
        name: almSetting
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Is this project part of a monorepo
        explode: true
        in: query
        name: monorepo
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Project key
        explode: true
        in: query
        name: project
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: GitLab project ID
        explode: true
        in: query
        name: repository
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: set gitlab binding
  /api/alm_settings/update_azure:
    description: Manage DevOps Platform Settings
    post:
      description: Update Azure instance Setting. <br/>Requires the 'Administer System'
        permission
      externalDocs:
        description: Sonarqube Documentation for update_azure
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/alm_settings/update_azure
      operationId: v1_get_api_alm_settings_update_azure
      parameters:
      - allowEmptyValue: true
        description: Unique key of the Azure instance setting
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      - description: Optional new value for an unique key of the Azure Devops instance
          setting
        explode: true
        in: query
        name: newKey
        required: false
        schema:
          type: string
        style: form
      - description: Azure Devops personal access token
        explode: true
        in: query
        name: personalAccessToken
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Azure API URL
        explode: true
        in: query
        name: url
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: update azure
  /api/alm_settings/update_bitbucket:
    description: Manage DevOps Platform Settings
    post:
      description: Update Bitbucket instance Setting. <br/>Requires the 'Administer
        System' permission
      externalDocs:
        description: Sonarqube Documentation for update_bitbucket
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/alm_settings/update_bitbucket
      operationId: v1_get_api_alm_settings_update_bitbucket
      parameters:
      - allowEmptyValue: true
        description: Unique key of the Bitbucket instance setting
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      - description: Optional new value for an unique key of the Bitbucket instance
          setting
        explode: true
        in: query
        name: newKey
        required: false
        schema:
          type: string
        style: form
      - description: Bitbucket personal access token
        explode: true
        in: query
        name: personalAccessToken
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Bitbucket API URL
        explode: true
        in: query
        name: url
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: update bitbucket
  /api/alm_settings/update_bitbucketcloud:
    description: Manage DevOps Platform Settings
    post:
      description: Update Bitbucket Cloud Setting. <br/>Requires the 'Administer System'
        permission
      externalDocs:
        description: Sonarqube Documentation for update_bitbucketcloud
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/alm_settings/update_bitbucketcloud
      operationId: v1_get_api_alm_settings_update_bitbucketcloud
      parameters:
      - allowEmptyValue: true
        description: Bitbucket Cloud Client ID
        explode: true
        in: query
        name: clientId
        required: true
        schema:
          type: string
        style: form
      - description: Optional new value for the Bitbucket Cloud client secret
        explode: true
        in: query
        name: clientSecret
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Unique key of the Bitbucket Cloud setting
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      - description: Optional new value for an unique key of the Bitbucket Cloud setting
        explode: true
        in: query
        name: newKey
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Bitbucket Cloud workspace ID
        explode: true
        in: query
        name: workspace
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: update bitbucketcloud
  /api/alm_settings/update_github:
    description: Manage DevOps Platform Settings
    post:
      description: Update GitHub instance Setting. <br/>Requires the 'Administer System'
        permission
      externalDocs:
        description: Sonarqube Documentation for update_github
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/alm_settings/update_github
      operationId: v1_get_api_alm_settings_update_github
      parameters:
      - allowEmptyValue: true
        description: GitHub API ID
        explode: true
        in: query
        name: appId
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: GitHub App Client ID
        explode: true
        in: query
        name: clientId
        required: true
        schema:
          type: string
        style: form
      - description: GitHub App Client Secret
        explode: true
        in: query
        name: clientSecret
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Unique key of the GitHub instance setting
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      - description: Optional new value for an unique key of the GitHub instance setting
        explode: true
        in: query
        name: newKey
        required: false
        schema:
          type: string
        style: form
      - description: GitHub App private key
        explode: true
        in: query
        name: privateKey
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: GitHub API URL
        explode: true
        in: query
        name: url
        required: true
        schema:
          type: string
        style: form
      - description: GitHub App Webhook Secret
        explode: true
        in: query
        name: webhookSecret
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: update github
  /api/alm_settings/update_gitlab:
    description: Manage DevOps Platform Settings
    post:
      description: Update GitLab instance Setting. <br/>Requires the 'Administer System'
        permission
      externalDocs:
        description: Sonarqube Documentation for update_gitlab
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/alm_settings/update_gitlab
      operationId: v1_get_api_alm_settings_update_gitlab
      parameters:
      - allowEmptyValue: true
        description: Unique key of the GitLab instance setting
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      - description: Optional new value for an unique key of the GitLab instance setting
        explode: true
        in: query
        name: newKey
        required: false
        schema:
          type: string
        style: form
      - description: GitLab personal access token
        explode: true
        in: query
        name: personalAccessToken
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: GitLab API URL
        explode: true
        in: query
        name: url
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: update gitlab
  /api/alm_settings/validate:
    description: Manage DevOps Platform Settings
    get:
      description: Validate an DevOps Platform Setting by checking connectivity and
        permissions<br/>Requires the 'Administer System' permission
      externalDocs:
        description: Sonarqube Documentation for validate
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/alm_settings/validate
      operationId: v1_post_api_alm_settings_validate
      parameters:
      - allowEmptyValue: true
        description: Unique key of the DevOps Platform settings
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: validate
  /api/analysis_cache/get:
    description: Access the analysis cache
    get:
      description: Get the scanner's cached data for a branch. Requires scan permission
        on the project. Data is returned gzipped if the corresponding 'Accept-Encoding'
        header is set in the request.
      externalDocs:
        description: Sonarqube Documentation for get
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/analysis_cache/get
      operationId: v1_post_api_analysis_cache_get
      parameters:
      - description: "Branch key. If not provided, main branch will be used."
        explode: true
        in: query
        name: branch
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Project key
        explode: true
        in: query
        name: project
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: get
  /api/applications/add_project:
    description: Manage applications.
    post:
      description: Add a project to an application.<br/>Requires 'Administrator' permission
        on the application
      externalDocs:
        description: Sonarqube Documentation for add_project
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/applications/add_project
      operationId: v1_get_api_applications_add_project
      parameters:
      - allowEmptyValue: true
        description: Key of the application
        explode: true
        in: query
        name: application
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Key of the project
        explode: true
        in: query
        name: project
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: add project
  /api/applications/create:
    description: Manage applications.
    post:
      description: Create a new application.<br/>Requires 'Administer System' permission
        or 'Create Applications' permission
      externalDocs:
        description: Sonarqube Documentation for create
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/applications/create
      operationId: v1_get_api_applications_create
      parameters:
      - description: Application description
        explode: true
        in: query
        name: description
        required: false
        schema:
          type: string
        style: form
      - description: Application key. A suitable key will be generated if not provided
        explode: true
        in: query
        name: key
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Application name
        explode: true
        in: query
        name: name
        required: true
        schema:
          type: string
        style: form
      - description: "Whether the created application should be visible to everyone,\
          \ or only specific user/groups.<br/>If no visibility is specified, the default\
          \ visibility will be used."
        explode: true
        in: query
        name: visibility
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: create
  /api/applications/create_branch:
    description: Manage applications.
    post:
      description: Create a new branch on a given application.<br/>Requires 'Administrator'
        permission on the application and 'Browse' permission on its child projects
      externalDocs:
        description: Sonarqube Documentation for create_branch
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/applications/create_branch
      operationId: v1_get_api_applications_create_branch
      parameters:
      - allowEmptyValue: true
        description: Application key
        explode: true
        in: query
        name: application
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Branch name
        explode: true
        in: query
        name: branch
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: "Project keys. To set several values, the parameter must be called\
          \ once for each value."
        explode: true
        in: query
        name: project
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: "Project branches. To set main branch, provide an empty value.\
          \ To set several values, the parameter must be called once for each value."
        explode: true
        in: query
        name: projectBranch
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: create branch
  /api/applications/delete:
    description: Manage applications.
    post:
      description: Delete an application definition.<br/>Requires 'Administrator'
        permission on the application
      externalDocs:
        description: Sonarqube Documentation for delete
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/applications/delete
      operationId: v1_get_api_applications_delete
      parameters:
      - allowEmptyValue: true
        description: Application key
        explode: true
        in: query
        name: application
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: delete
  /api/applications/delete_branch:
    description: Manage applications.
    post:
      description: Delete a branch on a given application.<br/>Requires 'Administrator'
        permission on the application
      externalDocs:
        description: Sonarqube Documentation for delete_branch
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/applications/delete_branch
      operationId: v1_get_api_applications_delete_branch
      parameters:
      - allowEmptyValue: true
        description: Application key
        explode: true
        in: query
        name: application
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Branch name
        explode: true
        in: query
        name: branch
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: delete branch
  /api/applications/remove_project:
    description: Manage applications.
    post:
      description: Remove a project from an application<br/>Requires 'Administrator'
        permission on the application
      externalDocs:
        description: Sonarqube Documentation for remove_project
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/applications/remove_project
      operationId: v1_get_api_applications_remove_project
      parameters:
      - allowEmptyValue: true
        description: Key of the application
        explode: true
        in: query
        name: application
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Key of the project
        explode: true
        in: query
        name: project
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: remove project
  /api/applications/set_tags:
    description: Manage applications.
    post:
      description: "Set tags on a application.<br>Requires the following permission:\
        \ 'Administer' rights on the specified application"
      externalDocs:
        description: Sonarqube Documentation for set_tags
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/applications/set_tags
      operationId: v1_get_api_applications_set_tags
      parameters:
      - allowEmptyValue: true
        description: Application key
        explode: true
        in: query
        name: application
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Comma-separated list of tags
        explode: true
        in: query
        name: tags
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: set tags
  /api/applications/show:
    description: Manage applications.
    get:
      description: Returns an application and its associated projects. <br> Requires
        the 'Browse' permission on the application and on its child projects.
      externalDocs:
        description: Sonarqube Documentation for show
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/applications/show
      operationId: v1_post_api_applications_show
      parameters:
      - allowEmptyValue: true
        description: Application key
        explode: true
        in: query
        name: application
        required: true
        schema:
          type: string
        style: form
      - description: Branch name
        explode: true
        in: query
        name: branch
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: show
  /api/applications/update:
    description: Manage applications.
    post:
      description: Update an application.<br/>Requires 'Administrator' permission
        on the application
      externalDocs:
        description: Sonarqube Documentation for update
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/applications/update
      operationId: v1_get_api_applications_update
      parameters:
      - allowEmptyValue: true
        description: Application key
        explode: true
        in: query
        name: application
        required: true
        schema:
          type: string
        style: form
      - description: New description for the application
        explode: true
        in: query
        name: description
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: New name for the application
        explode: true
        in: query
        name: name
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: update
  /api/applications/update_branch:
    description: Manage applications.
    post:
      description: Update a branch on a given application.<br/>Requires 'Administrator'
        permission on the application and 'Browse' permission on its child projects
      externalDocs:
        description: Sonarqube Documentation for update_branch
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/applications/update_branch
      operationId: v1_get_api_applications_update_branch
      parameters:
      - allowEmptyValue: true
        description: Application key
        explode: true
        in: query
        name: application
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Branch name
        explode: true
        in: query
        name: branch
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: New branch name
        explode: true
        in: query
        name: name
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: "Project keys. To set several values, the parameter must be called\
          \ once for each value."
        explode: true
        in: query
        name: project
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: "Project branches. To set main branch, provide an empty value.\
          \ To set several values, the parameter must be called once for each value."
        explode: true
        in: query
        name: projectBranch
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: update branch
  /api/audit_logs/download:
    description: Manage Audit logs
    get:
      description: Returns security related audits of this SonarQube instance. Logs
        are returned in JSON format.<br/>Requires the system administration permission<br/>
      externalDocs:
        description: Sonarqube Documentation for download
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/audit_logs/download
      operationId: v1_post_api_audit_logs_download
      parameters:
      - allowEmptyValue: true
        description: Date in ISO 8601 datetime format (YYYY-MM-DDThh:mm:ss±hh:mm)
          from which the logs will be returned. Inclusive.
        explode: true
        in: query
        name: from
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Date in ISO 8601 datetime format (YYYY-MM-DDThh:mm:ss±hh:mm)
          until which the logs will be returned. Inclusive.
        explode: true
        in: query
        name: to
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: download
  /api/authentication/login:
    description: Handle authentication.
    post:
      description: Authenticate a user.
      externalDocs:
        description: Sonarqube Documentation for login
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/authentication/login
      operationId: v1_get_api_authentication_login
      parameters:
      - allowEmptyValue: true
        description: Login of the user
        explode: true
        in: query
        name: login
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Password of the user
        explode: true
        in: query
        name: password
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: login
  /api/authentication/logout:
    description: Handle authentication.
    post:
      description: Logout a user.
      externalDocs:
        description: Sonarqube Documentation for logout
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/authentication/logout
      operationId: v1_get_api_authentication_logout
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: logout
  /api/authentication/validate:
    description: Handle authentication.
    get:
      description: Check credentials.
      externalDocs:
        description: Sonarqube Documentation for validate
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/authentication/validate
      operationId: v1_post_api_authentication_validate
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: validate
  /api/ce/activity:
    description: Get information on Compute Engine tasks.
    get:
      description: "Search for tasks.<br> Requires the system administration permission,\
        \ or project administration permission if component is set."
      externalDocs:
        description: Sonarqube Documentation for activity
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/ce/activity
      operationId: v1_post_api_ce_activity
      parameters:
      - description: Key of the component (project) to filter on
        explode: true
        in: query
        name: component
        required: false
        schema:
          type: string
        style: form
      - description: Maximum date of end of task processing (inclusive)
        explode: true
        in: query
        name: maxExecutedAt
        required: false
        schema:
          type: string
        style: form
      - description: Minimum date of task submission (inclusive)
        explode: true
        in: query
        name: minSubmittedAt
        required: false
        schema:
          type: string
        style: form
      - description: Filter on the last tasks (only the most recent finished task
          by project)
        explode: true
        in: query
        name: onlyCurrents
        required: false
        schema:
          type: string
        style: form
      - description: 1-based page number
        explode: true
        in: query
        name: p
        required: false
        schema:
          type: string
        style: form
      - description: Page size. Must be greater than 0 and less or equal than 1000
        explode: true
        in: query
        name: ps
        required: false
        schema:
          type: string
        style: form
      - description: "Limit search to: <ul><li>component names that contain the supplied\
          \ string</li><li>component keys that are exactly the same as the supplied\
          \ string</li><li>task ids that are exactly the same as the supplied string</li></ul>"
        explode: true
        in: query
        name: q
        required: false
        schema:
          type: string
        style: form
      - description: Comma separated list of task statuses
        explode: true
        in: query
        name: status
        required: false
        schema:
          type: string
        style: form
      - description: Task type
        explode: true
        in: query
        name: type
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: activity
  /api/ce/activity_status:
    description: Get information on Compute Engine tasks.
    get:
      description: Returns CE activity related metrics.<br>Requires 'Administer System'
        permission or 'Administer' rights on the specified project.
      externalDocs:
        description: Sonarqube Documentation for activity_status
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/ce/activity_status
      operationId: v1_post_api_ce_activity_status
      parameters:
      - description: Key of the component (project) to filter on
        explode: true
        in: query
        name: component
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: activity status
  /api/ce/component:
    description: Get information on Compute Engine tasks.
    get:
      description: "Get the pending tasks, in-progress tasks and the last executed\
        \ task of a given component (usually a project).<br>Requires the following\
        \ permission: 'Browse' on the specified component."
      externalDocs:
        description: Sonarqube Documentation for component
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/ce/component
      operationId: v1_post_api_ce_component
      parameters:
      - allowEmptyValue: true
        explode: true
        in: query
        name: component
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: component
  /api/ce/task:
    description: Get information on Compute Engine tasks.
    get:
      description: "Give Compute Engine task details such as type, status, duration\
        \ and associated component.<br/>Requires one of the following permissions:\
        \ <ul><li>'Administer' at global or project level</li><li>'Execute Analysis'\
        \ at global or project level</li></ul>Since 6.1, field \"logs\" is deprecated\
        \ and its value is always false."
      externalDocs:
        description: Sonarqube Documentation for task
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/ce/task
      operationId: v1_post_api_ce_task
      parameters:
      - description: Comma-separated list of the optional fields to be returned in
          response.
        explode: true
        in: query
        name: additionalFields
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Id of task
        explode: true
        in: query
        name: id
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: task
  /api/components/search:
    description: "Get information about a component (file, directory, project, ...)\
      \ and its ancestors or descendants. Update a project or module key."
    get:
      description: Search for components
      externalDocs:
        description: Sonarqube Documentation for search
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/components/search
      operationId: v1_post_api_components_search
      parameters:
      - description: 1-based page number
        explode: true
        in: query
        name: p
        required: false
        schema:
          type: string
        style: form
      - description: Page size. Must be greater than 0 and less or equal than 500
        explode: true
        in: query
        name: ps
        required: false
        schema:
          type: string
        style: form
      - description: "Limit search to: <ul><li>component names that contain the supplied\
          \ string</li><li>component keys that are exactly the same as the supplied\
          \ string</li></ul><br>The value length of the param must be between 2 and\
          \ 15 (inclusive) characters. In case longer value is provided it will be\
          \ truncated."
        explode: true
        in: query
        name: q
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Comma-separated list of component qualifiers. Filter the results
          with the specified qualifiers. Possible values are:<ul><li>APP - Applications</li><li>VW
          - Portfolios</li><li>SVW - Portfolios</li><li>TRK - Projects</li></ul>
        explode: true
        in: query
        name: qualifiers
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: search
  /api/components/show:
    description: "Get information about a component (file, directory, project, ...)\
      \ and its ancestors or descendants. Update a project or module key."
    get:
      description: "Returns a component (file, directory, project, portfolio…) and\
        \ its ancestors. The ancestors are ordered from the parent to the root project.\
        \ Requires the following permission: 'Browse' on the project of the specified\
        \ component."
      externalDocs:
        description: Sonarqube Documentation for show
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/components/show
      operationId: v1_post_api_components_show
      parameters:
      - description: Branch key. Not available in the community edition.
        explode: true
        in: query
        name: branch
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Component key
        explode: true
        in: query
        name: component
        required: true
        schema:
          type: string
        style: form
      - description: Pull request id. Not available in the community edition.
        explode: true
        in: query
        name: pullRequest
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: show
  /api/components/tree:
    description: "Get information about a component (file, directory, project, ...)\
      \ and its ancestors or descendants. Update a project or module key."
    get:
      description: "Navigate through components based on the chosen strategy.<br>Requires\
        \ the following permission: 'Browse' on the specified project.<br>When limiting\
        \ search with the q parameter, directories are not returned."
      externalDocs:
        description: Sonarqube Documentation for tree
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/components/tree
      operationId: v1_post_api_components_tree
      parameters:
      - description: Ascending sort
        explode: true
        in: query
        name: asc
        required: false
        schema:
          type: string
        style: form
      - description: Branch key. Not available in the community edition.
        explode: true
        in: query
        name: branch
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Base component key. The search is based on this component.
        explode: true
        in: query
        name: component
        required: true
        schema:
          type: string
        style: form
      - description: 1-based page number
        explode: true
        in: query
        name: p
        required: false
        schema:
          type: string
        style: form
      - description: Page size. Must be greater than 0 and less or equal than 500
        explode: true
        in: query
        name: ps
        required: false
        schema:
          type: string
        style: form
      - description: Pull request id. Not available in the community edition.
        explode: true
        in: query
        name: pullRequest
        required: false
        schema:
          type: string
        style: form
      - description: "Limit search to: <ul><li>component names that contain the supplied\
          \ string</li><li>component keys that are exactly the same as the supplied\
          \ string</li></ul>"
        explode: true
        in: query
        name: q
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of component qualifiers. Filter the results
          with the specified qualifiers. Possible values are:<ul><li>APP - Applications</li><li>VW
          - Portfolios</li><li>SVW - Portfolios</li><li>UTS - Test Files</li><li>FIL
          - Files</li><li>DIR - Directories</li><li>TRK - Projects</li></ul>
        explode: true
        in: query
        name: qualifiers
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of sort fields
        explode: true
        in: query
        name: s
        required: false
        schema:
          type: string
        style: form
      - description: "Strategy to search for base component descendants:<ul><li>children:\
          \ return the children components of the base component. Grandchildren components\
          \ are not returned</li><li>all: return all the descendants components of\
          \ the base component. Grandchildren are returned.</li><li>leaves: return\
          \ all the descendant components (files, in general) which don't have other\
          \ children. They are the leaves of the component tree.</li></ul>"
        explode: true
        in: query
        name: strategy
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: tree
  /api/duplications/show:
    description: Get duplication information for a project.
    get:
      description: Get duplications. Require Browse permission on file's project
      externalDocs:
        description: Sonarqube Documentation for show
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/duplications/show
      operationId: v1_post_api_duplications_show
      parameters:
      - allowEmptyValue: true
        description: File key
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: show
  /api/editions/activate_grace_period:
    description: Manage SonarSource commercial editions
    post:
      description: Enable a license 7-days grace period if the Server ID is invalid.
        Require 'Administer System' permission.
      externalDocs:
        description: Sonarqube Documentation for activate_grace_period
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/editions/activate_grace_period
      operationId: v1_get_api_editions_activate_grace_period
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: activate grace period
  /api/editions/set_license:
    description: Manage SonarSource commercial editions
    post:
      description: Set the license for enabling features of commercial editions. Require
        'Administer System' permission.
      externalDocs:
        description: Sonarqube Documentation for set_license
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/editions/set_license
      operationId: v1_get_api_editions_set_license
      parameters:
      - allowEmptyValue: true
        explode: true
        in: query
        name: license
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: set license
  /api/favorites/add:
    description: Manage user favorites
    post:
      description: "Add a component (project, portfolio, etc.) as favorite for the\
        \ authenticated user.<br>Only 100 components by qualifier can be added as\
        \ favorite.<br>Requires authentication and the following permission: 'Browse'\
        \ on the component."
      externalDocs:
        description: Sonarqube Documentation for add
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/favorites/add
      operationId: v1_get_api_favorites_add
      parameters:
      - allowEmptyValue: true
        description: "Component key. Only components with qualifiers TRK, VW, SVW,\
          \ APP are supported"
        explode: true
        in: query
        name: component
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: add
  /api/favorites/remove:
    description: Manage user favorites
    post:
      description: "Remove a component (project, portfolio, application etc.) as favorite\
        \ for the authenticated user.<br>Requires authentication."
      externalDocs:
        description: Sonarqube Documentation for remove
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/favorites/remove
      operationId: v1_get_api_favorites_remove
      parameters:
      - allowEmptyValue: true
        description: Component key
        explode: true
        in: query
        name: component
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: remove
  /api/favorites/search:
    description: Manage user favorites
    get:
      description: Search for the authenticated user favorites.<br>Requires authentication.
      externalDocs:
        description: Sonarqube Documentation for search
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/favorites/search
      operationId: v1_post_api_favorites_search
      parameters:
      - description: 1-based page number
        explode: true
        in: query
        name: p
        required: false
        schema:
          type: string
        style: form
      - description: Page size. Must be greater than 0 and less or equal than 500
        explode: true
        in: query
        name: ps
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: search
  /api/hotspots/change_status:
    description: Read and update Security Hotspots.
    post:
      description: Change the status of a Security Hotpot.<br/>Requires the 'Administer
        Security Hotspot' permission.
      externalDocs:
        description: Sonarqube Documentation for change_status
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/hotspots/change_status
      operationId: v1_get_api_hotspots_change_status
      parameters:
      - description: Comment text.
        explode: true
        in: query
        name: comment
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Key of the Security Hotspot
        explode: true
        in: query
        name: hotspot
        required: true
        schema:
          type: string
        style: form
      - description: "Resolution of the Security Hotspot when new status is REVIEWED,\
          \ otherwise must not be set."
        explode: true
        in: query
        name: resolution
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: New status of the Security Hotspot.
        explode: true
        in: query
        name: status
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: change status
  /api/hotspots/search:
    description: Read and update Security Hotspots.
    get:
      description: "Search for Security Hotpots. <br>Requires the 'Browse' permission\
        \ on the specified project(s). <br>For applications, it also requires 'Browse'\
        \ permission on its child projects. <br>When issue indexing is in progress\
        \ returns 503 service unavailable HTTP code."
      externalDocs:
        description: Sonarqube Documentation for search
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/hotspots/search
      operationId: v1_post_api_hotspots_search
      parameters:
      - description: Branch key. Not available in the community edition.
        explode: true
        in: query
        name: branch
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of CASA categories.
        explode: true
        in: query
        name: casa
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of CWE numbers
        explode: true
        in: query
        name: cwe
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of files. Returns only hotspots found in
          those files
        explode: true
        in: query
        name: files
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of Security Hotspot keys. This parameter
          is required unless project is provided.
        explode: true
        in: query
        name: hotspots
        required: false
        schema:
          type: string
        style: form
      - description: "If 'inNewCodePeriod' is provided, only Security Hotspots created\
          \ in the new code period are returned."
        explode: true
        in: query
        name: inNewCodePeriod
        required: false
        schema:
          type: string
        style: form
      - description: "If 'projectKey' is provided, returns only Security Hotspots\
          \ assigned to the current user"
        explode: true
        in: query
        name: onlyMine
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of OWASP ASVS v4.0 categories or rules.
        explode: true
        in: query
        name: owaspAsvs-4.0
        required: false
        schema:
          type: string
        style: form
      - description: Filters hotspots with lower or equal OWASP ASVS level to the
          parameter value. Should be used in combination with the 'owaspAsvs-4.0'
          parameter.
        explode: true
        in: query
        name: owaspAsvsLevel
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of OWASP 2017 Top 10 lowercase categories.
        explode: true
        in: query
        name: owaspTop10
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of OWASP 2021 Top 10 lowercase categories.
        explode: true
        in: query
        name: owaspTop10-2021
        required: false
        schema:
          type: string
        style: form
      - description: 1-based page number
        explode: true
        in: query
        name: p
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of PCI DSS v3.2 categories.
        explode: true
        in: query
        name: pciDss-3.2
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of PCI DSS v4.0 categories.
        explode: true
        in: query
        name: pciDss-4.0
        required: false
        schema:
          type: string
        style: form
      - description: Key of the project or application. This parameter is required
          unless hotspots is provided.
        explode: true
        in: query
        name: project
        required: false
        schema:
          type: string
        style: form
      - description: Page size. Must be greater than 0.
        explode: true
        in: query
        name: ps
        required: false
        schema:
          type: string
        style: form
      - description: Pull request id. Not available in the community edition.
        explode: true
        in: query
        name: pullRequest
        required: false
        schema:
          type: string
        style: form
      - description: "If 'project' is provided and if status is 'REVIEWED', only Security\
          \ Hotspots with the specified resolution are returned."
        explode: true
        in: query
        name: resolution
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of SANS Top 25 categories.
        explode: true
        in: query
        name: sansTop25
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of SonarSource security categories. Use
          'others' to select issues not associated with any category
        explode: true
        in: query
        name: sonarsourceSecurity
        required: false
        schema:
          type: string
        style: form
      - description: "If 'project' is provided, only Security Hotspots with the specified\
          \ status are returned."
        explode: true
        in: query
        name: status
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of STIG V5R3 lowercase categories.
        explode: true
        in: query
        name: stig-ASD_V5R3
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: search
  /api/hotspots/show:
    description: Read and update Security Hotspots.
    get:
      description: Provides the details of a Security Hotspot.
      externalDocs:
        description: Sonarqube Documentation for show
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/hotspots/show
      operationId: v1_post_api_hotspots_show
      parameters:
      - allowEmptyValue: true
        description: Key of the Security Hotspot
        explode: true
        in: query
        name: hotspot
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: show
  /api/issues/add_comment:
    description: Read and update issues.
    post:
      description: "Add a comment.<br/>Requires authentication and the following permission:\
        \ 'Browse' on the project of the specified issue."
      externalDocs:
        description: Sonarqube Documentation for add_comment
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/issues/add_comment
      operationId: v1_get_api_issues_add_comment
      parameters:
      - allowEmptyValue: true
        description: Issue key
        explode: true
        in: query
        name: issue
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Comment text
        explode: true
        in: query
        name: text
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: add comment
  /api/issues/assign:
    description: Read and update issues.
    post:
      description: Assign/Unassign an issue. Requires authentication and Browse permission
        on project
      externalDocs:
        description: Sonarqube Documentation for assign
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/issues/assign
      operationId: v1_get_api_issues_assign
      parameters:
      - description: "Login of the assignee. When not set, it will unassign the issue.\
          \ Use '_me' to assign to current user"
        explode: true
        in: query
        name: assignee
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Issue key
        explode: true
        in: query
        name: issue
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: assign
  /api/issues/authors:
    description: Read and update issues.
    get:
      description: Search SCM accounts which match a given query.<br/>Requires authentication.<br/>When
        issue indexing is in progress returns 503 service unavailable HTTP code.
      externalDocs:
        description: Sonarqube Documentation for authors
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/issues/authors
      operationId: v1_post_api_issues_authors
      parameters:
      - description: Project key
        explode: true
        in: query
        name: project
        required: false
        schema:
          type: string
        style: form
      - description: Page size. Must be greater than 0 and less or equal than 100
        explode: true
        in: query
        name: ps
        required: false
        schema:
          type: string
        style: form
      - description: Limit search to authors that contain the supplied string.
        explode: true
        in: query
        name: q
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: authors
  /api/issues/bulk_change:
    description: Read and update issues.
    post:
      description: Bulk change on issues. Up to 500 issues can be updated. <br/>Requires
        authentication.
      externalDocs:
        description: Sonarqube Documentation for bulk_change
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/issues/bulk_change
      operationId: v1_get_api_issues_bulk_change
      parameters:
      - description: Add tags
        explode: true
        in: query
        name: add_tags
        required: false
        schema:
          type: string
        style: form
      - description: "To assign the list of issues to a specific user (login), or\
          \ un-assign all the issues"
        explode: true
        in: query
        name: assign
        required: false
        schema:
          type: string
        style: form
      - description: Add a comment. The comment will only be added to issues that
          are affected either by a change of type or a change of severity as a result
          of the same WS call.
        explode: true
        in: query
        name: comment
        required: false
        schema:
          type: string
        style: form
      - description: Transition
        explode: true
        in: query
        name: do_transition
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Comma-separated list of issue keys
        explode: true
        in: query
        name: issues
        required: true
        schema:
          type: string
        style: form
      - description: Remove tags
        explode: true
        in: query
        name: remove_tags
        required: false
        schema:
          type: string
        style: form
      - explode: true
        in: query
        name: sendNotifications
        required: false
        schema:
          type: string
        style: form
      - description: To change the severity of the list of issues
        explode: true
        in: query
        name: set_severity
        required: false
        schema:
          type: string
        style: form
      - description: To change the type of the list of issues
        explode: true
        in: query
        name: set_type
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: bulk change
  /api/issues/changelog:
    description: Read and update issues.
    get:
      description: Display changelog of an issue.<br/>Requires the 'Browse' permission
        on the project of the specified issue.
      externalDocs:
        description: Sonarqube Documentation for changelog
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/issues/changelog
      operationId: v1_post_api_issues_changelog
      parameters:
      - allowEmptyValue: true
        description: Issue key
        explode: true
        in: query
        name: issue
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: changelog
  /api/issues/delete_comment:
    description: Read and update issues.
    post:
      description: "Delete a comment.<br/>Requires authentication and the following\
        \ permission: 'Browse' on the project of the specified issue."
      externalDocs:
        description: Sonarqube Documentation for delete_comment
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/issues/delete_comment
      operationId: v1_get_api_issues_delete_comment
      parameters:
      - allowEmptyValue: true
        description: Comment key
        explode: true
        in: query
        name: comment
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: delete comment
  /api/issues/do_transition:
    description: Read and update issues.
    post:
      description: |
        Do workflow transition on an issue. Requires authentication and Browse permission on project.<br/>
        The transitions 'accept', 'wontfix' and 'falsepositive' require the permission 'Administer Issues'.<br/>
        The transitions involving security hotspots require the permission 'Administer Security Hotspot'.
      externalDocs:
        description: Sonarqube Documentation for do_transition
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/issues/do_transition
      operationId: v1_get_api_issues_do_transition
      parameters:
      - allowEmptyValue: true
        description: Issue key
        explode: true
        in: query
        name: issue
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Transition
        explode: true
        in: query
        name: transition
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: do transition
  /api/issues/edit_comment:
    description: Read and update issues.
    post:
      description: "Edit a comment.<br/>Requires authentication and the following\
        \ permission: 'Browse' on the project of the specified issue."
      externalDocs:
        description: Sonarqube Documentation for edit_comment
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/issues/edit_comment
      operationId: v1_get_api_issues_edit_comment
      parameters:
      - allowEmptyValue: true
        description: Comment key
        explode: true
        in: query
        name: comment
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Comment text
        explode: true
        in: query
        name: text
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: edit comment
  /api/issues/gitlab_sast_export:
    description: Read and update issues.
    get:
      description: Return a list of vulnerabilities according to the Gitlab SAST JSON
        format.<br> The JSON produced can be used in GitLab for generating the Vulnerability
        Report.Requires the 'Browse' or 'Scan' permission on the specified project.
      externalDocs:
        description: Sonarqube Documentation for gitlab_sast_export
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/issues/gitlab_sast_export
      operationId: v1_post_api_issues_gitlab_sast_export
      parameters:
      - description: "Branch key.If this parameter is set, pullRequest must not be\
          \ set."
        explode: true
        in: query
        name: branch
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: The project key for which the vulnerabilities are being fetched
        explode: true
        in: query
        name: projectKey
        required: true
        schema:
          type: string
        style: form
      - description: "Pull request id.If this parameter is set, branch must not be\
          \ set."
        explode: true
        in: query
        name: pullRequest
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: gitlab sast export
  /api/issues/reindex:
    description: Read and update issues.
    post:
      description: Reindex issues for a project.<br> Require 'Administer System' permission.
      externalDocs:
        description: Sonarqube Documentation for reindex
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/issues/reindex
      operationId: v1_get_api_issues_reindex
      parameters:
      - allowEmptyValue: true
        description: Project key
        explode: true
        in: query
        name: project
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: reindex
  /api/issues/search:
    description: Read and update issues.
    get:
      description: "Search for issues.<br>Requires the 'Browse' permission on the\
        \ specified project(s). <br>For applications, it also requires 'Browse' permission\
        \ on its child projects.<br/>When issue indexing is in progress returns 503\
        \ service unavailable HTTP code."
      externalDocs:
        description: Sonarqube Documentation for search
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/issues/search
      operationId: v1_post_api_issues_search
      parameters:
      - description: "Comma-separated list of the optional fields to be returned in\
          \ response. Action plans are dropped in 5.5, it is not returned in the response."
        explode: true
        in: query
        name: additionalFields
        required: false
        schema:
          type: string
        style: form
      - description: Ascending sort
        explode: true
        in: query
        name: asc
        required: false
        schema:
          type: string
        style: form
      - description: To retrieve assigned or unassigned issues
        explode: true
        in: query
        name: assigned
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of assignee logins. The value '__me__' can
          be used as a placeholder for user who performs the request
        explode: true
        in: query
        name: assignees
        required: false
        schema:
          type: string
        style: form
      - description: "SCM accounts. To set several values, the parameter must be called\
          \ once for each value."
        explode: true
        in: query
        name: author
        required: false
        schema:
          type: string
        style: form
      - description: Branch key. Not available in the community edition.
        explode: true
        in: query
        name: branch
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of CASA categories.
        explode: true
        in: query
        name: casa
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of Clean Code Attribute Categories
        explode: true
        in: query
        name: cleanCodeAttributeCategories
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of code variants.
        explode: true
        in: query
        name: codeVariants
        required: false
        schema:
          type: string
        style: form
      - description: "Comma-separated list of component keys. Retrieve issues associated\
          \ to a specific list of components (and all its descendants). A component\
          \ can be a portfolio, project, module, directory or file."
        explode: true
        in: query
        name: components
        required: false
        schema:
          type: string
        style: form
      - description: "To retrieve issues created after the given date (inclusive).\
          \ <br>Either a date (use 'timeZone' attribute or it will default to server\
          \ timezone) or datetime can be provided. <br>If this parameter is set, createdInLast\
          \ must not be set"
        explode: true
        in: query
        name: createdAfter
        required: false
        schema:
          type: string
        style: form
      - description: Datetime to retrieve issues created during a specific analysis
        explode: true
        in: query
        name: createdAt
        required: false
        schema:
          type: string
        style: form
      - description: To retrieve issues created before the given date (exclusive).
          <br>Either a date (use 'timeZone' attribute or it will default to server
          timezone) or datetime can be provided.
        explode: true
        in: query
        name: createdBefore
        required: false
        schema:
          type: string
        style: form
      - description: "To retrieve issues created during a time span before the current\
          \ time (exclusive). Accepted units are 'y' for year, 'm' for month, 'w'\
          \ for week and 'd' for day. If this parameter is set, createdAfter must\
          \ not be set"
        explode: true
        in: query
        name: createdInLast
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of CWE identifiers. Use 'unknown' to select
          issues not associated to any CWE.
        explode: true
        in: query
        name: cwe
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of the facets to be computed. No facet is
          computed by default.
        explode: true
        in: query
        name: facets
        required: false
        schema:
          type: string
        style: form
      - description: Pull request id to filter issues that would be fixed in the specified
          project or branch by the pull request. Should not be used together with
          + 'pullRequest'. At least the 'components' must be be specified when this
          param is used.  Not available in the community edition.
        explode: true
        in: query
        name: fixedInPullRequest
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of Software Quality Severities
        explode: true
        in: query
        name: impactSeverities
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of Software Qualities
        explode: true
        in: query
        name: impactSoftwareQualities
        required: false
        schema:
          type: string
        style: form
      - description: "To retrieve issues created in the new code period.<br>If this\
          \ parameter is set to a truthy value, createdAfter must not be set and one\
          \ component uuid or key must be provided."
        explode: true
        in: query
        name: inNewCodePeriod
        required: false
        schema:
          type: string
        style: form
      - explode: true
        in: query
        name: issueStatuses
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of issue keys
        explode: true
        in: query
        name: issues
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of languages. Available since 4.4
        explode: true
        in: query
        name: languages
        required: false
        schema:
          type: string
        style: form
      - description: "Return only issues at a component's level, not on its descendants\
          \ (modules, directories, files, etc). This parameter is only considered\
          \ when componentKeys is set."
        explode: true
        in: query
        name: onComponentOnly
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of OWASP ASVS v4.0 categories.
        explode: true
        in: query
        name: owaspAsvs-4.0
        required: false
        schema:
          type: string
        style: form
      - description: Level of OWASP ASVS categories.
        explode: true
        in: query
        name: owaspAsvsLevel
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of OWASP Top 10 2017 lowercase categories.
        explode: true
        in: query
        name: owaspTop10
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of OWASP Top 10 2021 lowercase categories.
        explode: true
        in: query
        name: owaspTop10-2021
        required: false
        schema:
          type: string
        style: form
      - description: 1-based page number
        explode: true
        in: query
        name: p
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of PCI DSS v3.2 categories.
        explode: true
        in: query
        name: pciDss-3.2
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of PCI DSS v4.0 categories.
        explode: true
        in: query
        name: pciDss-4.0
        required: false
        schema:
          type: string
        style: form
      - description: To match issues with prioritized rule or not
        explode: true
        in: query
        name: prioritizedRule
        required: false
        schema:
          type: string
        style: form
      - description: Page size. Must be greater than 0 and less or equal than 500
        explode: true
        in: query
        name: ps
        required: false
        schema:
          type: string
        style: form
      - description: Pull request id. Not available in the community edition.
        explode: true
        in: query
        name: pullRequest
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of resolutions
        explode: true
        in: query
        name: resolutions
        required: false
        schema:
          type: string
        style: form
      - description: To match resolved or unresolved issues
        explode: true
        in: query
        name: resolved
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of coding rule keys. Format is &lt;repository&gt;:&lt;rule&gt;
        explode: true
        in: query
        name: rules
        required: false
        schema:
          type: string
        style: form
      - description: Sort field
        explode: true
        in: query
        name: s
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of SANS Top 25 categories.
        explode: true
        in: query
        name: sansTop25
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of scopes. Available since 8.5
        explode: true
        in: query
        name: scopes
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of severities
        explode: true
        in: query
        name: severities
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of SonarSource security categories. Use
          'others' to select issues not associated with any category
        explode: true
        in: query
        name: sonarsourceSecurity
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of statuses
        explode: true
        in: query
        name: statuses
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of STIG V5R3 categories.
        explode: true
        in: query
        name: stig-ASD_V5R3
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of tags.
        explode: true
        in: query
        name: tags
        required: false
        schema:
          type: string
        style: form
      - description: To resolve dates passed to 'createdAfter' or 'createdBefore'
          (does not apply to datetime) and to compute creation date histogram
        explode: true
        in: query
        name: timeZone
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of types.
        explode: true
        in: query
        name: types
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: search
  /api/issues/set_severity:
    description: Read and update issues.
    post:
      description: Change severity.<br/>Requires the following permissions:<ul>  <li>'Authentication'</li>  <li>'Browse'
        rights on project of the specified issue</li>  <li>'Administer Issues' rights
        on project of the specified issue</li></ul>
      externalDocs:
        description: Sonarqube Documentation for set_severity
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/issues/set_severity
      operationId: v1_get_api_issues_set_severity
      parameters:
      - allowEmptyValue: true
        description: Issue key
        explode: true
        in: query
        name: issue
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: New severity
        explode: true
        in: query
        name: severity
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: set severity
  /api/issues/set_tags:
    description: Read and update issues.
    post:
      description: Set tags on an issue. <br/>Requires authentication and Browse permission
        on project
      externalDocs:
        description: Sonarqube Documentation for set_tags
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/issues/set_tags
      operationId: v1_get_api_issues_set_tags
      parameters:
      - allowEmptyValue: true
        description: Issue key
        explode: true
        in: query
        name: issue
        required: true
        schema:
          type: string
        style: form
      - description: Comma-separated list of tags. All tags are removed if parameter
          is empty or not set.
        explode: true
        in: query
        name: tags
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: set tags
  /api/issues/set_type:
    description: Read and update issues.
    post:
      description: "Change type of issue, for instance from 'code smell' to 'bug'.<br/>Requires\
        \ the following permissions:<ul>  <li>'Authentication'</li>  <li>'Browse'\
        \ rights on project of the specified issue</li>  <li>'Administer Issues' rights\
        \ on project of the specified issue</li></ul>"
      externalDocs:
        description: Sonarqube Documentation for set_type
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/issues/set_type
      operationId: v1_get_api_issues_set_type
      parameters:
      - allowEmptyValue: true
        description: Issue key
        explode: true
        in: query
        name: issue
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: New type
        explode: true
        in: query
        name: type
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: set type
  /api/issues/tags:
    description: Read and update issues.
    get:
      description: List tags matching a given query
      externalDocs:
        description: Sonarqube Documentation for tags
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/issues/tags
      operationId: v1_post_api_issues_tags
      parameters:
      - description: Indicator to search for all tags or only for tags in the main
          branch of a project
        explode: true
        in: query
        name: all
        required: false
        schema:
          type: string
        style: form
      - description: Branch key
        explode: true
        in: query
        name: branch
        required: false
        schema:
          type: string
        style: form
      - description: Project key
        explode: true
        in: query
        name: project
        required: false
        schema:
          type: string
        style: form
      - description: Page size. Must be greater than 0 and less or equal than 500
        explode: true
        in: query
        name: ps
        required: false
        schema:
          type: string
        style: form
      - description: Limit search to tags that contain the supplied string.
        explode: true
        in: query
        name: q
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: tags
  /api/languages/list:
    description: Get the list of programming languages supported in this instance.
    get:
      description: List supported programming languages
      externalDocs:
        description: Sonarqube Documentation for list
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/languages/list
      operationId: v1_post_api_languages_list
      parameters:
      - description: "The size of the list to return, 0 for all languages"
        explode: true
        in: query
        name: ps
        required: false
        schema:
          type: string
        style: form
      - description: A pattern to match language keys/names against
        explode: true
        in: query
        name: q
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: list
  /api/measures/component:
    description: Get components or children with specified measures.
    get:
      description: "Return component with specified measures.<br>Requires the following\
        \ permission: 'Browse' on the project of specified component."
      externalDocs:
        description: Sonarqube Documentation for component
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/measures/component
      operationId: v1_post_api_measures_component
      parameters:
      - description: Comma-separated list of additional fields that can be returned
          in the response.
        explode: true
        in: query
        name: additionalFields
        required: false
        schema:
          type: string
        style: form
      - description: Branch key. Not available in the community edition.
        explode: true
        in: query
        name: branch
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Component key
        explode: true
        in: query
        name: component
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Comma-separated list of metric keys
        explode: true
        in: query
        name: metricKeys
        required: true
        schema:
          type: string
        style: form
      - description: Pull request id. Not available in the community edition.
        explode: true
        in: query
        name: pullRequest
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: component
  /api/measures/component_tree:
    description: Get components or children with specified measures.
    get:
      description: "Navigate through components based on the chosen strategy with\
        \ specified measures.<br>Requires the following permission: 'Browse' on the\
        \ specified project.<br>For applications, it also requires 'Browse' permission\
        \ on its child projects. <br>When limiting search with the q parameter, directories\
        \ are not returned."
      externalDocs:
        description: Sonarqube Documentation for component_tree
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/measures/component_tree
      operationId: v1_post_api_measures_component_tree
      parameters:
      - description: Comma-separated list of additional fields that can be returned
          in the response.
        explode: true
        in: query
        name: additionalFields
        required: false
        schema:
          type: string
        style: form
      - description: Ascending sort
        explode: true
        in: query
        name: asc
        required: false
        schema:
          type: string
        style: form
      - description: Branch key. Not available in the community edition.
        explode: true
        in: query
        name: branch
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Component key. The search is based on this component.
        explode: true
        in: query
        name: component
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: "Comma-separated list of metric keys. Types DISTRIB are not allowed.\
          \ For type DATA only reliability_issues, maintainability_issues, security_issues,\
          \ new_reliability_issues, new_security_issues, new_maintainability_issues\
          \ metrics are supported"
        explode: true
        in: query
        name: metricKeys
        required: true
        schema:
          type: string
        style: form
      - description: Sort measures by leak period or not ?. The 's' parameter must
          contain the 'metricPeriod' value.
        explode: true
        in: query
        name: metricPeriodSort
        required: false
        schema:
          type: string
        style: form
      - description: Metric key to sort by. The 's' parameter must contain the 'metric'
          or 'metricPeriod' value. It must be part of the 'metricKeys' parameter
        explode: true
        in: query
        name: metricSort
        required: false
        schema:
          type: string
        style: form
      - description: "Filter components. Sort must be on a metric. Possible values\
          \ are: <ul><li>all: return all components</li><li>withMeasuresOnly: filter\
          \ out components that do not have a measure on the sorted metric</li></ul>"
        explode: true
        in: query
        name: metricSortFilter
        required: false
        schema:
          type: string
        style: form
      - description: 1-based page number
        explode: true
        in: query
        name: p
        required: false
        schema:
          type: string
        style: form
      - description: Page size. Must be greater than 0 and less or equal than 500
        explode: true
        in: query
        name: ps
        required: false
        schema:
          type: string
        style: form
      - description: Pull request id. Not available in the community edition.
        explode: true
        in: query
        name: pullRequest
        required: false
        schema:
          type: string
        style: form
      - description: "Limit search to: <ul><li>component names that contain the supplied\
          \ string</li><li>component keys that are exactly the same as the supplied\
          \ string</li></ul>"
        explode: true
        in: query
        name: q
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of component qualifiers. Filter the results
          with the specified qualifiers. Possible values are:<ul><li>APP - Applications</li><li>VW
          - Portfolios</li><li>SVW - Portfolios</li><li>UTS - Test Files</li><li>FIL
          - Files</li><li>DIR - Directories</li><li>TRK - Projects</li></ul>
        explode: true
        in: query
        name: qualifiers
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of sort fields
        explode: true
        in: query
        name: s
        required: false
        schema:
          type: string
        style: form
      - description: "Strategy to search for base component descendants:<ul><li>children:\
          \ return the children components of the base component. Grandchildren components\
          \ are not returned</li><li>all: return all the descendants components of\
          \ the base component. Grandchildren are returned.</li><li>leaves: return\
          \ all the descendant components (files, in general) which don't have other\
          \ children. They are the leaves of the component tree.</li></ul>"
        explode: true
        in: query
        name: strategy
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: component tree
  /api/measures/search_history:
    description: Get components or children with specified measures.
    get:
      description: "Search measures history of a component.<br>Measures are ordered\
        \ chronologically.<br>Pagination applies to the number of measures for each\
        \ metric.<br>Requires the following permission: 'Browse' on the specified\
        \ component. <br>For applications, it also requires 'Browse' permission on\
        \ its child projects."
      externalDocs:
        description: Sonarqube Documentation for search_history
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/measures/search_history
      operationId: v1_post_api_measures_search_history
      parameters:
      - description: Branch key. Not available in the community edition.
        explode: true
        in: query
        name: branch
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Component key
        explode: true
        in: query
        name: component
        required: true
        schema:
          type: string
        style: form
      - description: Filter measures created after the given date (inclusive). <br>Either
          a date (server timezone) or datetime can be provided
        explode: true
        in: query
        name: from
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Comma-separated list of metric keys
        explode: true
        in: query
        name: metrics
        required: true
        schema:
          type: string
        style: form
      - description: 1-based page number
        explode: true
        in: query
        name: p
        required: false
        schema:
          type: string
        style: form
      - description: Page size. Must be greater than 0 and less or equal than 1000
        explode: true
        in: query
        name: ps
        required: false
        schema:
          type: string
        style: form
      - description: Pull request id. Not available in the community edition.
        explode: true
        in: query
        name: pullRequest
        required: false
        schema:
          type: string
        style: form
      - description: Filter measures created before the given date (inclusive). <br>Either
          a date (server timezone) or datetime can be provided
        explode: true
        in: query
        name: to
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: search history
  /api/metrics/search:
    description: Get information on automatic metrics
    get:
      description: Search for metrics
      externalDocs:
        description: Sonarqube Documentation for search
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/metrics/search
      operationId: v1_post_api_metrics_search
      parameters:
      - description: 1-based page number
        explode: true
        in: query
        name: p
        required: false
        schema:
          type: string
        style: form
      - description: Page size. Must be greater than 0 and less or equal than 500
        explode: true
        in: query
        name: ps
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: search
  /api/metrics/types:
    description: Get information on automatic metrics
    get:
      description: List all available metric types.
      externalDocs:
        description: Sonarqube Documentation for types
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/metrics/types
      operationId: v1_post_api_metrics_types
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: types
  /api/monitoring/metrics:
    description: Monitoring
    get:
      description: "Return monitoring metrics in Prometheus format.  \nSupport content\
        \ type 'text/plain' (default) and 'application/openmetrics-text'.\nThis endpoint\
        \ can be accessed using a Bearer token, which needs to be defined in sonar.properties\
        \ with the 'sonar.web.systemPasscode' key."
      externalDocs:
        description: Sonarqube Documentation for metrics
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/monitoring/metrics
      operationId: v1_post_api_monitoring_metrics
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: metrics
  /api/new_code_periods/list:
    description: Manage <a href="https://sonar-documentations-preview.netlify.app/sonarqube/10.8/project-administration/clean-as-you-code-settings/defining-new-code/"
      target="_blank" rel="noopener noreferrer">new code definition</a>.
    get:
      description: Lists the <a href="https://sonar-documentations-preview.netlify.app/sonarqube/10.8/project-administration/clean-as-you-code-settings/defining-new-code/"
        target="_blank" rel="noopener noreferrer">new code definition</a> for all
        branches in a project.<br>Requires the permission to browse the project
      externalDocs:
        description: Sonarqube Documentation for list
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/new_code_periods/list
      operationId: v1_post_api_new_code_periods_list
      parameters:
      - allowEmptyValue: true
        description: Project key
        explode: true
        in: query
        name: project
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: list
  /api/new_code_periods/set:
    description: Manage <a href="https://sonar-documentations-preview.netlify.app/sonarqube/10.8/project-administration/clean-as-you-code-settings/defining-new-code/"
      target="_blank" rel="noopener noreferrer">new code definition</a>.
    post:
      description: "Updates the <a href=\"https://sonar-documentations-preview.netlify.app/sonarqube/10.8/project-administration/clean-as-you-code-settings/defining-new-code/\"\
        \ target=\"_blank\" rel=\"noopener noreferrer\">new code definition</a> on\
        \ different levels:<br><ul><li>Not providing a project key and a branch key\
        \ will update the default value at global level. Existing projects or branches\
        \ having a specific new code definition will not be impacted</li><li>Project\
        \ key must be provided to update the value for a project</li><li>Both project\
        \ and branch keys must be provided to update the value for a branch</li></ul>Requires\
        \ one of the following permissions: <ul><li>'Administer System' to change\
        \ the global setting</li><li>'Administer' rights on the specified project\
        \ to change the project setting</li></ul>"
      externalDocs:
        description: Sonarqube Documentation for set
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/new_code_periods/set
      operationId: v1_get_api_new_code_periods_set
      parameters:
      - description: Branch key
        explode: true
        in: query
        name: branch
        required: false
        schema:
          type: string
        style: form
      - description: Project key
        explode: true
        in: query
        name: project
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: "Type<br/>New code definitions of the following types are allowed:<ul><li>SPECIFIC_ANALYSIS\
          \ - can be set at branch level only</li><li>PREVIOUS_VERSION - can be set\
          \ at any level (global, project, branch)</li><li>NUMBER_OF_DAYS - can be\
          \ set at any level (global, project, branch)</li><li>REFERENCE_BRANCH -\
          \ can only be set for projects and branches</li></ul>"
        explode: true
        in: query
        name: type
        required: true
        schema:
          type: string
        style: form
      - description: "Value<br/>For each type, a different value is expected:<ul><li>the\
          \ uuid of an analysis, when type is SPECIFIC_ANALYSIS</li><li>no value,\
          \ when type is PREVIOUS_VERSION</li><li>a number between 1 and 90, when\
          \ type is NUMBER_OF_DAYS</li><li>a string, when type is REFERENCE_BRANCH</li></ul>"
        explode: true
        in: query
        name: value
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: set
  /api/new_code_periods/show:
    description: Manage <a href="https://sonar-documentations-preview.netlify.app/sonarqube/10.8/project-administration/clean-as-you-code-settings/defining-new-code/"
      target="_blank" rel="noopener noreferrer">new code definition</a>.
    get:
      description: "Shows the <a href=\"https://sonar-documentations-preview.netlify.app/sonarqube/10.8/project-administration/clean-as-you-code-settings/defining-new-code/\"\
        \ target=\"_blank\" rel=\"noopener noreferrer\">new code definition</a>.<br>\
        \ If the component requested doesn't exist or if no new code definition is\
        \ set for it, a value is inherited from the project or from the global setting.Requires\
        \ one of the following permissions if a component is specified: <ul><li>'Administer'\
        \ rights on the specified component</li><li>'Execute analysis' rights on the\
        \ specified component</li></ul>"
      externalDocs:
        description: Sonarqube Documentation for show
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/new_code_periods/show
      operationId: v1_post_api_new_code_periods_show
      parameters:
      - description: Branch key
        explode: true
        in: query
        name: branch
        required: false
        schema:
          type: string
        style: form
      - description: Project key
        explode: true
        in: query
        name: project
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: show
  /api/new_code_periods/unset:
    description: Manage <a href="https://sonar-documentations-preview.netlify.app/sonarqube/10.8/project-administration/clean-as-you-code-settings/defining-new-code/"
      target="_blank" rel="noopener noreferrer">new code definition</a>.
    post:
      description: "Unsets the <a href=\"https://sonar-documentations-preview.netlify.app/sonarqube/10.8/project-administration/clean-as-you-code-settings/defining-new-code/\"\
        \ target=\"_blank\" rel=\"noopener noreferrer\">new code definition</a> for\
        \ a branch, project or global. It requires the inherited New Code Definition\
        \ to be compatible with the Clean as You Code methodology, and one of the\
        \ following permissions: <ul><li>'Administer System' to change the global\
        \ setting</li><li>'Administer' rights for a specified component</li></ul>"
      externalDocs:
        description: Sonarqube Documentation for unset
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/new_code_periods/unset
      operationId: v1_get_api_new_code_periods_unset
      parameters:
      - description: Branch key
        explode: true
        in: query
        name: branch
        required: false
        schema:
          type: string
        style: form
      - description: Project key
        explode: true
        in: query
        name: project
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: unset
  /api/notifications/add:
    description: Manage notifications of the authenticated user
    post:
      description: "Add a notification for the authenticated user.<br>Requires one\
        \ of the following permissions:<ul> <li>Authentication if no login is provided.\
        \ If a project is provided, requires the 'Browse' permission on the specified\
        \ project.</li> <li>System administration if a login is provided. If a project\
        \ is provided, requires the 'Browse' permission on the specified project.</li></ul>"
      externalDocs:
        description: Sonarqube Documentation for add
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/notifications/add
      operationId: v1_get_api_notifications_add
      parameters:
      - description: "Channel through which the notification is sent. For example,\
          \ notifications can be sent by email."
        explode: true
        in: query
        name: channel
        required: false
        schema:
          type: string
        style: form
      - description: User login
        explode: true
        in: query
        name: login
        required: false
        schema:
          type: string
        style: form
      - description: Project key
        explode: true
        in: query
        name: project
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: "Notification type. Possible values are for:<ul>  <li>Global\
          \ notifications: CeReportTaskFailure, ChangesOnMyIssue, NewAlerts, SQ-MyNewIssues</li>\
          \  <li>Per project notifications: CeReportTaskFailure, ChangesOnMyIssue,\
          \ NewAlerts, NewFalsePositiveIssue, NewIssues, SQ-MyNewIssues</li></ul>"
        explode: true
        in: query
        name: type
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: add
  /api/notifications/list:
    description: Manage notifications of the authenticated user
    get:
      description: List notifications of the authenticated user.<br>Requires one of
        the following permissions:<ul>  <li>Authentication if no login is provided</li>  <li>System
        administration if a login is provided</li></ul>
      externalDocs:
        description: Sonarqube Documentation for list
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/notifications/list
      operationId: v1_post_api_notifications_list
      parameters:
      - description: User login
        explode: true
        in: query
        name: login
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: list
  /api/notifications/remove:
    description: Manage notifications of the authenticated user
    post:
      description: Remove a notification for the authenticated user.<br>Requires one
        of the following permissions:<ul>  <li>Authentication if no login is provided</li>  <li>System
        administration if a login is provided</li></ul>
      externalDocs:
        description: Sonarqube Documentation for remove
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/notifications/remove
      operationId: v1_get_api_notifications_remove
      parameters:
      - description: "Channel through which the notification is sent. For example,\
          \ notifications can be sent by email."
        explode: true
        in: query
        name: channel
        required: false
        schema:
          type: string
        style: form
      - description: User login
        explode: true
        in: query
        name: login
        required: false
        schema:
          type: string
        style: form
      - description: Project key
        explode: true
        in: query
        name: project
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: "Notification type. Possible values are for:<ul>  <li>Global\
          \ notifications: CeReportTaskFailure, ChangesOnMyIssue, NewAlerts, SQ-MyNewIssues</li>\
          \  <li>Per project notifications: CeReportTaskFailure, ChangesOnMyIssue,\
          \ NewAlerts, NewFalsePositiveIssue, NewIssues, SQ-MyNewIssues</li></ul>"
        explode: true
        in: query
        name: type
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: remove
  /api/permissions/add_group:
    description: "Manage permission templates, and the granting and revoking of permissions\
      \ at the global and project levels."
    post:
      description: "Add a permission to a group.<br /> This service defaults to global\
        \ permissions, but can be limited to project permissions by providing project\
        \ id or project key.<br /> The group name must be provided. <br />Requires\
        \ one of the following permissions:<ul><li>'Administer System'</li><li>'Administer'\
        \ rights on the specified project</li></ul>"
      externalDocs:
        description: Sonarqube Documentation for add_group
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/permissions/add_group
      operationId: v1_get_api_permissions_add_group
      parameters:
      - allowEmptyValue: true
        description: Group name or 'anyone' (case insensitive)
        explode: true
        in: query
        name: groupName
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: "The permission you would like to grant to the group.<ul><li>Possible\
          \ values for global permissions: admin, gateadmin, profileadmin, provisioning,\
          \ scan, applicationcreator, portfoliocreator</li><li>Possible values for\
          \ project permissions admin, codeviewer, issueadmin, securityhotspotadmin,\
          \ scan, user</li></ul>"
        explode: true
        in: query
        name: permission
        required: true
        schema:
          type: string
        style: form
      - description: Project id
        explode: true
        in: query
        name: projectId
        required: false
        schema:
          type: string
        style: form
      - description: Project key
        explode: true
        in: query
        name: projectKey
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: add group
  /api/permissions/add_group_to_template:
    description: "Manage permission templates, and the granting and revoking of permissions\
      \ at the global and project levels."
    post:
      description: "Add a group to a permission template.<br /> The group name must\
        \ be provided. <br />Requires the following permission: 'Administer System'."
      externalDocs:
        description: Sonarqube Documentation for add_group_to_template
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/permissions/add_group_to_template
      operationId: v1_get_api_permissions_add_group_to_template
      parameters:
      - allowEmptyValue: true
        description: Group name or 'anyone' (case insensitive)
        explode: true
        in: query
        name: groupName
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: "Permission<ul><li>Possible values for project permissions admin,\
          \ codeviewer, issueadmin, securityhotspotadmin, scan, user</li></ul>"
        explode: true
        in: query
        name: permission
        required: true
        schema:
          type: string
        style: form
      - description: Template id
        explode: true
        in: query
        name: templateId
        required: false
        schema:
          type: string
        style: form
      - description: Template name
        explode: true
        in: query
        name: templateName
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: add group to template
  /api/permissions/add_project_creator_to_template:
    description: "Manage permission templates, and the granting and revoking of permissions\
      \ at the global and project levels."
    post:
      description: "Add a project creator to a permission template.<br>Requires the\
        \ following permission: 'Administer System'."
      externalDocs:
        description: Sonarqube Documentation for add_project_creator_to_template
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/permissions/add_project_creator_to_template
      operationId: v1_get_api_permissions_add_project_creator_to_template
      parameters:
      - allowEmptyValue: true
        description: "Permission<ul><li>Possible values for project permissions admin,\
          \ codeviewer, issueadmin, securityhotspotadmin, scan, user</li></ul>"
        explode: true
        in: query
        name: permission
        required: true
        schema:
          type: string
        style: form
      - description: Template id
        explode: true
        in: query
        name: templateId
        required: false
        schema:
          type: string
        style: form
      - description: Template name
        explode: true
        in: query
        name: templateName
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: add project creator to template
  /api/permissions/add_user:
    description: "Manage permission templates, and the granting and revoking of permissions\
      \ at the global and project levels."
    post:
      description: "Add permission to a user.<br /> This service defaults to global\
        \ permissions, but can be limited to project permissions by providing project\
        \ id or project key.<br />Requires one of the following permissions:<ul><li>'Administer\
        \ System'</li><li>'Administer' rights on the specified project</li></ul>"
      externalDocs:
        description: Sonarqube Documentation for add_user
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/permissions/add_user
      operationId: v1_get_api_permissions_add_user
      parameters:
      - allowEmptyValue: true
        description: User login
        explode: true
        in: query
        name: login
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: "The permission you would like to grant to the user<ul><li>Possible\
          \ values for global permissions: admin, gateadmin, profileadmin, provisioning,\
          \ scan, applicationcreator, portfoliocreator</li><li>Possible values for\
          \ project permissions admin, codeviewer, issueadmin, securityhotspotadmin,\
          \ scan, user</li></ul>"
        explode: true
        in: query
        name: permission
        required: true
        schema:
          type: string
        style: form
      - description: Project id
        explode: true
        in: query
        name: projectId
        required: false
        schema:
          type: string
        style: form
      - description: Project key
        explode: true
        in: query
        name: projectKey
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: add user
  /api/permissions/add_user_to_template:
    description: "Manage permission templates, and the granting and revoking of permissions\
      \ at the global and project levels."
    post:
      description: "Add a user to a permission template.<br /> Requires the following\
        \ permission: 'Administer System'."
      externalDocs:
        description: Sonarqube Documentation for add_user_to_template
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/permissions/add_user_to_template
      operationId: v1_get_api_permissions_add_user_to_template
      parameters:
      - allowEmptyValue: true
        description: User login
        explode: true
        in: query
        name: login
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: "Permission<ul><li>Possible values for project permissions admin,\
          \ codeviewer, issueadmin, securityhotspotadmin, scan, user</li></ul>"
        explode: true
        in: query
        name: permission
        required: true
        schema:
          type: string
        style: form
      - description: Template id
        explode: true
        in: query
        name: templateId
        required: false
        schema:
          type: string
        style: form
      - description: Template name
        explode: true
        in: query
        name: templateName
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: add user to template
  /api/permissions/apply_template:
    description: "Manage permission templates, and the granting and revoking of permissions\
      \ at the global and project levels."
    post:
      description: "Apply a permission template to one project.<br>The project id\
        \ or project key must be provided.<br>The template id or name must be provided.<br>Requires\
        \ the following permission: 'Administer System'."
      externalDocs:
        description: Sonarqube Documentation for apply_template
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/permissions/apply_template
      operationId: v1_get_api_permissions_apply_template
      parameters:
      - description: Project id
        explode: true
        in: query
        name: projectId
        required: false
        schema:
          type: string
        style: form
      - description: Project key
        explode: true
        in: query
        name: projectKey
        required: false
        schema:
          type: string
        style: form
      - description: Template id
        explode: true
        in: query
        name: templateId
        required: false
        schema:
          type: string
        style: form
      - description: Template name
        explode: true
        in: query
        name: templateName
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: apply template
  /api/permissions/bulk_apply_template:
    description: "Manage permission templates, and the granting and revoking of permissions\
      \ at the global and project levels."
    post:
      description: "Apply a permission template to several components. Managed projects\
        \ will be ignored.<br />The template id or name must be provided.<br />Requires\
        \ the following permission: 'Administer System'."
      externalDocs:
        description: Sonarqube Documentation for bulk_apply_template
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/permissions/bulk_apply_template
      operationId: v1_get_api_permissions_bulk_apply_template
      parameters:
      - description: Filter the projects for which last analysis is older than the
          given date (exclusive).<br> Either a date (server timezone) or datetime
          can be provided.
        explode: true
        in: query
        name: analyzedBefore
        required: false
        schema:
          type: string
        style: form
      - description: Filter the projects that are provisioned
        explode: true
        in: query
        name: onProvisionedOnly
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of project keys
        explode: true
        in: query
        name: projects
        required: false
        schema:
          type: string
        style: form
      - description: "Limit search to: <ul><li>project names that contain the supplied\
          \ string</li><li>project keys that are exactly the same as the supplied\
          \ string</li></ul>"
        explode: true
        in: query
        name: q
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of component qualifiers. Filter the results
          with the specified qualifiers. Possible values are:<ul><li>APP - Applications</li><li>TRK
          - Projects</li><li>VW - Portfolios</li></ul>
        explode: true
        in: query
        name: qualifiers
        required: false
        schema:
          type: string
        style: form
      - description: Template id
        explode: true
        in: query
        name: templateId
        required: false
        schema:
          type: string
        style: form
      - description: Template name
        explode: true
        in: query
        name: templateName
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: bulk apply template
  /api/permissions/create_template:
    description: "Manage permission templates, and the granting and revoking of permissions\
      \ at the global and project levels."
    post:
      description: "Create a permission template.<br />Requires the following permission:\
        \ 'Administer System'."
      externalDocs:
        description: Sonarqube Documentation for create_template
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/permissions/create_template
      operationId: v1_get_api_permissions_create_template
      parameters:
      - description: Description
        explode: true
        in: query
        name: description
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Name
        explode: true
        in: query
        name: name
        required: true
        schema:
          type: string
        style: form
      - description: Project key pattern. Must be a valid Java regular expression
        explode: true
        in: query
        name: projectKeyPattern
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: create template
  /api/permissions/delete_template:
    description: "Manage permission templates, and the granting and revoking of permissions\
      \ at the global and project levels."
    post:
      description: "Delete a permission template.<br />Requires the following permission:\
        \ 'Administer System'."
      externalDocs:
        description: Sonarqube Documentation for delete_template
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/permissions/delete_template
      operationId: v1_get_api_permissions_delete_template
      parameters:
      - description: Template id
        explode: true
        in: query
        name: templateId
        required: false
        schema:
          type: string
        style: form
      - description: Template name
        explode: true
        in: query
        name: templateName
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: delete template
  /api/permissions/remove_group:
    description: "Manage permission templates, and the granting and revoking of permissions\
      \ at the global and project levels."
    post:
      description: "Remove a permission from a group.<br /> This service defaults\
        \ to global permissions, but can be limited to project permissions by providing\
        \ project id or project key.<br /> The group name must be provided.<br />Requires\
        \ one of the following permissions:<ul><li>'Administer System'</li><li>'Administer'\
        \ rights on the specified project</li></ul>"
      externalDocs:
        description: Sonarqube Documentation for remove_group
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/permissions/remove_group
      operationId: v1_get_api_permissions_remove_group
      parameters:
      - allowEmptyValue: true
        description: Group name or 'anyone' (case insensitive)
        explode: true
        in: query
        name: groupName
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: "The permission you would like to revoke from the group.<ul><li>Possible\
          \ values for global permissions: admin, gateadmin, profileadmin, provisioning,\
          \ scan, applicationcreator, portfoliocreator</li><li>Possible values for\
          \ project permissions admin, codeviewer, issueadmin, securityhotspotadmin,\
          \ scan, user</li></ul>"
        explode: true
        in: query
        name: permission
        required: true
        schema:
          type: string
        style: form
      - description: Project id
        explode: true
        in: query
        name: projectId
        required: false
        schema:
          type: string
        style: form
      - description: Project key
        explode: true
        in: query
        name: projectKey
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: remove group
  /api/permissions/remove_group_from_template:
    description: "Manage permission templates, and the granting and revoking of permissions\
      \ at the global and project levels."
    post:
      description: "Remove a group from a permission template.<br /> The group name\
        \ must be provided. <br />Requires the following permission: 'Administer System'."
      externalDocs:
        description: Sonarqube Documentation for remove_group_from_template
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/permissions/remove_group_from_template
      operationId: v1_get_api_permissions_remove_group_from_template
      parameters:
      - allowEmptyValue: true
        description: Group name or 'anyone' (case insensitive)
        explode: true
        in: query
        name: groupName
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: "Permission<ul><li>Possible values for project permissions admin,\
          \ codeviewer, issueadmin, securityhotspotadmin, scan, user</li></ul>"
        explode: true
        in: query
        name: permission
        required: true
        schema:
          type: string
        style: form
      - description: Template id
        explode: true
        in: query
        name: templateId
        required: false
        schema:
          type: string
        style: form
      - description: Template name
        explode: true
        in: query
        name: templateName
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: remove group from template
  /api/permissions/remove_project_creator_from_template:
    description: "Manage permission templates, and the granting and revoking of permissions\
      \ at the global and project levels."
    post:
      description: "Remove a project creator from a permission template.<br>Requires\
        \ the following permission: 'Administer System'."
      externalDocs:
        description: Sonarqube Documentation for remove_project_creator_from_template
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/permissions/remove_project_creator_from_template
      operationId: v1_get_api_permissions_remove_project_creator_from_template
      parameters:
      - allowEmptyValue: true
        description: "Permission<ul><li>Possible values for project permissions admin,\
          \ codeviewer, issueadmin, securityhotspotadmin, scan, user</li></ul>"
        explode: true
        in: query
        name: permission
        required: true
        schema:
          type: string
        style: form
      - description: Template id
        explode: true
        in: query
        name: templateId
        required: false
        schema:
          type: string
        style: form
      - description: Template name
        explode: true
        in: query
        name: templateName
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: remove project creator from template
  /api/permissions/remove_user:
    description: "Manage permission templates, and the granting and revoking of permissions\
      \ at the global and project levels."
    post:
      description: "Remove permission from a user.<br /> This service defaults to\
        \ global permissions, but can be limited to project permissions by providing\
        \ project id or project key.<br /> Requires one of the following permissions:<ul><li>'Administer\
        \ System'</li><li>'Administer' rights on the specified project</li></ul>"
      externalDocs:
        description: Sonarqube Documentation for remove_user
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/permissions/remove_user
      operationId: v1_get_api_permissions_remove_user
      parameters:
      - allowEmptyValue: true
        description: User login
        explode: true
        in: query
        name: login
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: "The permission you would like to revoke from the user.<ul><li>Possible\
          \ values for global permissions: admin, gateadmin, profileadmin, provisioning,\
          \ scan, applicationcreator, portfoliocreator</li><li>Possible values for\
          \ project permissions admin, codeviewer, issueadmin, securityhotspotadmin,\
          \ scan, user</li></ul>"
        explode: true
        in: query
        name: permission
        required: true
        schema:
          type: string
        style: form
      - description: Project id
        explode: true
        in: query
        name: projectId
        required: false
        schema:
          type: string
        style: form
      - description: Project key
        explode: true
        in: query
        name: projectKey
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: remove user
  /api/permissions/remove_user_from_template:
    description: "Manage permission templates, and the granting and revoking of permissions\
      \ at the global and project levels."
    post:
      description: "Remove a user from a permission template.<br /> Requires the following\
        \ permission: 'Administer System'."
      externalDocs:
        description: Sonarqube Documentation for remove_user_from_template
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/permissions/remove_user_from_template
      operationId: v1_get_api_permissions_remove_user_from_template
      parameters:
      - allowEmptyValue: true
        description: User login
        explode: true
        in: query
        name: login
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: "Permission<ul><li>Possible values for project permissions admin,\
          \ codeviewer, issueadmin, securityhotspotadmin, scan, user</li></ul>"
        explode: true
        in: query
        name: permission
        required: true
        schema:
          type: string
        style: form
      - description: Template id
        explode: true
        in: query
        name: templateId
        required: false
        schema:
          type: string
        style: form
      - description: Template name
        explode: true
        in: query
        name: templateName
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: remove user from template
  /api/permissions/search_templates:
    description: "Manage permission templates, and the granting and revoking of permissions\
      \ at the global and project levels."
    get:
      description: "List permission templates.<br />Requires the following permission:\
        \ 'Administer System'."
      externalDocs:
        description: Sonarqube Documentation for search_templates
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/permissions/search_templates
      operationId: v1_post_api_permissions_search_templates
      parameters:
      - description: Limit search to permission template names that contain the supplied
          string.
        explode: true
        in: query
        name: q
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: search templates
  /api/permissions/set_default_template:
    description: "Manage permission templates, and the granting and revoking of permissions\
      \ at the global and project levels."
    post:
      description: "Set a permission template as default.<br />Requires the following\
        \ permission: 'Administer System'."
      externalDocs:
        description: Sonarqube Documentation for set_default_template
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/permissions/set_default_template
      operationId: v1_get_api_permissions_set_default_template
      parameters:
      - description: Project qualifier. Filter the results with the specified qualifier.
          Possible values are:<ul><li>APP - Applications</li><li>TRK - Projects</li><li>VW
          - Portfolios</li></ul>
        explode: true
        in: query
        name: qualifier
        required: false
        schema:
          type: string
        style: form
      - description: Template id
        explode: true
        in: query
        name: templateId
        required: false
        schema:
          type: string
        style: form
      - description: Template name
        explode: true
        in: query
        name: templateName
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: set default template
  /api/permissions/update_template:
    description: "Manage permission templates, and the granting and revoking of permissions\
      \ at the global and project levels."
    post:
      description: "Update a permission template.<br />Requires the following permission:\
        \ 'Administer System'."
      externalDocs:
        description: Sonarqube Documentation for update_template
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/permissions/update_template
      operationId: v1_get_api_permissions_update_template
      parameters:
      - description: Description
        explode: true
        in: query
        name: description
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Id
        explode: true
        in: query
        name: id
        required: true
        schema:
          type: string
        style: form
      - description: Name
        explode: true
        in: query
        name: name
        required: false
        schema:
          type: string
        style: form
      - description: Project key pattern. Must be a valid Java regular expression
        explode: true
        in: query
        name: projectKeyPattern
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: update template
  /api/plugins/available:
    description: "Manage the plugins on the server, including installing, uninstalling,\
      \ and upgrading."
    get:
      description: "Get the list of all the plugins available for installation on\
        \ the SonarQube instance, sorted by plugin name.<br/>Plugin information is\
        \ retrieved from Update Center. Date and time at which Update Center was last\
        \ refreshed is provided in the response.<br/>Update status values are: <ul><li>COMPATIBLE:\
        \ plugin is compatible with current SonarQube instance.</li><li>INCOMPATIBLE:\
        \ plugin is not compatible with current SonarQube instance.</li><li>REQUIRES_SYSTEM_UPGRADE:\
        \ plugin requires SonarQube to be upgraded before being installed.</li><li>DEPS_REQUIRE_SYSTEM_UPGRADE:\
        \ at least one plugin on which the plugin is dependent requires SonarQube\
        \ to be upgraded.</li></ul>Require 'Administer System' permission."
      externalDocs:
        description: Sonarqube Documentation for available
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/plugins/available
      operationId: v1_post_api_plugins_available
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: available
  /api/plugins/cancel_all:
    description: "Manage the plugins on the server, including installing, uninstalling,\
      \ and upgrading."
    post:
      description: "Cancels any operation pending on any plugin (install, update or\
        \ uninstall)<br/>Requires user to be authenticated with Administer System\
        \ permissions"
      externalDocs:
        description: Sonarqube Documentation for cancel_all
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/plugins/cancel_all
      operationId: v1_get_api_plugins_cancel_all
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: cancel all
  /api/plugins/install:
    description: "Manage the plugins on the server, including installing, uninstalling,\
      \ and upgrading."
    post:
      description: Installs the latest version of a plugin specified by its key.<br/>Plugin
        information is retrieved from Update Center.<br/>Fails if used on commercial
        editions or plugin risk consent has not been accepted.<br/>Requires user to
        be authenticated with Administer System permissions
      externalDocs:
        description: Sonarqube Documentation for install
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/plugins/install
      operationId: v1_get_api_plugins_install
      parameters:
      - allowEmptyValue: true
        description: The key identifying the plugin to install
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: install
  /api/plugins/installed:
    description: "Manage the plugins on the server, including installing, uninstalling,\
      \ and upgrading."
    get:
      description: "Get the list of all the plugins installed on the SonarQube instance,\
        \ sorted by plugin name.<br/>Requires authentication."
      externalDocs:
        description: Sonarqube Documentation for installed
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/plugins/installed
      operationId: v1_post_api_plugins_installed
      parameters:
      - description: Comma-separated list of the additional fields to be returned
          in response. No additional field is returned by default. Possible values
          are:<ul><li>category - category as defined in the Update Center. A connection
          to the Update Center is needed</li></ul>
        explode: true
        in: query
        name: f
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: installed
  /api/plugins/pending:
    description: "Manage the plugins on the server, including installing, uninstalling,\
      \ and upgrading."
    get:
      description: "Get the list of plugins which will either be installed or removed\
        \ at the next startup of the SonarQube instance, sorted by plugin name.<br/>Require\
        \ 'Administer System' permission."
      externalDocs:
        description: Sonarqube Documentation for pending
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/plugins/pending
      operationId: v1_post_api_plugins_pending
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: pending
  /api/plugins/uninstall:
    description: "Manage the plugins on the server, including installing, uninstalling,\
      \ and upgrading."
    post:
      description: Uninstalls the plugin specified by its key.<br/>Requires user to
        be authenticated with Administer System permissions.
      externalDocs:
        description: Sonarqube Documentation for uninstall
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/plugins/uninstall
      operationId: v1_get_api_plugins_uninstall
      parameters:
      - allowEmptyValue: true
        description: The key identifying the plugin to uninstall
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: uninstall
  /api/plugins/update:
    description: "Manage the plugins on the server, including installing, uninstalling,\
      \ and upgrading."
    post:
      description: Updates a plugin specified by its key to the latest version compatible
        with the SonarQube instance.<br/>Plugin information is retrieved from Update
        Center.<br/>Requires user to be authenticated with Administer System permissions
      externalDocs:
        description: Sonarqube Documentation for update
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/plugins/update
      operationId: v1_get_api_plugins_update
      parameters:
      - allowEmptyValue: true
        description: The key identifying the plugin to update
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: update
  /api/plugins/updates:
    description: "Manage the plugins on the server, including installing, uninstalling,\
      \ and upgrading."
    get:
      description: "Lists plugins installed on the SonarQube instance for which at\
        \ least one newer version is available, sorted by plugin name.<br/>Each newer\
        \ version is listed, ordered from the oldest to the newest, with its own update/compatibility\
        \ status.<br/>Plugin information is retrieved from Update Center. Date and\
        \ time at which Update Center was last refreshed is provided in the response.<br/>Update\
        \ status values are: [COMPATIBLE, INCOMPATIBLE, REQUIRES_UPGRADE, DEPS_REQUIRE_UPGRADE].<br/>Require\
        \ 'Administer System' permission."
      externalDocs:
        description: Sonarqube Documentation for updates
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/plugins/updates
      operationId: v1_post_api_plugins_updates
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: updates
  /api/project_analyses/create_event:
    description: Manage project analyses.
    post:
      description: Create a project analysis event.<br>Only event of category 'VERSION'
        and 'OTHER' can be created.<br>Requires one of the following permissions:<ul>  <li>'Administer
        System'</li>  <li>'Administer' rights on the specified project</li></ul>
      externalDocs:
        description: Sonarqube Documentation for create_event
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/project_analyses/create_event
      operationId: v1_get_api_project_analyses_create_event
      parameters:
      - allowEmptyValue: true
        description: Analysis key
        explode: true
        in: query
        name: analysis
        required: true
        schema:
          type: string
        style: form
      - description: Category
        explode: true
        in: query
        name: category
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Name
        explode: true
        in: query
        name: name
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: create event
  /api/project_analyses/delete:
    description: Manage project analyses.
    post:
      description: Delete a project analysis.<br>Requires one of the following permissions:<ul>  <li>'Administer
        System'</li>  <li>'Administer' rights on the project of the specified analysis</li></ul>
      externalDocs:
        description: Sonarqube Documentation for delete
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/project_analyses/delete
      operationId: v1_get_api_project_analyses_delete
      parameters:
      - allowEmptyValue: true
        description: Analysis key
        explode: true
        in: query
        name: analysis
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: delete
  /api/project_analyses/delete_event:
    description: Manage project analyses.
    post:
      description: Delete a project analysis event.<br>Only event of category 'VERSION'
        and 'OTHER' can be deleted.<br>Requires one of the following permissions:<ul>  <li>'Administer
        System'</li>  <li>'Administer' rights on the specified project</li></ul>
      externalDocs:
        description: Sonarqube Documentation for delete_event
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/project_analyses/delete_event
      operationId: v1_get_api_project_analyses_delete_event
      parameters:
      - allowEmptyValue: true
        description: Event key
        explode: true
        in: query
        name: event
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: delete event
  /api/project_analyses/search:
    description: Manage project analyses.
    get:
      description: "Search a project analyses and attached events.<br>Requires the\
        \ following permission: 'Browse' on the specified project. <br>For applications,\
        \ it also requires 'Browse' permission on its child projects."
      externalDocs:
        description: Sonarqube Documentation for search
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/project_analyses/search
      operationId: v1_post_api_project_analyses_search
      parameters:
      - description: Event category. Filter analyses that have at least one event
          of the category specified.
        explode: true
        in: query
        name: category
        required: false
        schema:
          type: string
        style: form
      - description: Filter analyses created after the given date (inclusive). <br>Either
          a date (server timezone) or datetime can be provided
        explode: true
        in: query
        name: from
        required: false
        schema:
          type: string
        style: form
      - description: 1-based page number
        explode: true
        in: query
        name: p
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Project key
        explode: true
        in: query
        name: project
        required: true
        schema:
          type: string
        style: form
      - description: Page size. Must be greater than 0 and less or equal than 500
        explode: true
        in: query
        name: ps
        required: false
        schema:
          type: string
        style: form
      - description: Filter analyses created before the given date (inclusive). <br>Either
          a date (server timezone) or datetime can be provided
        explode: true
        in: query
        name: to
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: search
  /api/project_analyses/update_event:
    description: Manage project analyses.
    post:
      description: Update a project analysis event.<br>Only events of category 'VERSION'
        and 'OTHER' can be updated.<br>Requires one of the following permissions:<ul>  <li>'Administer
        System'</li>  <li>'Administer' rights on the specified project</li></ul>
      externalDocs:
        description: Sonarqube Documentation for update_event
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/project_analyses/update_event
      operationId: v1_get_api_project_analyses_update_event
      parameters:
      - allowEmptyValue: true
        description: Event key
        explode: true
        in: query
        name: event
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: New name
        explode: true
        in: query
        name: name
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: update event
  /api/project_badges/ai_code_assurance:
    description: Generate badges based on quality gates or measures
    get:
      description: Generate a badge for project's AI assurance as an SVG.<br/>Requires
        'Browse' permission on the specified project.
      externalDocs:
        description: Sonarqube Documentation for ai_code_assurance
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/project_badges/ai_code_assurance
      operationId: v1_post_api_project_badges_ai_code_assurance
      parameters:
      - allowEmptyValue: true
        description: Project or application key
        explode: true
        in: query
        name: project
        required: true
        schema:
          type: string
        style: form
      - description: Project badge token
        explode: true
        in: query
        name: token
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: ai code assurance
  /api/project_badges/measure:
    description: Generate badges based on quality gates or measures
    get:
      description: Generate badge for project's measure as an SVG.<br/>Requires 'Browse'
        permission on the specified project.
      externalDocs:
        description: Sonarqube Documentation for measure
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/project_badges/measure
      operationId: v1_post_api_project_badges_measure
      parameters:
      - description: Branch key
        explode: true
        in: query
        name: branch
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Metric key
        explode: true
        in: query
        name: metric
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Project or application key
        explode: true
        in: query
        name: project
        required: true
        schema:
          type: string
        style: form
      - description: Project badge token
        explode: true
        in: query
        name: token
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: measure
  /api/project_badges/quality_gate:
    description: Generate badges based on quality gates or measures
    get:
      description: Generate badge for project's quality gate as an SVG.<br/>Requires
        'Browse' permission on the specified project.
      externalDocs:
        description: Sonarqube Documentation for quality_gate
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/project_badges/quality_gate
      operationId: v1_post_api_project_badges_quality_gate
      parameters:
      - description: Branch key
        explode: true
        in: query
        name: branch
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Project or application key
        explode: true
        in: query
        name: project
        required: true
        schema:
          type: string
        style: form
      - description: Project badge token
        explode: true
        in: query
        name: token
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: quality gate
  /api/project_badges/renew_token:
    description: Generate badges based on quality gates or measures
    post:
      description: Creates new token replacing any existing token for project or application
        badge access for private projects and applications.<br/>This token can be
        used to authenticate with api/project_badges/quality_gate and api/project_badges/measure
        endpoints.<br/>Requires 'Administer' permission on the specified project or
        application.
      externalDocs:
        description: Sonarqube Documentation for renew_token
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/project_badges/renew_token
      operationId: v1_get_api_project_badges_renew_token
      parameters:
      - allowEmptyValue: true
        description: Project or application key
        explode: true
        in: query
        name: project
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: renew token
  /api/project_badges/token:
    description: Generate badges based on quality gates or measures
    get:
      description: Retrieve a token to use for project or application badge access
        for private projects or applications.<br/>This token can be used to authenticate
        with api/project_badges/quality_gate and api/project_badges/measure endpoints.<br/>Requires
        'Browse' permission on the specified project or application.
      externalDocs:
        description: Sonarqube Documentation for token
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/project_badges/token
      operationId: v1_post_api_project_badges_token
      parameters:
      - allowEmptyValue: true
        description: Project or application key
        explode: true
        in: query
        name: project
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: token
  /api/project_branches/delete:
    description: Manage branch
    post:
      description: Delete a non-main branch of a project or application.<br/>Requires
        'Administer' rights on the specified project or application.
      externalDocs:
        description: Sonarqube Documentation for delete
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/project_branches/delete
      operationId: v1_get_api_project_branches_delete
      parameters:
      - allowEmptyValue: true
        description: Branch key
        explode: true
        in: query
        name: branch
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Project key
        explode: true
        in: query
        name: project
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: delete
  /api/project_branches/list:
    description: Manage branch
    get:
      description: List the branches of a project or application.<br/>Requires 'Browse'
        or 'Execute analysis' rights on the specified project or application.
      externalDocs:
        description: Sonarqube Documentation for list
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/project_branches/list
      operationId: v1_post_api_project_branches_list
      parameters:
      - allowEmptyValue: true
        description: Project key
        explode: true
        in: query
        name: project
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: list
  /api/project_branches/rename:
    description: Manage branch
    post:
      description: Rename the main branch of a project or application.<br/>Requires
        'Administer' permission on the specified project or application.
      externalDocs:
        description: Sonarqube Documentation for rename
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/project_branches/rename
      operationId: v1_get_api_project_branches_rename
      parameters:
      - allowEmptyValue: true
        description: New name of the main branch
        explode: true
        in: query
        name: name
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Project key
        explode: true
        in: query
        name: project
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: rename
  /api/project_branches/set_automatic_deletion_protection:
    description: Manage branch
    post:
      description: Protect a specific branch from automatic deletion. Protection can't
        be disabled for the main branch.<br/>Requires 'Administer' permission on the
        specified project or application.
      externalDocs:
        description: Sonarqube Documentation for set_automatic_deletion_protection
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/project_branches/set_automatic_deletion_protection
      operationId: v1_get_api_project_branches_set_automatic_deletion_protection
      parameters:
      - allowEmptyValue: true
        description: Branch key
        explode: true
        in: query
        name: branch
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Project key
        explode: true
        in: query
        name: project
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Sets whether the branch should be protected from automatic deletion
          when it hasn't been analyzed for a set period of time.
        explode: true
        in: query
        name: value
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: set automatic deletion protection
  /api/project_branches/set_main:
    description: Manage branch
    post:
      description: "Allow to set a new main branch.<br/>. Caution, only applicable\
        \ on projects.<br>Requires 'Administer' rights on the specified project or\
        \ application."
      externalDocs:
        description: Sonarqube Documentation for set_main
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/project_branches/set_main
      operationId: v1_get_api_project_branches_set_main
      parameters:
      - allowEmptyValue: true
        description: Branch key
        explode: true
        in: query
        name: branch
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Project key
        explode: true
        in: query
        name: project
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: set main
  /api/project_dump/export:
    description: Project export/import
    post:
      description: "Triggers project dump so that the project can be imported to another\
        \ SonarQube server (see api/project_dump/import, available in Enterprise Edition).\
        \ Requires the 'Administer' permission."
      externalDocs:
        description: Sonarqube Documentation for export
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/project_dump/export
      operationId: v1_get_api_project_dump_export
      parameters:
      - allowEmptyValue: true
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: export
  /api/project_dump/import:
    description: Project export/import
    post:
      description: Triggers the import of a project dump. Permission 'Administer'
        is required. This feature is provided by the Governance plugin.
      externalDocs:
        description: Sonarqube Documentation for import
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/project_dump/import
      operationId: v1_get_api_project_dump_import
      parameters:
      - allowEmptyValue: true
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: import
  /api/project_links/create:
    description: Manage projects links.
    post:
      description: "Create a new project link.<br>Requires 'Administer' permission\
        \ on the specified project, or global 'Administer' permission."
      externalDocs:
        description: Sonarqube Documentation for create
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/project_links/create
      operationId: v1_get_api_project_links_create
      parameters:
      - allowEmptyValue: true
        description: Link name
        explode: true
        in: query
        name: name
        required: true
        schema:
          type: string
        style: form
      - description: Project id
        explode: true
        in: query
        name: projectId
        required: false
        schema:
          type: string
        style: form
      - description: Project key
        explode: true
        in: query
        name: projectKey
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Link url
        explode: true
        in: query
        name: url
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: create
  /api/project_links/delete:
    description: Manage projects links.
    post:
      description: "Delete existing project link.<br>Requires 'Administer' permission\
        \ on the specified project, or global 'Administer' permission."
      externalDocs:
        description: Sonarqube Documentation for delete
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/project_links/delete
      operationId: v1_get_api_project_links_delete
      parameters:
      - allowEmptyValue: true
        description: Link id
        explode: true
        in: query
        name: id
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: delete
  /api/project_links/search:
    description: Manage projects links.
    get:
      description: List links of a project.<br>The 'projectId' or 'projectKey' must
        be provided.<br>Requires one of the following permissions:<ul><li>'Administer
        System'</li><li>'Administer' rights on the specified project</li><li>'Browse'
        on the specified project</li></ul>
      externalDocs:
        description: Sonarqube Documentation for search
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/project_links/search
      operationId: v1_post_api_project_links_search
      parameters:
      - description: Project Id
        explode: true
        in: query
        name: projectId
        required: false
        schema:
          type: string
        style: form
      - description: Project Key
        explode: true
        in: query
        name: projectKey
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: search
  /api/project_pull_requests/delete:
    description: Manage pull request
    post:
      description: Delete a pull request.<br/>Requires 'Administer' rights on the
        specified project.
      externalDocs:
        description: Sonarqube Documentation for delete
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/project_pull_requests/delete
      operationId: v1_get_api_project_pull_requests_delete
      parameters:
      - allowEmptyValue: true
        description: Project key
        explode: true
        in: query
        name: project
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Pull request id
        explode: true
        in: query
        name: pullRequest
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: delete
  /api/project_pull_requests/list:
    description: Manage pull request
    get:
      description: "List the pull requests of a project.<br/>One of the following\
        \ permissions is required: <ul><li>'Browse' rights on the specified project</li><li>'Execute\
        \ Analysis' rights on the specified project</li></ul>"
      externalDocs:
        description: Sonarqube Documentation for list
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/project_pull_requests/list
      operationId: v1_post_api_project_pull_requests_list
      parameters:
      - allowEmptyValue: true
        description: Project key
        explode: true
        in: query
        name: project
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: list
  /api/project_tags/search:
    description: Manage project tags
    get:
      description: Search tags
      externalDocs:
        description: Sonarqube Documentation for search
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/project_tags/search
      operationId: v1_post_api_project_tags_search
      parameters:
      - description: 1-based page number
        explode: true
        in: query
        name: p
        required: false
        schema:
          type: string
        style: form
      - description: Page size. Must be greater than 0 and less or equal than 100
        explode: true
        in: query
        name: ps
        required: false
        schema:
          type: string
        style: form
      - description: Limit search to tags that contain the supplied string.
        explode: true
        in: query
        name: q
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: search
  /api/project_tags/set:
    description: Manage project tags
    post:
      description: "Set tags on a project.<br>Requires the following permission: 'Administer'\
        \ rights on the specified project"
      externalDocs:
        description: Sonarqube Documentation for set
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/project_tags/set
      operationId: v1_get_api_project_tags_set
      parameters:
      - allowEmptyValue: true
        description: Project key
        explode: true
        in: query
        name: project
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Comma-separated list of tags
        explode: true
        in: query
        name: tags
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: set
  /api/projects/bulk_delete:
    description: Manage project existence.
    post:
      description: "Delete one or several projects.<br />Only the 1'000 first items\
        \ in project filters are taken into account.<br />Requires 'Administer System'\
        \ permission.<br />At least one parameter is required among analyzedBefore,\
        \ projects and q"
      externalDocs:
        description: Sonarqube Documentation for bulk_delete
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/projects/bulk_delete
      operationId: v1_get_api_projects_bulk_delete
      parameters:
      - description: Filter the projects for which last analysis of any branch is
          older than the given date (exclusive).<br> Either a date (server timezone)
          or datetime can be provided.
        explode: true
        in: query
        name: analyzedBefore
        required: false
        schema:
          type: string
        style: form
      - description: Filter the projects that are provisioned
        explode: true
        in: query
        name: onProvisionedOnly
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of project keys
        explode: true
        in: query
        name: projects
        required: false
        schema:
          type: string
        style: form
      - description: "Limit to: <ul><li>component names that contain the supplied\
          \ string</li><li>component keys that contain the supplied string</li></ul>"
        explode: true
        in: query
        name: q
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of component qualifiers. Filter the results
          with the specified qualifiers
        explode: true
        in: query
        name: qualifiers
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: bulk delete
  /api/projects/create:
    description: Manage project existence.
    post:
      description: "Create a project.<br/>If your project is hosted on a DevOps Platform,\
        \ please use the import endpoint under api/alm_integrations, so it creates\
        \ and properly configures the project.Requires 'Create Projects' permission.<br/>"
      externalDocs:
        description: Sonarqube Documentation for create
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/projects/create
      operationId: v1_get_api_projects_create
      parameters:
      - description: "Key of the main branch of the project. If not provided, the\
          \ default main branch key will be used."
        explode: true
        in: query
        name: mainBranch
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: "Name of the project. If name is longer than 500, it is abbreviated."
        explode: true
        in: query
        name: name
        required: true
        schema:
          type: string
        style: form
      - description: Project New Code Definition Type<br/>New code definitions of
          the following types are allowed:<ul><li>PREVIOUS_VERSION</li><li>NUMBER_OF_DAYS</li><li>REFERENCE_BRANCH
          - will default to the main branch.</li></ul>
        explode: true
        in: query
        name: newCodeDefinitionType
        required: false
        schema:
          type: string
        style: form
      - description: "Project New Code Definition Value<br/>For each new code definition\
          \ type, a different value is expected:<ul><li>no value, when the new code\
          \ definition type is PREVIOUS_VERSION and REFERENCE_BRANCH</li><li>a number\
          \ between 1 and 90, when the new code definition type is NUMBER_OF_DAYS</li></ul>"
        explode: true
        in: query
        name: newCodeDefinitionValue
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Key of the project
        explode: true
        in: query
        name: project
        required: true
        schema:
          type: string
        style: form
      - description: "Whether the created project should be visible to everyone, or\
          \ only specific user/groups.<br/>If no visibility is specified, the default\
          \ project visibility will be used."
        explode: true
        in: query
        name: visibility
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: create
  /api/projects/delete:
    description: Manage project existence.
    post:
      description: Delete a project.<br> Requires 'Administer System' permission or
        'Administer' permission on the project.
      externalDocs:
        description: Sonarqube Documentation for delete
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/projects/delete
      operationId: v1_get_api_projects_delete
      parameters:
      - allowEmptyValue: true
        description: Project key
        explode: true
        in: query
        name: project
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: delete
  /api/projects/export_findings:
    description: Manage project existence.
    get:
      description: "Export all findings (issues and hotspots) of a specific project\
        \ branch.<br/>Requires 'Administer System' permission. Keep in mind that this\
        \ endpoint will return all findings, issues and hotspots (no filter), which\
        \ can take time and use a lot of resources on the SonarQube server side and\
        \ put pressure on the database until completion. This endpoint can be used\
        \ to feed third party systems. Either the branch key or the pull request key\
        \ should be specified, and not both at the same time."
      externalDocs:
        description: Sonarqube Documentation for export_findings
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/projects/export_findings
      operationId: v1_post_api_projects_export_findings
      parameters:
      - description: "Branch key. When not specified, if no Pull Request key is defined\
          \ either, it will default to the main branch"
        explode: true
        in: query
        name: branch
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Project key
        explode: true
        in: query
        name: project
        required: true
        schema:
          type: string
        style: form
      - description: "Pull Request key. When not specified, the branch data will be\
          \ returned instead"
        explode: true
        in: query
        name: pullRequest
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: export findings
  /api/projects/license_usage:
    description: Manage project existence.
    get:
      description: "Help admins to understand how much each project affects the total\
        \ number of lines of code. Returns the list of projects together with information\
        \ about their usage, sorted by lines of code descending.<br/>Requires Administer\
        \ System permission."
      externalDocs:
        description: Sonarqube Documentation for license_usage
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/projects/license_usage
      operationId: v1_post_api_projects_license_usage
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: license usage
  /api/projects/search:
    description: Manage project existence.
    get:
      description: |-
        Search for projects or views to administrate them.
        <ul>
          <li>The response field 'lastAnalysisDate' takes into account the analysis of all branches and pull requests, not only the main branch.</li>
          <li>The response field 'revision' takes into account the analysis of the main branch only.</li>
        </ul>
        Requires 'Administer System' permission
      externalDocs:
        description: Sonarqube Documentation for search
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/projects/search
      operationId: v1_post_api_projects_search
      parameters:
      - description: Filter the projects for which the last analysis of all branches
          are older than the given date (exclusive).<br> Either a date (server timezone)
          or datetime can be provided.
        explode: true
        in: query
        name: analyzedBefore
        required: false
        schema:
          type: string
        style: form
      - description: Filter the projects that are provisioned
        explode: true
        in: query
        name: onProvisionedOnly
        required: false
        schema:
          type: string
        style: form
      - description: 1-based page number
        explode: true
        in: query
        name: p
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of project keys
        explode: true
        in: query
        name: projects
        required: false
        schema:
          type: string
        style: form
      - description: Page size. Must be greater than 0 and less or equal than 500
        explode: true
        in: query
        name: ps
        required: false
        schema:
          type: string
        style: form
      - description: "Limit search to: <ul><li>component names that contain the supplied\
          \ string</li><li>component keys that contain the supplied string</li></ul>"
        explode: true
        in: query
        name: q
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of component qualifiers. Filter the results
          with the specified qualifiers
        explode: true
        in: query
        name: qualifiers
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: search
  /api/projects/update_key:
    description: Manage project existence.
    post:
      description: Update a project all its sub-components keys.<br>Requires 'Administer'
        permission on the project.
      externalDocs:
        description: Sonarqube Documentation for update_key
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/projects/update_key
      operationId: v1_get_api_projects_update_key
      parameters:
      - allowEmptyValue: true
        description: Project key
        explode: true
        in: query
        name: from
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: New project key
        explode: true
        in: query
        name: to
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: update key
  /api/projects/update_visibility:
    description: Manage project existence.
    post:
      description: "Updates visibility of a project, application or a portfolio.<br>Requires\
        \ 'Project administer' permission on the specified entity"
      externalDocs:
        description: Sonarqube Documentation for update_visibility
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/projects/update_visibility
      operationId: v1_get_api_projects_update_visibility
      parameters:
      - allowEmptyValue: true
        description: "Project, application or portfolio key"
        explode: true
        in: query
        name: project
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: New visibility
        explode: true
        in: query
        name: visibility
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: update visibility
  /api/qualitygates/add_group:
    description: "Manage quality gates, including conditions and project association."
    post:
      description: Allow a group of users to edit a Quality Gate.<br>Requires one
        of the following permissions:<ul>  <li>'Administer Quality Gates'</li>  <li>Edit
        right on the specified quality gate</li></ul>
      externalDocs:
        description: Sonarqube Documentation for add_group
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualitygates/add_group
      operationId: v1_get_api_qualitygates_add_group
      parameters:
      - allowEmptyValue: true
        description: Quality Gate name
        explode: true
        in: query
        name: gateName
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Group name or 'anyone' (case insensitive)
        explode: true
        in: query
        name: groupName
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: add group
  /api/qualitygates/add_user:
    description: "Manage quality gates, including conditions and project association."
    post:
      description: Allow a user to edit a Quality Gate.<br>Requires one of the following
        permissions:<ul>  <li>'Administer Quality Gates'</li>  <li>Edit right on the
        specified quality gate</li></ul>
      externalDocs:
        description: Sonarqube Documentation for add_user
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualitygates/add_user
      operationId: v1_get_api_qualitygates_add_user
      parameters:
      - allowEmptyValue: true
        description: Quality Gate name
        explode: true
        in: query
        name: gateName
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: User login
        explode: true
        in: query
        name: login
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: add user
  /api/qualitygates/copy:
    description: "Manage quality gates, including conditions and project association."
    post:
      description: Copy a Quality Gate.<br>'sourceName' must be provided. Requires
        the 'Administer Quality Gates' permission.
      externalDocs:
        description: Sonarqube Documentation for copy
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualitygates/copy
      operationId: v1_get_api_qualitygates_copy
      parameters:
      - allowEmptyValue: true
        description: The name of the quality gate to create
        explode: true
        in: query
        name: name
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: The name of the quality gate to copy
        explode: true
        in: query
        name: sourceName
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: copy
  /api/qualitygates/create:
    description: "Manage quality gates, including conditions and project association."
    post:
      description: Create a Quality Gate.<br>Requires the 'Administer Quality Gates'
        permission.
      externalDocs:
        description: Sonarqube Documentation for create
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualitygates/create
      operationId: v1_get_api_qualitygates_create
      parameters:
      - allowEmptyValue: true
        description: The name of the quality gate to create
        explode: true
        in: query
        name: name
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: create
  /api/qualitygates/create_condition:
    description: "Manage quality gates, including conditions and project association."
    post:
      description: Add a new condition to a quality gate.<br>Parameter 'gateName'
        must be provided. Requires the 'Administer Quality Gates' permission.
      externalDocs:
        description: Sonarqube Documentation for create_condition
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualitygates/create_condition
      operationId: v1_get_api_qualitygates_create_condition
      parameters:
      - allowEmptyValue: true
        description: Condition error threshold
        explode: true
        in: query
        name: error
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Name of the quality gate
        explode: true
        in: query
        name: gateName
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Condition metric.<br/> Only metric of the following types are
          allowed:<ul><li>INT</li><li>MILLISEC</li><li>RATING</li><li>WORK_DUR</li><li>FLOAT</li><li>PERCENT</li><li>LEVEL</li></ul>Following
          metrics are forbidden:<ul><li>software_quality_maintainability_debt_ratio</li><li>new_software_quality_reliability_remediation_effort</li><li>new_software_quality_maintainability_debt_ratio</li><li>software_quality_reliability_remediation_effort</li><li>security_hotspots</li><li>alert_status</li><li>software_quality_maintainability_rating</li><li>new_software_quality_maintainability_rating</li><li>new_security_hotspots</li><li>software_quality_security_rating</li><li>new_software_quality_security_rating</li><li>new_software_quality_reliability_rating</li><li>software_quality_security_remediation_effort</li><li>effort_to_reach_software_quality_maintainability_rating_a</li><li>new_software_quality_maintainability_remediation_effort</li><li>software_quality_maintainability_remediation_effort</li><li>new_software_quality_security_remediation_effort</li><li>software_quality_reliability_rating</li></ul>
        explode: true
        in: query
        name: metric
        required: true
        schema:
          type: string
        style: form
      - description: Condition operator:<br/><ul><li>LT = is lower than</li><li>GT
          = is greater than</li></ul>
        explode: true
        in: query
        name: op
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: create condition
  /api/qualitygates/delete_condition:
    description: "Manage quality gates, including conditions and project association."
    post:
      description: Delete a condition from a quality gate.<br>Requires the 'Administer
        Quality Gates' permission.
      externalDocs:
        description: Sonarqube Documentation for delete_condition
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualitygates/delete_condition
      operationId: v1_get_api_qualitygates_delete_condition
      parameters:
      - allowEmptyValue: true
        description: Condition UUID
        explode: true
        in: query
        name: id
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: delete condition
  /api/qualitygates/deselect:
    description: "Manage quality gates, including conditions and project association."
    post:
      description: Remove the association of a project from a quality gate.<br>Requires
        one of the following permissions:<ul><li>'Administer Quality Gates'</li><li>'Administer'
        rights on the project</li></ul>
      externalDocs:
        description: Sonarqube Documentation for deselect
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualitygates/deselect
      operationId: v1_get_api_qualitygates_deselect
      parameters:
      - allowEmptyValue: true
        description: Project key
        explode: true
        in: query
        name: projectKey
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: deselect
  /api/qualitygates/destroy:
    description: "Manage quality gates, including conditions and project association."
    post:
      description: Delete a Quality Gate.<br>Parameter 'name' must be specified. Requires
        the 'Administer Quality Gates' permission.
      externalDocs:
        description: Sonarqube Documentation for destroy
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualitygates/destroy
      operationId: v1_get_api_qualitygates_destroy
      parameters:
      - allowEmptyValue: true
        description: Name of the quality gate to delete
        explode: true
        in: query
        name: name
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: destroy
  /api/qualitygates/get_by_project:
    description: "Manage quality gates, including conditions and project association."
    get:
      description: Get the quality gate of a project.<br />Requires one of the following
        permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the
        specified project</li><li>'Browse' on the specified project</li></ul>
      externalDocs:
        description: Sonarqube Documentation for get_by_project
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualitygates/get_by_project
      operationId: v1_post_api_qualitygates_get_by_project
      parameters:
      - allowEmptyValue: true
        description: Project key
        explode: true
        in: query
        name: project
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: get by project
  /api/qualitygates/list:
    description: "Manage quality gates, including conditions and project association."
    get:
      description: Get a list of quality gates
      externalDocs:
        description: Sonarqube Documentation for list
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualitygates/list
      operationId: v1_post_api_qualitygates_list
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: list
  /api/qualitygates/project_status:
    description: "Manage quality gates, including conditions and project association."
    get:
      description: "Get the quality gate status of a project or a Compute Engine task.<br\
        \ />Either 'analysisId', 'projectId' or 'projectKey' must be provided <br\
        \ />The different statuses returned are: OK, WARN, ERROR, NONE. The NONE status\
        \ is returned when there is no quality gate associated with the analysis.<br\
        \ />Returns an HTTP code 404 if the analysis associated with the task is not\
        \ found or does not exist.<br />Requires one of the following permissions:<ul><li>'Administer\
        \ System'</li><li>'Administer' rights on the specified project</li><li>'Browse'\
        \ on the specified project</li><li>'Execute Analysis' on the specified project</li></ul>"
      externalDocs:
        description: Sonarqube Documentation for project_status
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualitygates/project_status
      operationId: v1_post_api_qualitygates_project_status
      parameters:
      - description: Analysis id
        explode: true
        in: query
        name: analysisId
        required: false
        schema:
          type: string
        style: form
      - description: Branch key
        explode: true
        in: query
        name: branch
        required: false
        schema:
          type: string
        style: form
      - description: Project UUID. Doesn't work with branches or pull requests
        explode: true
        in: query
        name: projectId
        required: false
        schema:
          type: string
        style: form
      - description: Project key
        explode: true
        in: query
        name: projectKey
        required: false
        schema:
          type: string
        style: form
      - description: Pull request id
        explode: true
        in: query
        name: pullRequest
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: project status
  /api/qualitygates/remove_group:
    description: "Manage quality gates, including conditions and project association."
    post:
      description: Remove the ability from a group to edit a Quality Gate.<br>Requires
        one of the following permissions:<ul>  <li>'Administer Quality Gates'</li>  <li>Edit
        right on the specified quality gate</li></ul>
      externalDocs:
        description: Sonarqube Documentation for remove_group
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualitygates/remove_group
      operationId: v1_get_api_qualitygates_remove_group
      parameters:
      - allowEmptyValue: true
        description: Quality Gate name
        explode: true
        in: query
        name: gateName
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Group name or 'anyone' (case insensitive)
        explode: true
        in: query
        name: groupName
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: remove group
  /api/qualitygates/remove_user:
    description: "Manage quality gates, including conditions and project association."
    post:
      description: Remove the ability from an user to edit a Quality Gate.<br>Requires
        one of the following permissions:<ul>  <li>'Administer Quality Gates'</li>  <li>Edit
        right on the specified quality gate</li></ul>
      externalDocs:
        description: Sonarqube Documentation for remove_user
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualitygates/remove_user
      operationId: v1_get_api_qualitygates_remove_user
      parameters:
      - allowEmptyValue: true
        description: Quality Gate name
        explode: true
        in: query
        name: gateName
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: User login
        explode: true
        in: query
        name: login
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: remove user
  /api/qualitygates/rename:
    description: "Manage quality gates, including conditions and project association."
    post:
      description: Rename a Quality Gate.<br>'currentName' must be specified. Requires
        the 'Administer Quality Gates' permission.
      externalDocs:
        description: Sonarqube Documentation for rename
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualitygates/rename
      operationId: v1_get_api_qualitygates_rename
      parameters:
      - allowEmptyValue: true
        description: Current name of the quality gate
        explode: true
        in: query
        name: currentName
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: New name of the quality gate
        explode: true
        in: query
        name: name
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: rename
  /api/qualitygates/search:
    description: "Manage quality gates, including conditions and project association."
    get:
      description: Search for projects associated (or not) to a quality gate.<br/>Only
        authorized projects for the current user will be returned.
      externalDocs:
        description: Sonarqube Documentation for search
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualitygates/search
      operationId: v1_post_api_qualitygates_search
      parameters:
      - allowEmptyValue: true
        description: Quality Gate name
        explode: true
        in: query
        name: gateName
        required: true
        schema:
          type: string
        style: form
      - description: Page number
        explode: true
        in: query
        name: page
        required: false
        schema:
          type: string
        style: form
      - description: Page size
        explode: true
        in: query
        name: pageSize
        required: false
        schema:
          type: string
        style: form
      - description: "To search for projects containing this string. If this parameter\
          \ is set, \"selected\" is set to \"all\"."
        explode: true
        in: query
        name: query
        required: false
        schema:
          type: string
        style: form
      - description: "Depending on the value, show only selected items (selected=selected),\
          \ deselected items (selected=deselected), or all items with their selection\
          \ status (selected=all)."
        explode: true
        in: query
        name: selected
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: search
  /api/qualitygates/search_groups:
    description: "Manage quality gates, including conditions and project association."
    get:
      description: List the groups that are allowed to edit a Quality Gate.<br>Requires
        one of the following permissions:<ul>  <li>'Administer Quality Gates'</li>  <li>Edit
        right on the specified quality gate</li></ul>
      externalDocs:
        description: Sonarqube Documentation for search_groups
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualitygates/search_groups
      operationId: v1_post_api_qualitygates_search_groups
      parameters:
      - allowEmptyValue: true
        description: Quality Gate name
        explode: true
        in: query
        name: gateName
        required: true
        schema:
          type: string
        style: form
      - description: 1-based page number
        explode: true
        in: query
        name: p
        required: false
        schema:
          type: string
        style: form
      - description: Page size. Must be greater than 0.
        explode: true
        in: query
        name: ps
        required: false
        schema:
          type: string
        style: form
      - description: Limit search to group names that contain the supplied string.
        explode: true
        in: query
        name: q
        required: false
        schema:
          type: string
        style: form
      - description: "Depending on the value, show only selected items (selected=selected),\
          \ deselected items (selected=deselected), or all items with their selection\
          \ status (selected=all)."
        explode: true
        in: query
        name: selected
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: search groups
  /api/qualitygates/search_users:
    description: "Manage quality gates, including conditions and project association."
    get:
      description: List the users that are allowed to edit a Quality Gate.<br>Requires
        one of the following permissions:<ul>  <li>'Administer Quality Gates'</li>  <li>Edit
        right on the specified quality gate</li></ul>
      externalDocs:
        description: Sonarqube Documentation for search_users
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualitygates/search_users
      operationId: v1_post_api_qualitygates_search_users
      parameters:
      - allowEmptyValue: true
        description: Quality Gate name
        explode: true
        in: query
        name: gateName
        required: true
        schema:
          type: string
        style: form
      - description: 1-based page number
        explode: true
        in: query
        name: p
        required: false
        schema:
          type: string
        style: form
      - description: Page size. Must be greater than 0.
        explode: true
        in: query
        name: ps
        required: false
        schema:
          type: string
        style: form
      - description: Limit search to names or logins that contain the supplied string.
        explode: true
        in: query
        name: q
        required: false
        schema:
          type: string
        style: form
      - description: "Depending on the value, show only selected items (selected=selected),\
          \ deselected items (selected=deselected), or all items with their selection\
          \ status (selected=all)."
        explode: true
        in: query
        name: selected
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: search users
  /api/qualitygates/select:
    description: "Manage quality gates, including conditions and project association."
    post:
      description: Associate a project to a quality gate.<br>Requires one of the following
        permissions:<ul>  <li>'Administer Quality Gates'</li>  <li>'Administer' right
        on the specified project</li></ul>
      externalDocs:
        description: Sonarqube Documentation for select
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualitygates/select
      operationId: v1_get_api_qualitygates_select
      parameters:
      - allowEmptyValue: true
        description: Name of the quality gate
        explode: true
        in: query
        name: gateName
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Project key
        explode: true
        in: query
        name: projectKey
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: select
  /api/qualitygates/set_as_default:
    description: "Manage quality gates, including conditions and project association."
    post:
      description: Set a quality gate as the default quality gate.<br>Parameter 'name'
        must be specified. Requires the 'Administer Quality Gates' permission.
      externalDocs:
        description: Sonarqube Documentation for set_as_default
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualitygates/set_as_default
      operationId: v1_get_api_qualitygates_set_as_default
      parameters:
      - allowEmptyValue: true
        description: Name of the quality gate to set as default
        explode: true
        in: query
        name: name
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: set as default
  /api/qualitygates/show:
    description: "Manage quality gates, including conditions and project association."
    get:
      description: Display the details of a quality gate
      externalDocs:
        description: Sonarqube Documentation for show
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualitygates/show
      operationId: v1_post_api_qualitygates_show
      parameters:
      - allowEmptyValue: true
        description: Name of the quality gate. Either id or name must be set
        explode: true
        in: query
        name: name
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: show
  /api/qualitygates/update_condition:
    description: "Manage quality gates, including conditions and project association."
    post:
      description: Update a condition attached to a quality gate.<br>Requires the
        'Administer Quality Gates' permission.
      externalDocs:
        description: Sonarqube Documentation for update_condition
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualitygates/update_condition
      operationId: v1_get_api_qualitygates_update_condition
      parameters:
      - allowEmptyValue: true
        description: Condition error threshold
        explode: true
        in: query
        name: error
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Condition ID
        explode: true
        in: query
        name: id
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Condition metric.<br/> Only metric of the following types are
          allowed:<ul><li>INT</li><li>MILLISEC</li><li>RATING</li><li>WORK_DUR</li><li>FLOAT</li><li>PERCENT</li><li>LEVEL</li></ul>Following
          metrics are forbidden:<ul><li>software_quality_maintainability_debt_ratio</li><li>new_software_quality_reliability_remediation_effort</li><li>new_software_quality_maintainability_debt_ratio</li><li>software_quality_reliability_remediation_effort</li><li>security_hotspots</li><li>alert_status</li><li>software_quality_maintainability_rating</li><li>new_software_quality_maintainability_rating</li><li>new_security_hotspots</li><li>software_quality_security_rating</li><li>new_software_quality_security_rating</li><li>new_software_quality_reliability_rating</li><li>software_quality_security_remediation_effort</li><li>effort_to_reach_software_quality_maintainability_rating_a</li><li>new_software_quality_maintainability_remediation_effort</li><li>software_quality_maintainability_remediation_effort</li><li>new_software_quality_security_remediation_effort</li><li>software_quality_reliability_rating</li></ul>
        explode: true
        in: query
        name: metric
        required: true
        schema:
          type: string
        style: form
      - description: Condition operator:<br/><ul><li>LT = is lower than</li><li>GT
          = is greater than</li></ul>
        explode: true
        in: query
        name: op
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: update condition
  /api/qualityprofiles/activate_rule:
    description: Manage quality profiles.
    post:
      description: Activate a rule on a Quality Profile.<br> Requires one of the following
        permissions:<ul>  <li>'Administer Quality Profiles'</li>  <li>Edit right on
        the specified quality profile</li></ul>
      externalDocs:
        description: Sonarqube Documentation for activate_rule
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualityprofiles/activate_rule
      operationId: v1_get_api_qualityprofiles_activate_rule
      parameters:
      - description: Override of impact severities for the rule. Cannot be used as
          the same time as 'severity'. Ignored if parameter reset is true.
        explode: true
        in: query
        name: impacts
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Quality Profile key. Can be obtained through <code>api/qualityprofiles/search</code>
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      - description: Parameters as semi-colon list of <code>key=value</code>. Ignored
          if parameter reset is true.
        explode: true
        in: query
        name: params
        required: false
        schema:
          type: string
        style: form
      - description: "Mark activated rule as prioritized, so all corresponding Issues\
          \ will have to be fixed."
        explode: true
        in: query
        name: prioritizedRule
        required: false
        schema:
          type: string
        style: form
      - description: Reset severity and parameters of activated rule. Set the values
          defined on parent profile or from rule default values.
        explode: true
        in: query
        name: reset
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Rule key
        explode: true
        in: query
        name: rule
        required: true
        schema:
          type: string
        style: form
      - description: Severity. Cannot be used as the same time as 'impacts'.Ignored
          if parameter reset is true.
        explode: true
        in: query
        name: severity
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: activate rule
  /api/qualityprofiles/activate_rules:
    description: Manage quality profiles.
    post:
      description: Bulk-activate rules on one quality profile.<br> Requires one of
        the following permissions:<ul>  <li>'Administer Quality Profiles'</li>  <li>Edit
        right on the specified quality profile</li></ul>
      externalDocs:
        description: Sonarqube Documentation for activate_rules
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualityprofiles/activate_rules
      operationId: v1_get_api_qualityprofiles_activate_rules
      parameters:
      - description: Filter rules that are activated or deactivated on the selected
          Quality profile. Ignored if the parameter 'qprofile' is not set.
        explode: true
        in: query
        name: activation
        required: false
        schema:
          type: string
        style: form
      - description: "Comma-separated list of activation severities, i.e the severity\
          \ of rules in Quality profiles."
        explode: true
        in: query
        name: active_severities
        required: false
        schema:
          type: string
        style: form
      - description: Ascending sort
        explode: true
        in: query
        name: asc
        required: false
        schema:
          type: string
        style: form
      - description: Filters rules added since date. Format is yyyy-MM-dd
        explode: true
        in: query
        name: available_since
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of Clean Code Attribute Categories
        explode: true
        in: query
        name: cleanCodeAttributeCategories
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of CWE identifiers. Use 'unknown' to select
          rules not associated to any CWE.
        explode: true
        in: query
        name: cwe
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of Software Quality Severities
        explode: true
        in: query
        name: impactSeverities
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of Software Qualities
        explode: true
        in: query
        name: impactSoftwareQualities
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of values of inheritance for a rule within
          a quality profile. Used only if the parameter 'activation' is set.
        explode: true
        in: query
        name: inheritance
        required: false
        schema:
          type: string
        style: form
      - description: Filter template rules
        explode: true
        in: query
        name: is_template
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of languages
        explode: true
        in: query
        name: languages
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of OWASP Top 10 2017 lowercase categories.
        explode: true
        in: query
        name: owaspTop10
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of OWASP Top 10 2021 lowercase categories.
        explode: true
        in: query
        name: owaspTop10-2021
        required: false
        schema:
          type: string
        style: form
      - description: "Mark activated rules as prioritized, so all corresponding Issues\
          \ will have to be fixed."
        explode: true
        in: query
        name: prioritizedRule
        required: false
        schema:
          type: string
        style: form
      - description: UTF-8 search query
        explode: true
        in: query
        name: q
        required: false
        schema:
          type: string
        style: form
      - description: Quality profile key to filter on. Used only if the parameter
          'activation' is set.
        explode: true
        in: query
        name: qprofile
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of repositories
        explode: true
        in: query
        name: repositories
        required: false
        schema:
          type: string
        style: form
      - description: Key of rule to search for
        explode: true
        in: query
        name: rule_key
        required: false
        schema:
          type: string
        style: form
      - description: Sort field
        explode: true
        in: query
        name: s
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of SANS Top 25 categories.
        explode: true
        in: query
        name: sansTop25
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of default severities. Not the same than
          severity of rules in Quality profiles.
        explode: true
        in: query
        name: severities
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of SonarSource security categories. Use
          'others' to select rules not associated with any category
        explode: true
        in: query
        name: sonarsourceSecurity
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of status codes
        explode: true
        in: query
        name: statuses
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of tags. Returned rules match any of the
          tags (OR operator)
        explode: true
        in: query
        name: tags
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Quality Profile key on which the rule activation is done. To
          retrieve a quality profile key please see <code>api/qualityprofiles/search</code>
        explode: true
        in: query
        name: targetKey
        required: true
        schema:
          type: string
        style: form
      - description: Severity to set on the activated rules
        explode: true
        in: query
        name: targetSeverity
        required: false
        schema:
          type: string
        style: form
      - description: Key of the template rule to filter on. Used to search for the
          custom rules based on this template.
        explode: true
        in: query
        name: template_key
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of types. Returned rules match any of the
          tags (OR operator)
        explode: true
        in: query
        name: types
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: activate rules
  /api/qualityprofiles/add_project:
    description: Manage quality profiles.
    post:
      description: Associate a project with a quality profile.<br> Requires one of
        the following permissions:<ul>  <li>'Administer Quality Profiles'</li>  <li>Administer
        right on the specified project</li></ul>
      externalDocs:
        description: Sonarqube Documentation for add_project
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualityprofiles/add_project
      operationId: v1_get_api_qualityprofiles_add_project
      parameters:
      - allowEmptyValue: true
        description: Quality profile language.
        explode: true
        in: query
        name: language
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Project key
        explode: true
        in: query
        name: project
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Quality profile name.
        explode: true
        in: query
        name: qualityProfile
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: add project
  /api/qualityprofiles/backup:
    description: Manage quality profiles.
    get:
      description: Backup a quality profile in XML form. The exported profile can
        be restored through api/qualityprofiles/restore.
      externalDocs:
        description: Sonarqube Documentation for backup
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualityprofiles/backup
      operationId: v1_post_api_qualityprofiles_backup
      parameters:
      - allowEmptyValue: true
        description: Quality profile language.
        explode: true
        in: query
        name: language
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Quality profile name.
        explode: true
        in: query
        name: qualityProfile
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: backup
  /api/qualityprofiles/change_parent:
    description: Manage quality profiles.
    post:
      description: Change a quality profile's parent.<br>Requires one of the following
        permissions:<ul>  <li>'Administer Quality Profiles'</li>  <li>Edit right on
        the specified quality profile</li></ul>
      externalDocs:
        description: Sonarqube Documentation for change_parent
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualityprofiles/change_parent
      operationId: v1_get_api_qualityprofiles_change_parent
      parameters:
      - allowEmptyValue: true
        description: Quality profile language.
        explode: true
        in: query
        name: language
        required: true
        schema:
          type: string
        style: form
      - description: "New parent profile name. <br> If no profile is provided, the\
          \ inheritance link with current parent profile (if any) is broken, which\
          \ deactivates all rules which come from the parent and are not overridden."
        explode: true
        in: query
        name: parentQualityProfile
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Quality profile name.
        explode: true
        in: query
        name: qualityProfile
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: change parent
  /api/qualityprofiles/changelog:
    description: Manage quality profiles.
    get:
      description: "Get the history of changes on a quality profile: rule activation/deactivation,\
        \ change in parameters/severity/impacts. Events are ordered by date in descending\
        \ order (most recent first)."
      externalDocs:
        description: Sonarqube Documentation for changelog
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualityprofiles/changelog
      operationId: v1_post_api_qualityprofiles_changelog
      parameters:
      - description: "If specified, will return changelog events related to MQR or\
          \ STANDARD mode. If not specified, all the events are returned"
        explode: true
        in: query
        name: filterMode
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Quality profile language.
        explode: true
        in: query
        name: language
        required: true
        schema:
          type: string
        style: form
      - description: 1-based page number
        explode: true
        in: query
        name: p
        required: false
        schema:
          type: string
        style: form
      - description: Page size. Must be greater than 0 and less or equal than 500
        explode: true
        in: query
        name: ps
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Quality profile name.
        explode: true
        in: query
        name: qualityProfile
        required: true
        schema:
          type: string
        style: form
      - description: Start date for the changelog (inclusive). <br>Either a date (server
          timezone) or datetime can be provided.
        explode: true
        in: query
        name: since
        required: false
        schema:
          type: string
        style: form
      - description: "End date for the changelog (exclusive, strictly before). <br>Either\
          \ a date (server timezone) or datetime can be provided."
        explode: true
        in: query
        name: to
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: changelog
  /api/qualityprofiles/copy:
    description: Manage quality profiles.
    post:
      description: Copy a quality profile.<br> Requires to be logged in and the 'Administer
        Quality Profiles' permission.
      externalDocs:
        description: Sonarqube Documentation for copy
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualityprofiles/copy
      operationId: v1_get_api_qualityprofiles_copy
      parameters:
      - allowEmptyValue: true
        description: Quality profile key
        explode: true
        in: query
        name: fromKey
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Name for the new quality profile.
        explode: true
        in: query
        name: toName
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: copy
  /api/qualityprofiles/create:
    description: Manage quality profiles.
    post:
      description: Create a quality profile.<br>Requires to be logged in and the 'Administer
        Quality Profiles' permission.
      externalDocs:
        description: Sonarqube Documentation for create
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualityprofiles/create
      operationId: v1_get_api_qualityprofiles_create
      parameters:
      - allowEmptyValue: true
        description: Quality profile language
        explode: true
        in: query
        name: language
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Quality profile name
        explode: true
        in: query
        name: name
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: create
  /api/qualityprofiles/deactivate_rule:
    description: Manage quality profiles.
    post:
      description: Deactivate a rule on a quality profile.<br> Requires one of the
        following permissions:<ul>  <li>'Administer Quality Profiles'</li>  <li>Edit
        right on the specified quality profile</li></ul>
      externalDocs:
        description: Sonarqube Documentation for deactivate_rule
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualityprofiles/deactivate_rule
      operationId: v1_get_api_qualityprofiles_deactivate_rule
      parameters:
      - allowEmptyValue: true
        description: Quality Profile key. Can be obtained through <code>api/qualityprofiles/search</code>
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Rule key
        explode: true
        in: query
        name: rule
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: deactivate rule
  /api/qualityprofiles/deactivate_rules:
    description: Manage quality profiles.
    post:
      description: Bulk deactivate rules on Quality profiles.<br>Requires one of the
        following permissions:<ul>  <li>'Administer Quality Profiles'</li>  <li>Edit
        right on the specified quality profile</li></ul>
      externalDocs:
        description: Sonarqube Documentation for deactivate_rules
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualityprofiles/deactivate_rules
      operationId: v1_get_api_qualityprofiles_deactivate_rules
      parameters:
      - description: Filter rules that are activated or deactivated on the selected
          Quality profile. Ignored if the parameter 'qprofile' is not set.
        explode: true
        in: query
        name: activation
        required: false
        schema:
          type: string
        style: form
      - description: "Comma-separated list of activation severities, i.e the severity\
          \ of rules in Quality profiles."
        explode: true
        in: query
        name: active_severities
        required: false
        schema:
          type: string
        style: form
      - description: Ascending sort
        explode: true
        in: query
        name: asc
        required: false
        schema:
          type: string
        style: form
      - description: Filters rules added since date. Format is yyyy-MM-dd
        explode: true
        in: query
        name: available_since
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of Clean Code Attribute Categories
        explode: true
        in: query
        name: cleanCodeAttributeCategories
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of CWE identifiers. Use 'unknown' to select
          rules not associated to any CWE.
        explode: true
        in: query
        name: cwe
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of Software Quality Severities
        explode: true
        in: query
        name: impactSeverities
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of Software Qualities
        explode: true
        in: query
        name: impactSoftwareQualities
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of values of inheritance for a rule within
          a quality profile. Used only if the parameter 'activation' is set.
        explode: true
        in: query
        name: inheritance
        required: false
        schema:
          type: string
        style: form
      - description: Filter template rules
        explode: true
        in: query
        name: is_template
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of languages
        explode: true
        in: query
        name: languages
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of OWASP Top 10 2017 lowercase categories.
        explode: true
        in: query
        name: owaspTop10
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of OWASP Top 10 2021 lowercase categories.
        explode: true
        in: query
        name: owaspTop10-2021
        required: false
        schema:
          type: string
        style: form
      - description: UTF-8 search query
        explode: true
        in: query
        name: q
        required: false
        schema:
          type: string
        style: form
      - description: Quality profile key to filter on. Used only if the parameter
          'activation' is set.
        explode: true
        in: query
        name: qprofile
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of repositories
        explode: true
        in: query
        name: repositories
        required: false
        schema:
          type: string
        style: form
      - description: Key of rule to search for
        explode: true
        in: query
        name: rule_key
        required: false
        schema:
          type: string
        style: form
      - description: Sort field
        explode: true
        in: query
        name: s
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of SANS Top 25 categories.
        explode: true
        in: query
        name: sansTop25
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of default severities. Not the same than
          severity of rules in Quality profiles.
        explode: true
        in: query
        name: severities
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of SonarSource security categories. Use
          'others' to select rules not associated with any category
        explode: true
        in: query
        name: sonarsourceSecurity
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of status codes
        explode: true
        in: query
        name: statuses
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of tags. Returned rules match any of the
          tags (OR operator)
        explode: true
        in: query
        name: tags
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Quality Profile key on which the rule deactivation is done. To
          retrieve a profile key please see <code>api/qualityprofiles/search</code>
        explode: true
        in: query
        name: targetKey
        required: true
        schema:
          type: string
        style: form
      - description: Key of the template rule to filter on. Used to search for the
          custom rules based on this template.
        explode: true
        in: query
        name: template_key
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of types. Returned rules match any of the
          tags (OR operator)
        explode: true
        in: query
        name: types
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: deactivate rules
  /api/qualityprofiles/delete:
    description: Manage quality profiles.
    post:
      description: Delete a quality profile and all its descendants. The default quality
        profile cannot be deleted.<br> Requires one of the following permissions:<ul>  <li>'Administer
        Quality Profiles'</li>  <li>Edit right on the specified quality profile</li></ul>
      externalDocs:
        description: Sonarqube Documentation for delete
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualityprofiles/delete
      operationId: v1_get_api_qualityprofiles_delete
      parameters:
      - allowEmptyValue: true
        description: Quality profile language.
        explode: true
        in: query
        name: language
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Quality profile name.
        explode: true
        in: query
        name: qualityProfile
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: delete
  /api/qualityprofiles/export:
    description: Manage quality profiles.
    get:
      description: Export a quality profile.
      externalDocs:
        description: Sonarqube Documentation for export
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualityprofiles/export
      operationId: v1_post_api_qualityprofiles_export
      parameters:
      - description: "Output format. If left empty, the same format as api/qualityprofiles/backup\
          \ is used. Possible values are described by api/qualityprofiles/exporters."
        explode: true
        in: query
        name: exporterKey
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Quality profile language
        explode: true
        in: query
        name: language
        required: true
        schema:
          type: string
        style: form
      - description: "Quality profile name to export. If left empty, the default profile\
          \ for the language is exported."
        explode: true
        in: query
        name: qualityProfile
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: export
  /api/qualityprofiles/exporters:
    description: Manage quality profiles.
    get:
      description: Lists available profile export formats.
      externalDocs:
        description: Sonarqube Documentation for exporters
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualityprofiles/exporters
      operationId: v1_post_api_qualityprofiles_exporters
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: exporters
  /api/qualityprofiles/importers:
    description: Manage quality profiles.
    get:
      description: List supported importers.
      externalDocs:
        description: Sonarqube Documentation for importers
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualityprofiles/importers
      operationId: v1_post_api_qualityprofiles_importers
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: importers
  /api/qualityprofiles/inheritance:
    description: Manage quality profiles.
    get:
      description: Show a quality profile's ancestors and children.
      externalDocs:
        description: Sonarqube Documentation for inheritance
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualityprofiles/inheritance
      operationId: v1_post_api_qualityprofiles_inheritance
      parameters:
      - allowEmptyValue: true
        description: Quality profile language.
        explode: true
        in: query
        name: language
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Quality profile name.
        explode: true
        in: query
        name: qualityProfile
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: inheritance
  /api/qualityprofiles/projects:
    description: Manage quality profiles.
    get:
      description: "List projects with their association status regarding a quality\
        \ profile. <br/>Only projects explicitly bound to the profile are returned,\
        \ those associated with the profile because it is the default one are not.\
        \ <br/>See api/qualityprofiles/search in order to get the Quality Profile\
        \ Key. "
      externalDocs:
        description: Sonarqube Documentation for projects
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualityprofiles/projects
      operationId: v1_post_api_qualityprofiles_projects
      parameters:
      - allowEmptyValue: true
        description: Quality profile key
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      - description: 1-based page number
        explode: true
        in: query
        name: p
        required: false
        schema:
          type: string
        style: form
      - description: Page size. Must be greater than 0 and less or equal than 500
        explode: true
        in: query
        name: ps
        required: false
        schema:
          type: string
        style: form
      - description: Limit search to projects that contain the supplied string.
        explode: true
        in: query
        name: q
        required: false
        schema:
          type: string
        style: form
      - description: "Depending on the value, show only selected items (selected=selected),\
          \ deselected items (selected=deselected), or all items with their selection\
          \ status (selected=all)."
        explode: true
        in: query
        name: selected
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: projects
  /api/qualityprofiles/remove_project:
    description: Manage quality profiles.
    post:
      description: Remove a project's association with a quality profile.<br> Requires
        one of the following permissions:<ul>  <li>'Administer Quality Profiles'</li>  <li>Edit
        right on the specified quality profile</li>  <li>Administer right on the specified
        project</li></ul>
      externalDocs:
        description: Sonarqube Documentation for remove_project
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualityprofiles/remove_project
      operationId: v1_get_api_qualityprofiles_remove_project
      parameters:
      - allowEmptyValue: true
        description: Quality profile language.
        explode: true
        in: query
        name: language
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Project key
        explode: true
        in: query
        name: project
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Quality profile name.
        explode: true
        in: query
        name: qualityProfile
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: remove project
  /api/qualityprofiles/rename:
    description: Manage quality profiles.
    post:
      description: Rename a quality profile.<br> Requires one of the following permissions:<ul>  <li>'Administer
        Quality Profiles'</li>  <li>Edit right on the specified quality profile</li></ul>
      externalDocs:
        description: Sonarqube Documentation for rename
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualityprofiles/rename
      operationId: v1_get_api_qualityprofiles_rename
      parameters:
      - allowEmptyValue: true
        description: Quality profile key
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: New quality profile name
        explode: true
        in: query
        name: name
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: rename
  /api/qualityprofiles/restore:
    description: Manage quality profiles.
    post:
      description: "Restore a quality profile using an XML file. The restored profile\
        \ name is taken from the backup file, so if a profile with the same name and\
        \ language already exists, it will be overwritten.<br> Requires to be logged\
        \ in and the 'Administer Quality Profiles' permission."
      externalDocs:
        description: Sonarqube Documentation for restore
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualityprofiles/restore
      operationId: v1_get_api_qualityprofiles_restore
      parameters:
      - allowEmptyValue: true
        description: "A profile backup file in XML format, as generated by api/qualityprofiles/backup\
          \ or the former api/profiles/backup."
        explode: true
        in: query
        name: backup
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: restore
  /api/qualityprofiles/search:
    description: Manage quality profiles.
    get:
      description: Search quality profiles
      externalDocs:
        description: Sonarqube Documentation for search
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualityprofiles/search
      operationId: v1_post_api_qualityprofiles_search
      parameters:
      - description: "If set to true, return only the quality profiles marked as default\
          \ for each language"
        explode: true
        in: query
        name: defaults
        required: false
        schema:
          type: string
        style: form
      - description: "Language key. If provided, only profiles for the given language\
          \ are returned."
        explode: true
        in: query
        name: language
        required: false
        schema:
          type: string
        style: form
      - description: Project key
        explode: true
        in: query
        name: project
        required: false
        schema:
          type: string
        style: form
      - description: Quality profile name
        explode: true
        in: query
        name: qualityProfile
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: search
  /api/qualityprofiles/set_default:
    description: Manage quality profiles.
    post:
      description: Select the default profile for a given language.<br> Requires to
        be logged in and the 'Administer Quality Profiles' permission.
      externalDocs:
        description: Sonarqube Documentation for set_default
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/qualityprofiles/set_default
      operationId: v1_get_api_qualityprofiles_set_default
      parameters:
      - allowEmptyValue: true
        description: Quality profile language.
        explode: true
        in: query
        name: language
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Quality profile name.
        explode: true
        in: query
        name: qualityProfile
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: set default
  /api/rules/create:
    description: "Get and update some details of automatic rules, and manage custom\
      \ rules."
    post:
      description: Create a custom rule.<br>Requires the 'Administer Quality Profiles'
        permission
      externalDocs:
        description: Sonarqube Documentation for create
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/rules/create
      operationId: v1_get_api_rules_create
      parameters:
      - description: Clean code attribute
        explode: true
        in: query
        name: cleanCodeAttribute
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Key of the custom rule
        explode: true
        in: query
        name: customKey
        required: true
        schema:
          type: string
        style: form
      - description: Impacts as semi-colon list of &lt;software_quality&gt;=&lt;severity&gt;
        explode: true
        in: query
        name: impacts
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Rule description in <a href='/formatting/help'>markdown format</a>
        explode: true
        in: query
        name: markdownDescription
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Rule name
        explode: true
        in: query
        name: name
        required: true
        schema:
          type: string
        style: form
      - description: Parameters as semi-colon list of &lt;key&gt;=&lt;value&gt;
        explode: true
        in: query
        name: params
        required: false
        schema:
          type: string
        style: form
      - description: "If set to true and if the rule has been deactivated (status\
          \ 'REMOVED'), a status 409 will be returned"
        explode: true
        in: query
        name: preventReactivation
        required: false
        schema:
          type: string
        style: form
      - description: Rule severity
        explode: true
        in: query
        name: severity
        required: false
        schema:
          type: string
        style: form
      - description: Rule status
        explode: true
        in: query
        name: status
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Key of the template rule in order to create a custom rule
        explode: true
        in: query
        name: templateKey
        required: true
        schema:
          type: string
        style: form
      - description: Rule type
        explode: true
        in: query
        name: type
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: create
  /api/rules/delete:
    description: "Get and update some details of automatic rules, and manage custom\
      \ rules."
    post:
      description: Delete custom rule.<br/>Requires the 'Administer Quality Profiles'
        permission
      externalDocs:
        description: Sonarqube Documentation for delete
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/rules/delete
      operationId: v1_get_api_rules_delete
      parameters:
      - allowEmptyValue: true
        description: Rule key
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: delete
  /api/rules/repositories:
    description: "Get and update some details of automatic rules, and manage custom\
      \ rules."
    get:
      description: List available rule repositories
      externalDocs:
        description: Sonarqube Documentation for repositories
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/rules/repositories
      operationId: v1_post_api_rules_repositories
      parameters:
      - description: "A language key; if provided, only repositories for the given\
          \ language will be returned"
        explode: true
        in: query
        name: language
        required: false
        schema:
          type: string
        style: form
      - description: A pattern to match repository keys/names against
        explode: true
        in: query
        name: q
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: repositories
  /api/rules/search:
    description: "Get and update some details of automatic rules, and manage custom\
      \ rules."
    get:
      description: Search for a collection of relevant rules matching a specified
        query.<br/>
      externalDocs:
        description: Sonarqube Documentation for search
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/rules/search
      operationId: v1_post_api_rules_search
      parameters:
      - description: Filter rules that are activated or deactivated on the selected
          Quality profile. Ignored if the parameter 'qprofile' is not set.
        explode: true
        in: query
        name: activation
        required: false
        schema:
          type: string
        style: form
      - description: "Comma-separated list of activation severities, i.e the severity\
          \ of rules in Quality profiles."
        explode: true
        in: query
        name: active_severities
        required: false
        schema:
          type: string
        style: form
      - description: Ascending sort
        explode: true
        in: query
        name: asc
        required: false
        schema:
          type: string
        style: form
      - description: Filters rules added since date. Format is yyyy-MM-dd
        explode: true
        in: query
        name: available_since
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of Clean Code Attribute Categories
        explode: true
        in: query
        name: cleanCodeAttributeCategories
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of CWE identifiers. Use 'unknown' to select
          rules not associated to any CWE.
        explode: true
        in: query
        name: cwe
        required: false
        schema:
          type: string
        style: form
      - description: "Comma-separated list of additional fields to be returned in\
          \ the response. All the fields are returned by default, except actives."
        explode: true
        in: query
        name: f
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of the facets to be computed. No facet is
          computed by default.
        explode: true
        in: query
        name: facets
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of Software Quality Severities
        explode: true
        in: query
        name: impactSeverities
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of Software Qualities
        explode: true
        in: query
        name: impactSoftwareQualities
        required: false
        schema:
          type: string
        style: form
      - description: Include external engine rules in the results
        explode: true
        in: query
        name: include_external
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of values of inheritance for a rule within
          a quality profile. Used only if the parameter 'activation' is set.
        explode: true
        in: query
        name: inheritance
        required: false
        schema:
          type: string
        style: form
      - description: Filter template rules
        explode: true
        in: query
        name: is_template
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of languages
        explode: true
        in: query
        name: languages
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of OWASP Top 10 2017 lowercase categories.
        explode: true
        in: query
        name: owaspTop10
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of OWASP Top 10 2021 lowercase categories.
        explode: true
        in: query
        name: owaspTop10-2021
        required: false
        schema:
          type: string
        style: form
      - description: 1-based page number
        explode: true
        in: query
        name: p
        required: false
        schema:
          type: string
        style: form
      - description: Filter on prioritized rules. Ignored if the parameter 'qprofile'
          is not set.
        explode: true
        in: query
        name: prioritizedRule
        required: false
        schema:
          type: string
        style: form
      - description: Page size. Must be greater than 0 and less or equal than 500
        explode: true
        in: query
        name: ps
        required: false
        schema:
          type: string
        style: form
      - description: UTF-8 search query
        explode: true
        in: query
        name: q
        required: false
        schema:
          type: string
        style: form
      - description: Quality profile key to filter on. Used only if the parameter
          'activation' is set.
        explode: true
        in: query
        name: qprofile
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of repositories
        explode: true
        in: query
        name: repositories
        required: false
        schema:
          type: string
        style: form
      - description: Key of rule to search for
        explode: true
        in: query
        name: rule_key
        required: false
        schema:
          type: string
        style: form
      - description: Sort field
        explode: true
        in: query
        name: s
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of SANS Top 25 categories.
        explode: true
        in: query
        name: sansTop25
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of default severities. Not the same than
          severity of rules in Quality profiles.
        explode: true
        in: query
        name: severities
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of SonarSource security categories. Use
          'others' to select rules not associated with any category
        explode: true
        in: query
        name: sonarsourceSecurity
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of status codes
        explode: true
        in: query
        name: statuses
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of tags. Returned rules match any of the
          tags (OR operator)
        explode: true
        in: query
        name: tags
        required: false
        schema:
          type: string
        style: form
      - description: Key of the template rule to filter on. Used to search for the
          custom rules based on this template.
        explode: true
        in: query
        name: template_key
        required: false
        schema:
          type: string
        style: form
      - description: Comma-separated list of types. Returned rules match any of the
          tags (OR operator)
        explode: true
        in: query
        name: types
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: search
  /api/rules/show:
    description: "Get and update some details of automatic rules, and manage custom\
      \ rules."
    get:
      description: Get detailed information about a rule<br>
      externalDocs:
        description: Sonarqube Documentation for show
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/rules/show
      operationId: v1_post_api_rules_show
      parameters:
      - description: Show rule's activations for all profiles ("active rules")
        explode: true
        in: query
        name: actives
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Rule key
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: show
  /api/rules/tags:
    description: "Get and update some details of automatic rules, and manage custom\
      \ rules."
    get:
      description: List rule tags
      externalDocs:
        description: Sonarqube Documentation for tags
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/rules/tags
      operationId: v1_post_api_rules_tags
      parameters:
      - description: Page size. Must be greater than 0 and less or equal than 500
        explode: true
        in: query
        name: ps
        required: false
        schema:
          type: string
        style: form
      - description: Limit search to tags that contain the supplied string.
        explode: true
        in: query
        name: q
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: tags
  /api/rules/update:
    description: "Get and update some details of automatic rules, and manage custom\
      \ rules."
    post:
      description: Update an existing rule.<br>Requires the 'Administer Quality Profiles'
        permission
      externalDocs:
        description: Sonarqube Documentation for update
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/rules/update
      operationId: v1_get_api_rules_update
      parameters:
      - allowEmptyValue: true
        description: Key of the rule to update
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      - description: Rule description (mandatory for custom rule and manual rule)
          in <a href='/formatting/help'>markdown format</a>
        explode: true
        in: query
        name: markdownDescription
        required: false
        schema:
          type: string
        style: form
      - description: Optional note in <a href='/formatting/help'>markdown format</a>.
          Use empty value to remove current note. Note is not changed if the parameter
          is not set.
        explode: true
        in: query
        name: markdown_note
        required: false
        schema:
          type: string
        style: form
      - description: Rule name (mandatory for custom rule)
        explode: true
        in: query
        name: name
        required: false
        schema:
          type: string
        style: form
      - description: "Parameters as semi-colon list of <key>=<value>, for example\
          \ 'params=key1=v1;key2=v2' (Only when updating a custom rule)"
        explode: true
        in: query
        name: params
        required: false
        schema:
          type: string
        style: form
      - description: Base effort of the remediation function of the rule
        explode: true
        in: query
        name: remediation_fn_base_effort
        required: false
        schema:
          type: string
        style: form
      - description: Type of the remediation function of the rule
        explode: true
        in: query
        name: remediation_fn_type
        required: false
        schema:
          type: string
        style: form
      - description: Gap multiplier of the remediation function of the rule
        explode: true
        in: query
        name: remediation_fy_gap_multiplier
        required: false
        schema:
          type: string
        style: form
      - description: Rule severity (Only when updating a custom rule)
        explode: true
        in: query
        name: severity
        required: false
        schema:
          type: string
        style: form
      - description: Rule status (Only when updating a custom rule)
        explode: true
        in: query
        name: status
        required: false
        schema:
          type: string
        style: form
      - description: Optional comma-separated list of tags to set. Use blank value
          to remove current tags. Tags are not changed if the parameter is not set.
        explode: true
        in: query
        name: tags
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: update
  /api/server/version:
    get:
      description: Version of SonarQube in plain text
      externalDocs:
        description: Sonarqube Documentation for version
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/server/version
      operationId: v1_post_api_server_version
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: version
  /api/settings/list_definitions:
    description: Manage settings.
    get:
      description: "List settings definitions.<br>Requires 'Browse' permission when\
        \ a component is specified<br/>To access licensed settings, authentication\
        \ is required<br/>To access secured settings, one of the following permissions\
        \ is required: <ul><li>'Execute Analysis'</li><li>'Administer System'</li><li>'Administer'\
        \ rights on the specified component</li></ul>"
      externalDocs:
        description: Sonarqube Documentation for list_definitions
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/settings/list_definitions
      operationId: v1_post_api_settings_list_definitions
      parameters:
      - description: Component key
        explode: true
        in: query
        name: component
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: list definitions
  /api/settings/reset:
    description: Manage settings.
    post:
      description: "Remove a setting value.<br>The settings defined in conf/sonar.properties\
        \ are read-only and can't be changed.<br/>Requires one of the following permissions:\
        \ <ul><li>'Administer System'</li><li>'Administer' rights on the specified\
        \ component</li></ul>"
      externalDocs:
        description: Sonarqube Documentation for reset
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/settings/reset
      operationId: v1_get_api_settings_reset
      parameters:
      - description: "Component key. Only keys for projects, applications, portfolios\
          \ or subportfolios are accepted."
        explode: true
        in: query
        name: component
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Comma-separated list of keys
        explode: true
        in: query
        name: keys
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: reset
  /api/settings/set:
    description: Manage settings.
    post:
      description: "Update a setting value.<br>Either 'value' or 'values' must be\
        \ provided.<br> The settings defined in conf/sonar.properties are read-only\
        \ and can't be changed.<br/>Requires one of the following permissions: <ul><li>'Administer\
        \ System'</li><li>'Administer' rights on the specified component</li></ul>"
      externalDocs:
        description: Sonarqube Documentation for set
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/settings/set
      operationId: v1_get_api_settings_set
      parameters:
      - description: "Component key. Only keys for projects, applications, portfolios\
          \ or subportfolios are accepted."
        explode: true
        in: query
        name: component
        required: false
        schema:
          type: string
        style: form
      - description: "Setting field values. To set several values, the parameter must\
          \ be called once for each value."
        explode: true
        in: query
        name: fieldValues
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Setting key
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      - description: "Setting value. To reset a value, please use the reset web service."
        explode: true
        in: query
        name: value
        required: false
        schema:
          type: string
        style: form
      - description: "Setting multi value. To set several values, the parameter must\
          \ be called once for each value."
        explode: true
        in: query
        name: values
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: set
  /api/settings/values:
    description: Manage settings.
    get:
      description: "List settings values.<br>If no value has been set for a setting,\
        \ then the default value is returned.<br>The settings from conf/sonar.properties\
        \ are excluded from results.<br>Requires 'Browse' or 'Execute Analysis' permission\
        \ when a component is specified.<br/>Secured settings values are not returned\
        \ by the endpoint.<br/>"
      externalDocs:
        description: Sonarqube Documentation for values
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/settings/values
      operationId: v1_post_api_settings_values
      parameters:
      - description: Component key
        explode: true
        in: query
        name: component
        required: false
        schema:
          type: string
        style: form
      - description: List of setting keys
        explode: true
        in: query
        name: keys
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: values
  /api/sources/raw:
    description: Get details on source files. See also api/tests.
    get:
      description: Get source code as raw text. Require 'See Source Code' permission
        on file
      externalDocs:
        description: Sonarqube Documentation for raw
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/sources/raw
      operationId: v1_post_api_sources_raw
      parameters:
      - allowEmptyValue: true
        description: File key
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: raw
  /api/sources/scm:
    description: Get details on source files. See also api/tests.
    get:
      description: Get SCM information of source files. Require See Source Code permission
        on file's project<br/>Each element of the result array is composed of:<ol><li>Line
        number</li><li>Author of the commit</li><li>Datetime of the commit (before
        5.2 it was only the Date)</li><li>Revision of the commit (added in 5.2)</li></ol>
      externalDocs:
        description: Sonarqube Documentation for scm
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/sources/scm
      operationId: v1_post_api_sources_scm
      parameters:
      - description: "Group lines by SCM commit if value is false, else display commits\
          \ for each line, even if two consecutive lines relate to the same commit."
        explode: true
        in: query
        name: commits_by_line
        required: false
        schema:
          type: string
        style: form
      - description: First line to return. Starts at 1
        explode: true
        in: query
        name: from
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: File key
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      - description: Last line to return (inclusive)
        explode: true
        in: query
        name: to
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: scm
  /api/sources/show:
    description: Get details on source files. See also api/tests.
    get:
      description: Get source code. Requires See Source Code permission on file's
        project<br/>Each element of the result array is composed of:<ol><li>Line number</li><li>Content
        of the line</li></ol>
      externalDocs:
        description: Sonarqube Documentation for show
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/sources/show
      operationId: v1_post_api_sources_show
      parameters:
      - description: First line to return. Starts at 1
        explode: true
        in: query
        name: from
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: File key
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      - description: Last line to return (inclusive)
        explode: true
        in: query
        name: to
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: show
  /api/system/change_log_level:
    description: "Get system details, and perform some management actions, such as\
      \ restarting, and initiating a database migration (as part of a system upgrade)."
    post:
      description: Temporarily changes level of logs. New level is not persistent
        and is lost when restarting server. Requires system administration permission.
      externalDocs:
        description: Sonarqube Documentation for change_log_level
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/system/change_log_level
      operationId: v1_get_api_system_change_log_level
      parameters:
      - allowEmptyValue: true
        description: "The new level. Be cautious: DEBUG, and even more TRACE, may\
          \ have performance impacts."
        explode: true
        in: query
        name: level
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: change log level
  /api/system/db_migration_status:
    description: "Get system details, and perform some management actions, such as\
      \ restarting, and initiating a database migration (as part of a system upgrade)."
    get:
      description: "Display the database migration status of SonarQube.<br/>State\
        \ values are:<ul><li>NO_MIGRATION: DB is up to date with current version of\
        \ SonarQube.</li><li>NOT_SUPPORTED: Migration is not supported on embedded\
        \ databases.</li><li>MIGRATION_RUNNING: DB migration is under go.</li><li>MIGRATION_SUCCEEDED:\
        \ DB migration has run and has been successful.</li><li>MIGRATION_FAILED:\
        \ DB migration has run and failed. SonarQube must be restarted in order to\
        \ retry a DB migration (optionally after DB has been restored from backup).</li><li>MIGRATION_REQUIRED:\
        \ DB migration is required.</li></ul>"
      externalDocs:
        description: Sonarqube Documentation for db_migration_status
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/system/db_migration_status
      operationId: v1_post_api_system_db_migration_status
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: db migration status
  /api/system/health:
    description: "Get system details, and perform some management actions, such as\
      \ restarting, and initiating a database migration (as part of a system upgrade)."
    get:
      description: "Provide health status of SonarQube.<p>Although global health is\
        \ calculated based on both application and search nodes, detailed information\
        \ is returned only for application nodes.</p><p>  <ul> <li>GREEN: SonarQube\
        \ is fully operational</li> <li>YELLOW: SonarQube is usable, but it needs\
        \ attention in order to be fully operational</li> <li>RED: SonarQube is not\
        \ operational</li> </ul></p><br>Requires the 'Administer System' permission\
        \ or system passcode (see WEB_SYSTEM_PASS_CODE in sonar.properties).<br>When\
        \ SonarQube is in safe mode (waiting or running a database upgrade), only\
        \ the authentication with a system passcode is supported."
      externalDocs:
        description: Sonarqube Documentation for health
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/system/health
      operationId: v1_post_api_system_health
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: health
  /api/system/info:
    description: "Get system details, and perform some management actions, such as\
      \ restarting, and initiating a database migration (as part of a system upgrade)."
    get:
      description: Get detailed information about system configuration.<br/>Requires
        'Administer' permissions.
      externalDocs:
        description: Sonarqube Documentation for info
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/system/info
      operationId: v1_post_api_system_info
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: info
  /api/system/logs:
    description: "Get system details, and perform some management actions, such as\
      \ restarting, and initiating a database migration (as part of a system upgrade)."
    get:
      description: Get system logs in plain-text format. Requires system administration
        permission.
      externalDocs:
        description: Sonarqube Documentation for logs
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/system/logs
      operationId: v1_post_api_system_logs
      parameters:
      - description: Name of the logs to get
        explode: true
        in: query
        name: name
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: logs
  /api/system/migrate_db:
    description: "Get system details, and perform some management actions, such as\
      \ restarting, and initiating a database migration (as part of a system upgrade)."
    post:
      description: "Migrate the database to match the current version of SonarQube.<br/>Sending\
        \ a POST request to this URL starts the DB migration. It is strongly advised\
        \ to <strong>make a database backup</strong> before invoking this WS.<br/>State\
        \ values are:<ul><li>NO_MIGRATION: DB is up to date with current version of\
        \ SonarQube.</li><li>NOT_SUPPORTED: Migration is not supported on embedded\
        \ databases.</li><li>MIGRATION_RUNNING: DB migration is under go.</li><li>MIGRATION_SUCCEEDED:\
        \ DB migration has run and has been successful.</li><li>MIGRATION_FAILED:\
        \ DB migration has run and failed. SonarQube must be restarted in order to\
        \ retry a DB migration (optionally after DB has been restored from backup).</li><li>MIGRATION_REQUIRED:\
        \ DB migration is required.</li></ul>"
      externalDocs:
        description: Sonarqube Documentation for migrate_db
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/system/migrate_db
      operationId: v1_get_api_system_migrate_db
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: migrate db
  /api/system/ping:
    description: "Get system details, and perform some management actions, such as\
      \ restarting, and initiating a database migration (as part of a system upgrade)."
    get:
      description: Answers "pong" as plain-text
      externalDocs:
        description: Sonarqube Documentation for ping
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/system/ping
      operationId: v1_post_api_system_ping
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: ping
  /api/system/restart:
    description: "Get system details, and perform some management actions, such as\
      \ restarting, and initiating a database migration (as part of a system upgrade)."
    post:
      description: "Restarts server. Requires 'Administer System' permission. Performs\
        \ a full restart of the Web, Search and Compute Engine Servers processes.\
        \ Does not reload sonar.properties."
      externalDocs:
        description: Sonarqube Documentation for restart
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/system/restart
      operationId: v1_get_api_system_restart
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: restart
  /api/system/status:
    description: "Get system details, and perform some management actions, such as\
      \ restarting, and initiating a database migration (as part of a system upgrade)."
    get:
      description: "Get state information about SonarQube.<p>status: the running status\
        \ <ul> <li>STARTING: SonarQube Web Server is up and serving some Web Services\
        \ (eg. api/system/status) but initialization is still ongoing</li> <li>UP:\
        \ SonarQube instance is up and running</li> <li>DOWN: SonarQube instance is\
        \ up but not running because migration has failed (refer to WS /api/system/migrate_db\
        \ for details) or some other reason (check logs).</li> <li>RESTARTING: SonarQube\
        \ instance is still up but a restart has been requested (refer to WS /api/system/restart\
        \ for details).</li> <li>DB_MIGRATION_NEEDED: database migration is required.\
        \ DB migration can be started using WS /api/system/migrate_db.</li> <li>DB_MIGRATION_RUNNING:\
        \ DB migration is running (refer to WS /api/system/migrate_db for details)</li>\
        \ </ul></p>"
      externalDocs:
        description: Sonarqube Documentation for status
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/system/status
      operationId: v1_post_api_system_status
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: status
  /api/system/upgrades:
    description: "Get system details, and perform some management actions, such as\
      \ restarting, and initiating a database migration (as part of a system upgrade)."
    get:
      description: "Lists available upgrades for the SonarQube instance (if any) and\
        \ for each one, lists incompatible plugins and plugins requiring upgrade.<br/>Plugin\
        \ information is retrieved from Update Center. Date and time at which Update\
        \ Center was last refreshed is provided in the response."
      externalDocs:
        description: Sonarqube Documentation for upgrades
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/system/upgrades
      operationId: v1_post_api_system_upgrades
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: upgrades
  /api/user_groups/add_user:
    description: Manage user groups.
    post:
      description: "Add a user to a group.<br />'name' must be provided.<br />Requires\
        \ the following permission: 'Administer System'."
      externalDocs:
        description: Sonarqube Documentation for add_user
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/user_groups/add_user
      operationId: v1_get_api_user_groups_add_user
      parameters:
      - description: User login
        explode: true
        in: query
        name: login
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Group name
        explode: true
        in: query
        name: name
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: add user
  /api/user_groups/create:
    description: Manage user groups.
    post:
      description: "Create a group.<br>Requires the following permission: 'Administer\
        \ System'."
      externalDocs:
        description: Sonarqube Documentation for create
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/user_groups/create
      operationId: v1_get_api_user_groups_create
      parameters:
      - description: Description for the new group. A group description cannot be
          larger than 200 characters.
        explode: true
        in: query
        name: description
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Name for the new group. A group name cannot be larger than 255
          characters and must be unique. The value 'anyone' (whatever the case) is
          reserved and cannot be used.
        explode: true
        in: query
        name: name
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: create
  /api/user_groups/delete:
    description: Manage user groups.
    post:
      description: "Delete a group. The default groups cannot be deleted.<br/>'name'\
        \ must be provided.<br />Requires the following permission: 'Administer System'."
      externalDocs:
        description: Sonarqube Documentation for delete
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/user_groups/delete
      operationId: v1_get_api_user_groups_delete
      parameters:
      - allowEmptyValue: true
        description: Group name
        explode: true
        in: query
        name: name
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: delete
  /api/user_groups/remove_user:
    description: Manage user groups.
    post:
      description: "Remove a user from a group.<br />'name' must be provided.<br>Requires\
        \ the following permission: 'Administer System'."
      externalDocs:
        description: Sonarqube Documentation for remove_user
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/user_groups/remove_user
      operationId: v1_get_api_user_groups_remove_user
      parameters:
      - description: User login
        explode: true
        in: query
        name: login
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Group name
        explode: true
        in: query
        name: name
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: remove user
  /api/user_groups/search:
    description: Manage user groups.
    get:
      description: "Search for user groups.<br>Requires the following permission:\
        \ 'Administer System'."
      externalDocs:
        description: Sonarqube Documentation for search
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/user_groups/search
      operationId: v1_post_api_user_groups_search
      parameters:
      - description: Comma-separated list of the fields to be returned in response.
          All the fields are returned by default.
        explode: true
        in: query
        name: f
        required: false
        schema:
          type: string
        style: form
      - description: "Return managed or non-managed groups. Only available for managed\
          \ instances, throws for non-managed instances."
        explode: true
        in: query
        name: managed
        required: false
        schema:
          type: string
        style: form
      - description: 1-based page number
        explode: true
        in: query
        name: p
        required: false
        schema:
          type: string
        style: form
      - description: Page size. Must be greater than 0 and less or equal than 500
        explode: true
        in: query
        name: ps
        required: false
        schema:
          type: string
        style: form
      - description: Limit search to names that contain the supplied string.
        explode: true
        in: query
        name: q
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: search
  /api/user_groups/update:
    description: Manage user groups.
    post:
      description: "Update a group.<br>Requires the following permission: 'Administer\
        \ System'."
      externalDocs:
        description: Sonarqube Documentation for update
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/user_groups/update
      operationId: v1_get_api_user_groups_update
      parameters:
      - allowEmptyValue: true
        description: Name of the group to be updated.
        explode: true
        in: query
        name: currentName
        required: true
        schema:
          type: string
        style: form
      - description: "New optional description for the group. A group description\
          \ cannot be larger than 200 characters. If value is not defined, then description\
          \ is not changed."
        explode: true
        in: query
        name: description
        required: false
        schema:
          type: string
        style: form
      - description: "New optional name for the group. A group name cannot be larger\
          \ than 255 characters and must be unique. Value 'anyone' (whatever the case)\
          \ is reserved and cannot be used. If value is empty or not defined, then\
          \ name is not changed."
        explode: true
        in: query
        name: name
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: update
  /api/user_groups/users:
    description: Manage user groups.
    get:
      description: "Search for users with membership information with respect to a\
        \ group.<br>Requires the following permission: 'Administer System'."
      externalDocs:
        description: Sonarqube Documentation for users
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/user_groups/users
      operationId: v1_post_api_user_groups_users
      parameters:
      - allowEmptyValue: true
        description: Group name
        explode: true
        in: query
        name: name
        required: true
        schema:
          type: string
        style: form
      - description: 1-based page number
        explode: true
        in: query
        name: p
        required: false
        schema:
          type: string
        style: form
      - description: Page size. Must be greater than 0.
        explode: true
        in: query
        name: ps
        required: false
        schema:
          type: string
        style: form
      - description: Limit search to names or logins that contain the supplied string.
        explode: true
        in: query
        name: q
        required: false
        schema:
          type: string
        style: form
      - description: "Depending on the value, show only selected items (selected=selected),\
          \ deselected items (selected=deselected), or all items with their selection\
          \ status (selected=all)."
        explode: true
        in: query
        name: selected
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: users
  /api/user_tokens/generate:
    description: "List, create, and delete a user's access tokens."
    post:
      description: "Generate a user access token. <br />Please keep your tokens secret.\
        \ They enable to authenticate and analyze projects.<br />It requires administration\
        \ permissions to specify a 'login' and generate a token for another user.\
        \ Otherwise, a token is generated for the current user."
      externalDocs:
        description: Sonarqube Documentation for generate
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/user_tokens/generate
      operationId: v1_get_api_user_tokens_generate
      parameters:
      - description: "The expiration date of the token being generated, in ISO 8601\
          \ format (YYYY-MM-DD). If not set, default to no expiration."
        explode: true
        in: query
        name: expirationDate
        required: false
        schema:
          type: string
        style: form
      - description: "User login. If not set, the token is generated for the authenticated\
          \ user."
        explode: true
        in: query
        name: login
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Token name
        explode: true
        in: query
        name: name
        required: true
        schema:
          type: string
        style: form
      - description: The key of the only project that can be analyzed by the PROJECT_ANALYSIS_TOKEN
          being generated.
        explode: true
        in: query
        name: projectKey
        required: false
        schema:
          type: string
        style: form
      - description: "Token Type. If this parameters is set to PROJECT_ANALYSIS_TOKEN,\
          \ it is necessary to provide the projectKey parameter too."
        explode: true
        in: query
        name: type
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: generate
  /api/user_tokens/revoke:
    description: "List, create, and delete a user's access tokens."
    post:
      description: "Revoke a user access token. <br/>It requires administration permissions\
        \ to specify a 'login' and revoke a token for another user. Otherwise, the\
        \ token for the current user is revoked."
      externalDocs:
        description: Sonarqube Documentation for revoke
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/user_tokens/revoke
      operationId: v1_get_api_user_tokens_revoke
      parameters:
      - description: User login
        explode: true
        in: query
        name: login
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Token name
        explode: true
        in: query
        name: name
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: revoke
  /api/user_tokens/search:
    description: "List, create, and delete a user's access tokens."
    get:
      description: "List the access tokens of a user.<br>The login must exist and\
        \ active.<br>Field 'lastConnectionDate' is only updated every hour, so it\
        \ may not be accurate, for instance when a user is using a token many times\
        \ in less than one hour.<br> It requires administration permissions to specify\
        \ a 'login' and list the tokens of another user. Otherwise, tokens for the\
        \ current user are listed. <br> Authentication is required for this API endpoint"
      externalDocs:
        description: Sonarqube Documentation for search
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/user_tokens/search
      operationId: v1_post_api_user_tokens_search
      parameters:
      - description: User login
        explode: true
        in: query
        name: login
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: search
  /api/users/anonymize:
    description: Manage users.
    post:
      description: Anonymize a deactivated user. Requires Administer System permission
      externalDocs:
        description: Sonarqube Documentation for anonymize
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/users/anonymize
      operationId: v1_get_api_users_anonymize
      parameters:
      - allowEmptyValue: true
        description: User login
        explode: true
        in: query
        name: login
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: anonymize
  /api/users/change_password:
    description: Manage users.
    post:
      description: "Update a user's password. Authenticated users can change their\
        \ own password, provided that the account is not linked to an external authentication\
        \ system. Administer System permission is required to change another user's\
        \ password."
      externalDocs:
        description: Sonarqube Documentation for change_password
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/users/change_password
      operationId: v1_get_api_users_change_password
      parameters:
      - allowEmptyValue: true
        description: User login
        explode: true
        in: query
        name: login
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: New password
        explode: true
        in: query
        name: password
        required: true
        schema:
          type: string
        style: form
      - description: Previous password. Required when changing one's own password.
        explode: true
        in: query
        name: previousPassword
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: change password
  /api/users/create:
    description: Manage users.
    post:
      description: "Create a user.<br/>If a deactivated user account exists with the\
        \ given login, it will be reactivated.<br/>Requires Administer System permission"
      externalDocs:
        description: Sonarqube Documentation for create
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/users/create
      operationId: v1_get_api_users_create
      parameters:
      - description: User email
        explode: true
        in: query
        name: email
        required: false
        schema:
          type: string
        style: form
      - description: Specify if the user should be authenticated from SonarQube server
          or from an external authentication system. Password should not be set when
          local is set to false.
        explode: true
        in: query
        name: local
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: User login
        explode: true
        in: query
        name: login
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: User name
        explode: true
        in: query
        name: name
        required: true
        schema:
          type: string
        style: form
      - description: "User password. Only mandatory when creating local user, otherwise\
          \ it should not be set"
        explode: true
        in: query
        name: password
        required: false
        schema:
          type: string
        style: form
      - description: "List of SCM accounts. To set several values, the parameter must\
          \ be called once for each value."
        explode: true
        in: query
        name: scmAccount
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: create
  /api/users/deactivate:
    description: Manage users.
    post:
      description: Deactivate a user. Requires Administer System permission
      externalDocs:
        description: Sonarqube Documentation for deactivate
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/users/deactivate
      operationId: v1_get_api_users_deactivate
      parameters:
      - description: Anonymize user in addition to deactivating it
        explode: true
        in: query
        name: anonymize
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: User login
        explode: true
        in: query
        name: login
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: deactivate
  /api/users/groups:
    description: Manage users.
    get:
      description: Lists the groups a user belongs to. <br/>Requires Administer System
        permission.
      externalDocs:
        description: Sonarqube Documentation for groups
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/users/groups
      operationId: v1_post_api_users_groups
      parameters:
      - allowEmptyValue: true
        description: A user login
        explode: true
        in: query
        name: login
        required: true
        schema:
          type: string
        style: form
      - description: 1-based page number
        explode: true
        in: query
        name: p
        required: false
        schema:
          type: string
        style: form
      - description: Page size. Must be greater than 0.
        explode: true
        in: query
        name: ps
        required: false
        schema:
          type: string
        style: form
      - description: Limit search to group names that contain the supplied string.
        explode: true
        in: query
        name: q
        required: false
        schema:
          type: string
        style: form
      - description: "Depending on the value, show only selected items (selected=selected),\
          \ deselected items (selected=deselected), or all items with their selection\
          \ status (selected=all)."
        explode: true
        in: query
        name: selected
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: groups
  /api/users/search:
    description: Manage users.
    get:
      description: "Get a list of users. By default, only active users are returned.<br/>The\
        \ following fields are only returned when user has Administer System permission\
        \ or for logged-in in user :<ul>   <li>'email'</li>   <li>'externalIdentity'</li>\
        \   <li>'externalProvider'</li>   <li>'groups'</li>   <li>'lastConnectionDate'</li>\
        \   <li>'sonarLintLastConnectionDate'</li>   <li>'tokensCount'</li></ul>Field\
        \ 'lastConnectionDate' is only updated every hour, so it may not be accurate,\
        \ for instance when a user authenticates many times in less than one hour."
      externalDocs:
        description: Sonarqube Documentation for search
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/users/search
      operationId: v1_post_api_users_search
      parameters:
      - description: Return deactivated users instead of active users
        explode: true
        in: query
        name: deactivated
        required: false
        schema:
          type: string
        style: form
      - description: |
          Find a user by its external identity (ie. its login in the Identity Provider).
          This is case sensitive and only available with Administer System permission.
        explode: true
        in: query
        name: externalIdentity
        required: false
        schema:
          type: string
        style: form
      - description: |-
          Filter the users based on the last connection date field.
          Only users who interacted with this instance at or after the date will be returned.
          The format must be ISO 8601 datetime format (YYYY-MM-DDThh:mm:ss±hhmm)
        explode: true
        in: query
        name: lastConnectedAfter
        required: false
        schema:
          type: string
        style: form
      - description: |-
          Filter the users based on the last connection date field.
          Only users that never connected or who interacted with this instance at or before the date will be returned.
          The format must be ISO 8601 datetime format (YYYY-MM-DDThh:mm:ss±hhmm)
        explode: true
        in: query
        name: lastConnectedBefore
        required: false
        schema:
          type: string
        style: form
      - description: "Return managed or non-managed users. Only available for managed\
          \ instances, throws for non-managed instances."
        explode: true
        in: query
        name: managed
        required: false
        schema:
          type: string
        style: form
      - description: 1-based page number
        explode: true
        in: query
        name: p
        required: false
        schema:
          type: string
        style: form
      - description: Page size. Must be greater than 0 and less or equal than 500
        explode: true
        in: query
        name: ps
        required: false
        schema:
          type: string
        style: form
      - description: "Filter on login, name and email.<br />This parameter performs\
          \ a partial match (contains), it is case insensitive."
        explode: true
        in: query
        name: q
        required: false
        schema:
          type: string
        style: form
      - description: |-
          Filter the users based on the sonar lint last connection date field
          Only users who interacted with this instance using SonarLint at or after the date will be returned.
          The format must be ISO 8601 datetime format (YYYY-MM-DDThh:mm:ss±hhmm)
        explode: true
        in: query
        name: slLastConnectedAfter
        required: false
        schema:
          type: string
        style: form
      - description: |-
          Filter the users based on the sonar lint last connection date field.
          Only users that never connected or who interacted with this instance using SonarLint at or before the date will be returned.
          The format must be ISO 8601 datetime format (YYYY-MM-DDThh:mm:ss±hhmm)
        explode: true
        in: query
        name: slLastConnectedBefore
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: search
  /api/users/update:
    description: Manage users.
    post:
      description: Update a user.<br/>Requires Administer System permission
      externalDocs:
        description: Sonarqube Documentation for update
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/users/update
      operationId: v1_get_api_users_update
      parameters:
      - description: User email
        explode: true
        in: query
        name: email
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: User login
        explode: true
        in: query
        name: login
        required: true
        schema:
          type: string
        style: form
      - description: User name
        explode: true
        in: query
        name: name
        required: false
        schema:
          type: string
        style: form
      - description: "SCM accounts. To set several values, the parameter must be called\
          \ once for each value."
        explode: true
        in: query
        name: scmAccount
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: update
  /api/users/update_identity_provider:
    description: Manage users.
    post:
      description: "Update identity provider information. <br/>It's only possible\
        \ to migrate to an installed identity provider. Be careful that as soon as\
        \ this information has been updated for a user, the user will only be able\
        \ to authenticate on the new identity provider. It is not possible to migrate\
        \ external user to local one.<br/>Requires Administer System permission."
      externalDocs:
        description: Sonarqube Documentation for update_identity_provider
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/users/update_identity_provider
      operationId: v1_get_api_users_update_identity_provider
      parameters:
      - allowEmptyValue: true
        description: User login
        explode: true
        in: query
        name: login
        required: true
        schema:
          type: string
        style: form
      - description: "New external identity, usually the login used in the authentication\
          \ system. If not provided previous identity will be used."
        explode: true
        in: query
        name: newExternalIdentity
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: "New external provider. Only authentication system installed\
          \ are available. Use 'LDAP' identity provider for single server LDAP setup.Use\
          \ 'LDAP_{serverKey}' identity provider for multiple LDAP servers setup."
        explode: true
        in: query
        name: newExternalProvider
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: update identity provider
  /api/users/update_login:
    description: Manage users.
    post:
      description: Update a user login. A login can be updated many times.<br/>Requires
        Administer System permission
      externalDocs:
        description: Sonarqube Documentation for update_login
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/users/update_login
      operationId: v1_get_api_users_update_login
      parameters:
      - allowEmptyValue: true
        description: The current login (case-sensitive)
        explode: true
        in: query
        name: login
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: The new login. It must not already exist.
        explode: true
        in: query
        name: newLogin
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: update login
  /api/views/add_application:
    description: Manage portfolios.
    post:
      description: Add an existing application to a portfolio.<br>Authentication is
        required for this API endpoint.
      externalDocs:
        description: Sonarqube Documentation for add_application
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/views/add_application
      operationId: v1_get_api_views_add_application
      parameters:
      - allowEmptyValue: true
        description: Key of the application to be added
        explode: true
        in: query
        name: application
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Key of the portfolio where the application will be added
        explode: true
        in: query
        name: portfolio
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: add application
  /api/views/add_application_branch:
    description: Manage portfolios.
    post:
      description: Add a branch of an application selected in a portfolio.<br/>Requires
        'Administrator' permission on the portfolio and 'Browse' permission for the
        application.
      externalDocs:
        description: Sonarqube Documentation for add_application_branch
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/views/add_application_branch
      operationId: v1_get_api_views_add_application_branch
      parameters:
      - allowEmptyValue: true
        description: Key of the application
        explode: true
        in: query
        name: application
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Key of the branch
        explode: true
        in: query
        name: branch
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Key of the portfolio
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: add application branch
  /api/views/add_portfolio:
    description: Manage portfolios.
    post:
      description: Add an existing portfolio to the structure of another portfolio.<br>
        Authentication is required for this API endpoint.
      externalDocs:
        description: Sonarqube Documentation for add_portfolio
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/views/add_portfolio
      operationId: v1_get_api_views_add_portfolio
      parameters:
      - allowEmptyValue: true
        description: Key of the portfolio where a reference will be added
        explode: true
        in: query
        name: portfolio
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Key of the portfolio to be added
        explode: true
        in: query
        name: reference
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: add portfolio
  /api/views/add_project:
    description: Manage portfolios.
    post:
      description: Add a project to a portfolio.<br/>Requires 'Administrator' permission
        on the portfolio and 'Browse' permission for adding project.
      externalDocs:
        description: Sonarqube Documentation for add_project
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/views/add_project
      operationId: v1_get_api_views_add_project
      parameters:
      - allowEmptyValue: true
        description: Key of the portfolio
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Key of the project
        explode: true
        in: query
        name: project
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: add project
  /api/views/add_project_branch:
    description: Manage portfolios.
    post:
      description: Add a branch of a project selected in a portfolio.<br/>Requires
        'Administrator' permission on the portfolio and 'Browse' permission for the
        project.
      externalDocs:
        description: Sonarqube Documentation for add_project_branch
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/views/add_project_branch
      operationId: v1_get_api_views_add_project_branch
      parameters:
      - allowEmptyValue: true
        description: Key of the branch
        explode: true
        in: query
        name: branch
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Key of the portfolio
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Key of the project
        explode: true
        in: query
        name: project
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: add project branch
  /api/views/applications:
    description: Manage portfolios.
    get:
      description: List applications which the user has access to that can be added
        to a portfolio. <br> Authentication is required for this API endpoint
      externalDocs:
        description: Sonarqube Documentation for applications
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/views/applications
      operationId: v1_post_api_views_applications
      parameters:
      - allowEmptyValue: true
        description: Key of the would-be parent portfolio
        explode: true
        in: query
        name: portfolio
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: applications
  /api/views/create:
    description: Manage portfolios.
    post:
      description: "Create a new portfolio.<br/>Requires 'Administer System' permission\
        \ or 'Create Portfolios' permission,"
      externalDocs:
        description: Sonarqube Documentation for create
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/views/create
      operationId: v1_get_api_views_create
      parameters:
      - description: "Description for the new portfolio, can be left blank"
        explode: true
        in: query
        name: description
        required: false
        schema:
          type: string
        style: form
      - description: Key for the new portfolio. A suitable key will be generated if
          not provided
        explode: true
        in: query
        name: key
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Name for the new portfolio
        explode: true
        in: query
        name: name
        required: true
        schema:
          type: string
        style: form
      - description: "Key of the parent portfolio, when creating a sub portfolio"
        explode: true
        in: query
        name: parent
        required: false
        schema:
          type: string
        style: form
      - description: "Whether the created portfolio or application should be visible\
          \ to everyone, or only specific user/groups.<br/>Only applies to root portfolios.\
          \ If no visibility is specified, the default visibility will be used."
        explode: true
        in: query
        name: visibility
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: create
  /api/views/delete:
    description: Manage portfolios.
    post:
      description: Delete a portfolio definition. <br/>Requires 'Administrator' permission
        on the portfolio.
      externalDocs:
        description: Sonarqube Documentation for delete
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/views/delete
      operationId: v1_get_api_views_delete
      parameters:
      - allowEmptyValue: true
        description: Portfolio key
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: delete
  /api/views/list:
    description: Manage portfolios.
    get:
      description: List root portfolios. <br>Requires authentication. Only portfolios
        with the admin permission are returned.
      externalDocs:
        description: Sonarqube Documentation for list
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/views/list
      operationId: v1_post_api_views_list
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: list
  /api/views/move:
    description: Manage portfolios.
    post:
      description: Move a portfolio. <br> Authentication is required for this API
        endpoint.
      externalDocs:
        description: Sonarqube Documentation for move
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/views/move
      operationId: v1_get_api_views_move
      parameters:
      - allowEmptyValue: true
        description: Key of the destination portfolio
        explode: true
        in: query
        name: destination
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Key of the portfolio to move
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: move
  /api/views/move_options:
    description: Manage portfolios.
    get:
      description: List possible portfolio destinations. <br> Authentication is required
        for this API endpoint.
      externalDocs:
        description: Sonarqube Documentation for move_options
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/views/move_options
      operationId: v1_post_api_views_move_options
      parameters:
      - allowEmptyValue: true
        description: Key of the portfolio to move
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: move options
  /api/views/portfolios:
    description: Manage portfolios.
    get:
      description: List portfolios that can be referenced. <br> Authentication is
        required for this API endpoint.
      externalDocs:
        description: Sonarqube Documentation for portfolios
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/views/portfolios
      operationId: v1_post_api_views_portfolios
      parameters:
      - allowEmptyValue: true
        description: Key of the would-be parent portfolio
        explode: true
        in: query
        name: portfolio
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: portfolios
  /api/views/remove_application:
    description: Manage portfolios.
    post:
      description: Remove an application from a portfolio. <br/>Requires 'Administrator'
        permission on the portfolio.
      externalDocs:
        description: Sonarqube Documentation for remove_application
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/views/remove_application
      operationId: v1_get_api_views_remove_application
      parameters:
      - allowEmptyValue: true
        description: Key of the application to be removed
        explode: true
        in: query
        name: application
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Portfolio key
        explode: true
        in: query
        name: portfolio
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: remove application
  /api/views/remove_application_branch:
    description: Manage portfolios.
    post:
      description: Remove a branch of an application selected in a portfolio.<br/>Requires
        'Administrator' permission on the portfolio and 'Browse' permission for the
        application.
      externalDocs:
        description: Sonarqube Documentation for remove_application_branch
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/views/remove_application_branch
      operationId: v1_get_api_views_remove_application_branch
      parameters:
      - allowEmptyValue: true
        description: Key of the project
        explode: true
        in: query
        name: application
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Key of the branch
        explode: true
        in: query
        name: branch
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Key of the portfolio
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: remove application branch
  /api/views/remove_portfolio:
    description: Manage portfolios.
    post:
      description: Remove a reference to a portfolio. <br/>Requires 'Administrator'
        permission on the portfolio.
      externalDocs:
        description: Sonarqube Documentation for remove_portfolio
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/views/remove_portfolio
      operationId: v1_get_api_views_remove_portfolio
      parameters:
      - allowEmptyValue: true
        description: Portfolio key
        explode: true
        in: query
        name: portfolio
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Key of the referenced portfolio to be removed
        explode: true
        in: query
        name: reference
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: remove portfolio
  /api/views/remove_project:
    description: Manage portfolios.
    post:
      description: Remove a project from a portfolio.<br/>Requires 'Administrator'
        permission on the portfolio.
      externalDocs:
        description: Sonarqube Documentation for remove_project
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/views/remove_project
      operationId: v1_get_api_views_remove_project
      parameters:
      - allowEmptyValue: true
        description: Key of the portfolio
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Key of the project
        explode: true
        in: query
        name: project
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: remove project
  /api/views/remove_project_branch:
    description: Manage portfolios.
    post:
      description: Remove a branch of a project selected in a portfolio.<br/>Requires
        'Administrator' permission on the portfolio and 'Browse' permission for the
        project.
      externalDocs:
        description: Sonarqube Documentation for remove_project_branch
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/views/remove_project_branch
      operationId: v1_get_api_views_remove_project_branch
      parameters:
      - allowEmptyValue: true
        description: Key of the branch
        explode: true
        in: query
        name: branch
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Key of the portfolio
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Key of the project
        explode: true
        in: query
        name: project
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: remove project branch
  /api/views/set_manual_mode:
    description: Manage portfolios.
    post:
      description: "Set the projects selection mode of a portfolio on manual selection.<br/>In\
        \ order to add project, please use api/view/add_project.<br/>Requires 'Administrator'\
        \ permission on the portfolio."
      externalDocs:
        description: Sonarqube Documentation for set_manual_mode
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/views/set_manual_mode
      operationId: v1_get_api_views_set_manual_mode
      parameters:
      - allowEmptyValue: true
        description: Key of the portfolio or sub-portfolio to update
        explode: true
        in: query
        name: portfolio
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: set manual mode
  /api/views/set_none_mode:
    description: Manage portfolios.
    post:
      description: Set the projects selection mode of a portfolio to none.<br/>After
        setting this mode portfolio will not have any projects assigned.<br/>Requires
        'Administrator' permission on the portfolio.
      externalDocs:
        description: Sonarqube Documentation for set_none_mode
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/views/set_none_mode
      operationId: v1_get_api_views_set_none_mode
      parameters:
      - allowEmptyValue: true
        description: Key of the portfolio or sub-portfolio to update
        explode: true
        in: query
        name: portfolio
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: set none mode
  /api/views/set_regexp_mode:
    description: Manage portfolios.
    post:
      description: Set the projects selection mode of a portfolio on regular expression.<br/>Requires
        'Administrator' permission on the portfolio.
      externalDocs:
        description: Sonarqube Documentation for set_regexp_mode
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/views/set_regexp_mode
      operationId: v1_get_api_views_set_regexp_mode
      parameters:
      - description: "Selects a branch in all matched projects, instead of using their\
          \ main branches"
        explode: true
        in: query
        name: branch
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Key of the portfolio or sub-portfolio to update
        explode: true
        in: query
        name: portfolio
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: A valid regexp with respect to the JDK's ``java.util.regex.Pattern``
          class
        explode: true
        in: query
        name: regexp
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: set regexp mode
  /api/views/set_remaining_projects_mode:
    description: Manage portfolios.
    post:
      description: Set the projects selection mode of a portfolio on unassociated
        projects in hierarchy.<br/>Requires 'Administrator' permission on the portfolio.
      externalDocs:
        description: Sonarqube Documentation for set_remaining_projects_mode
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/views/set_remaining_projects_mode
      operationId: v1_get_api_views_set_remaining_projects_mode
      parameters:
      - description: "Selects a branch in all matched projects, instead of using their\
          \ main branches"
        explode: true
        in: query
        name: branch
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Key of the portfolio or sub-portfolio to update
        explode: true
        in: query
        name: portfolio
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: set remaining projects mode
  /api/views/set_tags_mode:
    description: Manage portfolios.
    post:
      description: Set the projects selection mode of a portfolio on project tags.<br/>Requires
        'Administrator' permission on the portfolio.
      externalDocs:
        description: Sonarqube Documentation for set_tags_mode
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/views/set_tags_mode
      operationId: v1_get_api_views_set_tags_mode
      parameters:
      - description: "Selects a branch in all matched projects, instead of using their\
          \ main branches"
        explode: true
        in: query
        name: branch
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Key of the portfolio or sub-portfolio to update
        explode: true
        in: query
        name: portfolio
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Comma-separated list of tags. It's not possible to set nothing.
        explode: true
        in: query
        name: tags
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: set tags mode
  /api/views/show:
    description: Manage portfolios.
    get:
      description: "Show the details of a portfolio, including its hierarchy and project\
        \ selection mode. <br> Authentication is required for this API endpoint."
      externalDocs:
        description: Sonarqube Documentation for show
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/views/show
      operationId: v1_post_api_views_show
      parameters:
      - allowEmptyValue: true
        description: The key of the portfolio
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: show
  /api/views/update:
    description: Manage portfolios.
    post:
      description: Update a portfolio.<br/>Requires 'Administrator' permission on
        the portfolio.
      externalDocs:
        description: Sonarqube Documentation for update
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/views/update
      operationId: v1_get_api_views_update
      parameters:
      - description: New description for the portfolio
        explode: true
        in: query
        name: description
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Key of the portfolio to update
        explode: true
        in: query
        name: key
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: New name for the portfolio
        explode: true
        in: query
        name: name
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: update
  /api/webhooks/create:
    description: Webhooks allow to notify external services when a project analysis
      is done
    post:
      description: "Create a Webhook.<br>Requires 'Administer' permission on the specified\
        \ project, or global 'Administer' permission."
      externalDocs:
        description: Sonarqube Documentation for create
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/webhooks/create
      operationId: v1_get_api_webhooks_create
      parameters:
      - allowEmptyValue: true
        description: Name displayed in the administration console of webhooks
        explode: true
        in: query
        name: name
        required: true
        schema:
          type: string
        style: form
      - description: The key of the project that will own the webhook
        explode: true
        in: query
        name: project
        required: false
        schema:
          type: string
        style: form
      - description: "If provided, secret will be used as the key to generate the\
          \ HMAC hex (lowercase) digest value in the 'X-Sonar-Webhook-HMAC-SHA256'\
          \ header"
        explode: true
        in: query
        name: secret
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: "Server endpoint that will receive the webhook payload, for example\
          \ 'http://my_server/foo'. If HTTP Basic authentication is used, HTTPS is\
          \ recommended to avoid man in the middle attacks. Example: 'https://myLogin:myPassword@my_server/foo'"
        explode: true
        in: query
        name: url
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: create
  /api/webhooks/delete:
    description: Webhooks allow to notify external services when a project analysis
      is done
    post:
      description: "Delete a Webhook.<br>Requires 'Administer' permission on the specified\
        \ project, or global 'Administer' permission."
      externalDocs:
        description: Sonarqube Documentation for delete
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/webhooks/delete
      operationId: v1_get_api_webhooks_delete
      parameters:
      - allowEmptyValue: true
        description: "The key of the webhook to be deleted, auto-generated value can\
          \ be obtained through api/webhooks/create or api/webhooks/list"
        explode: true
        in: query
        name: webhook
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: delete
  /api/webhooks/deliveries:
    description: Webhooks allow to notify external services when a project analysis
      is done
    get:
      description: Get the recent deliveries for a specified project or Compute Engine
        task.<br/>Require 'Administer' permission on the related project.<br/>Note
        that additional information are returned by api/webhooks/delivery.
      externalDocs:
        description: Sonarqube Documentation for deliveries
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/webhooks/deliveries
      operationId: v1_post_api_webhooks_deliveries
      parameters:
      - description: Id of the Compute Engine task
        explode: true
        in: query
        name: ceTaskId
        required: false
        schema:
          type: string
        style: form
      - description: Key of the project
        explode: true
        in: query
        name: componentKey
        required: false
        schema:
          type: string
        style: form
      - description: 1-based page number
        explode: true
        in: query
        name: p
        required: false
        schema:
          type: string
        style: form
      - description: Page size. Must be greater than 0 and less than 500
        explode: true
        in: query
        name: ps
        required: false
        schema:
          type: string
        style: form
      - description: "Key of the webhook that triggered those deliveries, auto-generated\
          \ value that can be obtained through api/webhooks/create or api/webhooks/list"
        explode: true
        in: query
        name: webhook
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: deliveries
  /api/webhooks/delivery:
    description: Webhooks allow to notify external services when a project analysis
      is done
    get:
      description: Get a webhook delivery by its id.<br/>Require 'Administer System'
        permission.<br/>Note that additional information are returned by api/webhooks/delivery.
      externalDocs:
        description: Sonarqube Documentation for delivery
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/webhooks/delivery
      operationId: v1_post_api_webhooks_delivery
      parameters:
      - allowEmptyValue: true
        description: Id of delivery
        explode: true
        in: query
        name: deliveryId
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: delivery
  /api/webhooks/list:
    description: Webhooks allow to notify external services when a project analysis
      is done
    get:
      description: "Search for global webhooks or project webhooks. Webhooks are ordered\
        \ by name.<br>Requires 'Administer' permission on the specified project, or\
        \ global 'Administer' permission."
      externalDocs:
        description: Sonarqube Documentation for list
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/webhooks/list
      operationId: v1_post_api_webhooks_list
      parameters:
      - description: Project key
        explode: true
        in: query
        name: project
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: list
  /api/webhooks/update:
    description: Webhooks allow to notify external services when a project analysis
      is done
    post:
      description: "Update a Webhook.<br>Requires 'Administer' permission on the specified\
        \ project, or global 'Administer' permission."
      externalDocs:
        description: Sonarqube Documentation for update
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/webhooks/update
      operationId: v1_get_api_webhooks_update
      parameters:
      - allowEmptyValue: true
        description: new name of the webhook
        explode: true
        in: query
        name: name
        required: true
        schema:
          type: string
        style: form
      - description: "If provided, secret will be used as the key to generate the\
          \ HMAC hex (lowercase) digest value in the 'X-Sonar-Webhook-HMAC-SHA256'\
          \ header. If blank, any secret previously configured will be removed. If\
          \ not set, the secret will remain unchanged."
        explode: true
        in: query
        name: secret
        required: false
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: new url to be called by the webhook
        explode: true
        in: query
        name: url
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: "The key of the webhook to be updated, auto-generated value can\
          \ be obtained through api/webhooks/create or api/webhooks/list"
        explode: true
        in: query
        name: webhook
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: update
  /api/webservices/list:
    description: Get information on the web api supported on this instance.
    get:
      description: List web services
      externalDocs:
        description: Sonarqube Documentation for list
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/webservices/list
      operationId: v1_post_api_webservices_list
      parameters:
      - description: Include web services that are implemented for internal use only.
          Their forward-compatibility is not assured
        explode: true
        in: query
        name: include_internals
        required: false
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: list
  /api/webservices/response_example:
    description: Get information on the web api supported on this instance.
    get:
      description: Display web service response example
      externalDocs:
        description: Sonarqube Documentation for response_example
        url: https://next.sonarqube.com/sonarqube/web_api/api/api/webservices/response_example
      operationId: v1_post_api_webservices_response_example
      parameters:
      - allowEmptyValue: true
        description: Action of the web service
        explode: true
        in: query
        name: action
        required: true
        schema:
          type: string
        style: form
      - allowEmptyValue: true
        description: Controller of the web service
        explode: true
        in: query
        name: controller
        required: true
        schema:
          type: string
        style: form
      responses:
        "2XX":
          content:
            application/json:
              schema:
                type: object
          description: Successful query.
      summary: response example
components:
  schemas:
    UserCreateRestRequest:
      properties:
        email:
          description: User email
          maxLength: 100
          minLength: 1
          type: string
        local:
          default: true
          description: Specify if the user should be authenticated from SonarQube
            server or from an external authentication system. Password should not
            be set when local is set to false.
          type: boolean
        login:
          description: User login
          maxLength: 100
          minLength: 2
          type: string
        name:
          description: User name
          maxLength: 200
          type: string
        password:
          description: "User password. Only mandatory when creating local user, otherwise\
            \ it should not be set"
          type: string
          writeOnly: true
        scmAccounts:
          description: List of SCM accounts.
          items:
            description: List of SCM accounts.
            type: string
          type: array
      required:
      - login
      - name
      type: object
    UserRestResponseForAdmins:
      properties:
        id:
          readOnly: true
          type: string
        login:
          type: string
        name:
          type: string
        email:
          type: string
        active:
          readOnly: true
          type: boolean
        local:
          readOnly: true
          type: boolean
        managed:
          readOnly: true
          type: boolean
        externalLogin:
          type: string
        externalProvider:
          type: string
        avatar:
          type: string
        sonarQubeLastConnectionDate:
          readOnly: true
          type: string
        sonarLintLastConnectionDate:
          readOnly: true
          type: string
        scmAccounts:
          items:
            type: string
          type: array
      type: object
    EmailConfigurationCreateRestRequest:
      properties:
        host:
          description: URL of your SMTP server
          type: string
        port:
          description: "Port of your SMTP server (usually 25, 587 or 465)"
          type: string
        securityProtocol:
          description: Security protocol used to connect to your SMTP server (SSLTLS
            is recommended)
          enum:
          - NONE
          - SSLTLS
          - STARTTLS
          type: string
        fromAddress:
          description: Address emails will come from
          type: string
        fromName:
          description: Name emails will come from (usually "SonarQube")
          type: string
        subjectPrefix:
          description: "Prefix added to email so they can be easily recognized (usually\
            \ \"[SonarQube]\")"
          type: string
        authMethod:
          description: Authentication method used to connect to the SMTP server. OAuth
            is only supported for Microsoft Exchange
          enum:
          - BASIC
          - OAUTH
          type: string
        username:
          description: "For Basic and OAuth authentication: username used to authenticate\
            \ to the SMTP server"
          type: string
        basicPassword:
          description: "For basic authentication: password used to authenticate to\
            \ the SMTP server"
          type: string
          writeOnly: true
        oauthAuthenticationHost:
          description: "For OAuth authentication: host of the Identity Provider issuing\
            \ access tokens"
          type: string
        oauthClientId:
          description: "For OAuth authentication: Client ID provided by Microsoft\
            \ Exchange when registering the application"
          type: string
          writeOnly: true
        oauthClientSecret:
          description: "For OAuth authentication: Client secret provided by Microsoft\
            \ Exchange when registering the application"
          type: string
          writeOnly: true
        oauthTenant:
          description: "For OAuth authentication: Microsoft tenant"
          type: string
      required:
      - authMethod
      - fromAddress
      - fromName
      - host
      - port
      - securityProtocol
      - subjectPrefix
      - username
      type: object
    EmailConfigurationResource:
      properties:
        id:
          readOnly: true
          type: string
        host:
          description: URL of your SMTP server
          type: string
        port:
          description: "Port of your SMTP server (usually 25, 587 or 465)"
          type: string
        securityProtocol:
          description: Security protocol used to connect to your SMTP server (SSLTLS
            is recommended)
          enum:
          - NONE
          - SSLTLS
          - STARTTLS
          type: string
        fromAddress:
          description: Address emails will come from
          type: string
        fromName:
          description: Name emails will come from (usually "SonarQube")
          type: string
        subjectPrefix:
          description: "Prefix added to email so they can be easily recognized (usually\
            \ \"[SonarQube]\")"
          type: string
        authMethod:
          description: Authentication method used to connect to the SMTP server. OAuth
            is only supported for Microsoft Exchange
          enum:
          - BASIC
          - OAUTH
          type: string
        username:
          description: "For Basic and OAuth authentication: username used to authenticate\
            \ to the SMTP server"
          type: string
        isBasicPasswordSet:
          description: "For Basic authentication: has the password field been set?"
          type: boolean
        oauthAuthenticationHost:
          description: "For OAuth authentication: host of the Identity Provider issuing\
            \ access tokens"
          type: string
        isOauthClientIdSet:
          description: "For OAuth authentication: has the Client ID field been set?"
          type: boolean
        isOauthClientSecretSet:
          description: "For OAuth authentication: has the Client secret field been\
            \ set?"
          type: boolean
        oauthTenant:
          description: "For OAuth authentication: Microsoft tenant"
          type: string
      type: object
    ServiceStatusCheckResponse:
      properties:
        id:
          format: uuid
          type: string
        status:
          enum:
          - CONNECTION_ERROR
          - SERVICE_ERROR
          - SUCCESS
          - TIMEOUT
          - UNAUTHORIZED
          type: string
      type: object
    FixSuggestionPostRequest:
      properties:
        issueId:
          description: Issue key
          type: string
      required:
      - issueId
      type: object
    ChangeDto:
      properties:
        startLine:
          format: int32
          type: integer
        endLine:
          format: int32
          type: integer
        newCode:
          type: string
      type: object
    FixSuggestionResponse:
      properties:
        id:
          format: uuid
          type: string
        issueId:
          type: string
        explanation:
          type: string
        changes:
          items:
            $ref: '#/components/schemas/ChangeDto'
          type: array
      type: object
    GitlabSynchronizationRunResource:
      properties:
        id:
          readOnly: true
          type: string
      type: object
    PermissionMappingsPostRequest:
      properties:
        role:
          description: Custom role name
          type: string
        permissions:
          $ref: '#/components/schemas/RestPermissions'
      required:
      - permissions
      - role
      type: object
    RestPermissions:
      description: Set of SonarQube permissions to apply
      properties:
        user:
          description: Browse
          type: boolean
        codeViewer:
          description: See Source Code
          type: boolean
        issueAdmin:
          description: Administer Issues
          type: boolean
        securityHotspotAdmin:
          description: Administer Security Hotspots
          type: boolean
        admin:
          description: Administer
          type: boolean
        scan:
          description: Execute Analysis
          type: boolean
      required:
      - admin
      - codeViewer
      - issueAdmin
      - scan
      - securityHotspotAdmin
      - user
      type: object
    PermissionMappingsResource:
      properties:
        id:
          type: string
        role:
          type: string
        baseRole:
          type: boolean
        permissions:
          $ref: '#/components/schemas/RestPermissions'
      type: object
    GitlabConfigurationCreateRestRequest:
      properties:
        enabled:
          description: Enable Gitlab authentication
          type: boolean
        applicationId:
          description: Gitlab Application id
          type: string
        url:
          description: Url of Gitlab instance for authentication (for instance https://gitlab.com)
          type: string
        secret:
          description: Secret of the application
          type: string
          writeOnly: true
        synchronizeGroups:
          description: Set whether to synchronize groups
          type: boolean
        allowedGroups:
          description: |
            GitLab groups allowed to authenticate.
            Subgroups will automatically be included.
            When Auto-provisioning is enabled, members of these groups will be automatically provisioned in SonarQube.
            This field is required to be non-empty for Auto-provisioning.
          items:
            type: string
          type: array
        provisioningType:
          description: Type of synchronization
          enum:
          - JIT
          - AUTO_PROVISIONING
          type: string
        provisioningToken:
          description: Gitlab token for provisioning
          type: string
          writeOnly: true
        allowUsersToSignUp:
          description: Allow user to sign up
          type: boolean
      required:
      - allowedGroups
      - applicationId
      - enabled
      - provisioningType
      - secret
      - synchronizeGroups
      - url
      type: object
    GitlabConfigurationResource:
      properties:
        id:
          readOnly: true
          type: string
        enabled:
          type: boolean
        applicationId:
          description: Gitlab Application id
          type: string
        url:
          description: Url of Gitlab instance for authentication (for instance https://gitlab.com/api/v4)
          type: string
        synchronizeGroups:
          type: boolean
        allowedGroups:
          description: Root Gitlab groups allowed to authenticate and provisioned
          items:
            description: Root Gitlab groups allowed to authenticate and provisioned
            type: string
          type: array
        allowUsersToSignUp:
          type: boolean
        provisioningType:
          enum:
          - JIT
          - AUTO_PROVISIONING
          type: string
        isProvisioningTokenSet:
          description: Whether or not the provisioningToken is defined
          readOnly: true
          type: boolean
        errorMessage:
          description: "In case the GitLab configuration is incorrect, error message"
          readOnly: true
          type: string
      type: object
    GithubConfigurationCreateRestRequest:
      properties:
        enabled:
          description: Enable GitHub authentication
          type: boolean
        clientId:
          description: Client ID provided by GitHub when registering the application.
          type: string
          writeOnly: true
        clientSecret:
          description: Client password provided by GitHub when registering the application.
          type: string
          writeOnly: true
        applicationId:
          description: The App ID is found on your GitHub App's page on GitHub at
            Settings > Developer Settings > GitHub Apps.
          type: string
        privateKey:
          description: |
            Your GitHub App's private key. You can generate a .pem file from your GitHub App's page under Private keys.
            Copy and paste the whole contents of the file here.
          type: string
          writeOnly: true
        synchronizeGroups:
          description: |
            Synchronize GitHub team with SonarQube group memberships when users log in to SonarQube.
            For each GitHub team they belong to, users will be associated to a group of the same name if it exists in SonarQube.
          type: boolean
        apiUrl:
          description: "The API url for a GitHub instance. https://api.github.com/\
            \ for Github.com, https://github.company.com/api/v3/ when using Github\
            \ Enterprise"
          type: string
        webUrl:
          description: |
            The WEB url for a GitHub instance. https://github.com/ for Github.com, https://github.company.com/ when using GitHub Enterprise.
          type: string
        allowedOrganizations:
          description: |
            Only members of these organizations will be able to authenticate to the server.
            ⚠ if not set, users from any organization where the GitHub App is installed will be able to login to this SonarQube instance.
          items:
            type: string
          type: array
        provisioningType:
          description: Type of synchronization
          enum:
          - JIT
          - AUTO_PROVISIONING
          type: string
        allowUsersToSignUp:
          description: Allow user to sign up
          type: boolean
        projectVisibility:
          description: |
            Change project visibility based on GitHub repository visibility.
            If disabled, every provisioned project will be private in SonarQube and visible only to users with explicit GitHub permissions for the corresponding repository.
            Changes take effect at the next synchronization.
          type: boolean
        userConsentRequiredAfterUpgrade:
          description: Admin consent to synchronize permissions from GitHub
          type: boolean
      required:
      - allowedOrganizations
      - apiUrl
      - applicationId
      - clientId
      - clientSecret
      - enabled
      - privateKey
      - provisioningType
      - synchronizeGroups
      - webUrl
      type: object
    GithubConfigurationResource:
      properties:
        id:
          readOnly: true
          type: string
        enabled:
          type: boolean
        applicationId:
          description: GitHub Application id
          type: string
        synchronizeGroups:
          type: boolean
        apiUrl:
          description: Url of GitHub instance for API connectivity (for instance https://api.github.com)
          type: string
        webUrl:
          description: Url of GitHub instance for authentication (for instance https://github.com)
          type: string
        allowedOrganizations:
          description: GitHub organizations allowed to authenticate and provisioned
          items:
            description: GitHub organizations allowed to authenticate and provisioned
            type: string
          type: array
        provisioningType:
          enum:
          - JIT
          - AUTO_PROVISIONING
          type: string
        allowUsersToSignUp:
          type: boolean
        projectVisibility:
          type: boolean
        userConsentRequiredAfterUpgrade:
          type: boolean
        errorMessage:
          description: "In case the GitHub configuration is incorrect, error message"
          readOnly: true
          type: string
      type: object
    BoundProjectCreateRestRequest:
      properties:
        projectKey:
          description: Key of the project to create
          type: string
        projectName:
          description: Name of the project to create
          type: string
        devOpsPlatformSettingId:
          description: Identifier of DevOps platform configuration to use.
          type: string
        repositoryIdentifier:
          description: |
            Identifier of the DevOps platform repository to import:
            - repository slug for GitHub and Bitbucket (Cloud and Server)
            - repository id for GitLab
            - repository name for Azure DevOps
          type: string
        projectIdentifier:
          description: |
            Identifier of the DevOps platform project in which the repository is located.
            This is only needed for Azure and BitBucket Server platforms
          type: string
        newCodeDefinitionType:
          description: |2
              Project New Code Definition Type
              New code definitions of the following types are allowed:
                - PREVIOUS_VERSION
                - NUMBER_OF_DAYS
                - REFERENCE_BRANCH - will default to the main branch.
          type: string
        newCodeDefinitionValue:
          description: |2
              Project New Code Definition Value
              For each new code definition type, a different value is expected:
              - no value, when the new code definition type is PREVIOUS_VERSION and REFERENCE_BRANCH
              - a number between 1 and 90, when the new code definition type is NUMBER_OF_DAYS
          type: string
        monorepo:
          description: True if project is part of a mono repo.
          type: boolean
      required:
      - devOpsPlatformSettingId
      - monorepo
      - projectKey
      - projectName
      - repositoryIdentifier
      type: object
    BoundProjectCreateRestResponse:
      properties:
        projectId:
          description: The identifier of the created project
          type: string
        bindingId:
          description: The identifier of the binding between the created project and
            the DevOps platform project
          type: string
      type: object
    Impact:
      description: Impacts
      properties:
        softwareQuality:
          enum:
          - MAINTAINABILITY
          - RELIABILITY
          - SECURITY
          type: string
        severity:
          enum:
          - INFO
          - LOW
          - MEDIUM
          - HIGH
          - BLOCKER
          type: string
      type: object
    Parameter:
      description: Custom rule parameters
      properties:
        key:
          type: string
        htmlDescription:
          readOnly: true
          type: string
        defaultValue:
          type: string
        type:
          enum:
          - STRING
          - TEXT
          - BOOLEAN
          - INTEGER
          - FLOAT
          readOnly: true
          type: string
      type: object
    RuleCreateRestRequest:
      properties:
        key:
          description: "Key of the custom rule to create, must include the repository"
          maxLength: 200
          type: string
        templateKey:
          description: Key of the rule template to be used to create the custom rule
          maxLength: 200
          type: string
        name:
          description: Rule name
          maxLength: 200
          type: string
        markdownDescription:
          description: Rule description in markdown format
          type: string
        status:
          default: READY
          description: Rule status
          enum:
          - BETA
          - DEPRECATED
          - READY
          - REMOVED
          type: string
        parameters:
          description: Custom rule parameters
          items:
            $ref: '#/components/schemas/Parameter'
          type: array
        cleanCodeAttribute:
          description: Clean code attribute
          enum:
          - CONVENTIONAL
          - FORMATTED
          - IDENTIFIABLE
          - CLEAR
          - COMPLETE
          - EFFICIENT
          - LOGICAL
          - DISTINCT
          - FOCUSED
          - MODULAR
          - TESTED
          - LAWFUL
          - RESPECTFUL
          - TRUSTWORTHY
          type: string
        impacts:
          description: Impacts
          items:
            $ref: '#/components/schemas/Impact'
          type: array
      required:
      - cleanCodeAttribute
      - impacts
      - key
      - markdownDescription
      - name
      - templateKey
      type: object
    RuleDescriptionSectionContextRestResponse:
      properties:
        key:
          type: string
        displayName:
          type: string
      readOnly: true
      type: object
    RuleDescriptionSectionRestResponse:
      properties:
        key:
          readOnly: true
          type: string
        content:
          readOnly: true
          type: string
        context:
          $ref: '#/components/schemas/RuleDescriptionSectionContextRestResponse'
      type: object
    RuleRestResponse:
      properties:
        id:
          type: string
        key:
          type: string
        repositoryKey:
          type: string
        name:
          type: string
        severity:
          type: string
        type:
          enum:
          - CODE_SMELL
          - BUG
          - VULNERABILITY
          - SECURITY_HOTSPOT
          type: string
        impacts:
          items:
            $ref: '#/components/schemas/Impact'
          type: array
        cleanCodeAttribute:
          enum:
          - CONVENTIONAL
          - FORMATTED
          - IDENTIFIABLE
          - CLEAR
          - COMPLETE
          - EFFICIENT
          - LOGICAL
          - DISTINCT
          - FOCUSED
          - MODULAR
          - TESTED
          - LAWFUL
          - RESPECTFUL
          - TRUSTWORTHY
          type: string
        cleanCodeAttributeCategory:
          enum:
          - ADAPTABLE
          - CONSISTENT
          - INTENTIONAL
          - RESPONSIBLE
          type: string
        status:
          enum:
          - BETA
          - DEPRECATED
          - READY
          - REMOVED
          type: string
        external:
          type: boolean
        createdAt:
          type: string
        descriptionSections:
          items:
            $ref: '#/components/schemas/RuleDescriptionSectionRestResponse'
          type: array
        markdownDescription:
          type: string
        gapDescription:
          type: string
        htmlNote:
          type: string
        markdownNote:
          type: string
        educationPrinciples:
          items:
            type: string
          type: array
        template:
          type: boolean
        templateId:
          type: string
        tags:
          items:
            type: string
          type: array
        systemTags:
          items:
            type: string
          type: array
        languageKey:
          type: string
        languageName:
          type: string
        parameters:
          items:
            $ref: '#/components/schemas/Parameter'
          type: array
        remediationFunctionType:
          type: string
        remediationFunctionGapMultiplier:
          type: string
        remediationFunctionBaseEffort:
          type: string
      readOnly: true
      type: object
    GroupCreateRestRequest:
      properties:
        name:
          description: Name for the new group. Must be unique. The value 'anyone'
            is reserved and cannot be used.
          maxLength: 255
          minLength: 1
          type: string
        description:
          description: Description for the new group.
          maxLength: 200
          type: string
      required:
      - name
      type: object
    GroupRestResponse:
      properties:
        id:
          readOnly: true
          type: string
        name:
          type: string
        description:
          type: string
        managed:
          readOnly: true
          type: boolean
        default:
          readOnly: true
          type: boolean
      type: object
    GroupMembershipCreateRestRequest:
      properties:
        userId:
          description: ID of the user to add to group.
          type: string
        groupId:
          description: ID of the group where a member needs to be added.
          type: string
      type: object
    GroupMembershipRestResponse:
      properties:
        id:
          readOnly: true
          type: string
        groupId:
          readOnly: true
          type: string
        userId:
          readOnly: true
          type: string
      type: object
    UpdateFieldString:
      description: User login
      properties:
        value:
          type: string
        defined:
          type: boolean
      type: object
    UserUpdateRestRequest:
      properties:
        login:
          $ref: '#/components/schemas/UpdateFieldString'
        name:
          description: User first name and last name
          maxLength: 200
          type: string
        email:
          description: Email
          maxLength: 100
          minLength: 1
          type: string
        scmAccounts:
          description: List of SCM accounts.
          items:
            type: string
          type: array
        externalProvider:
          description: |
            New identity provider. Only providers configured in your platform are supported. This could be: github, gitlab, bitbucket, saml, LDAP, LDAP_{serverKey}
            (according to your server configuration file).
            Warning: when this is updated, the user will only be able to authenticate using the new identity provider. Also, it is not possible to remove the identity provider of a user.
          type: string
        externalLogin:
          description: "New external login, usually the login used in the authentication\
            \ system. If not provided previous identity will be used."
          maxLength: 255
          minLength: 1
          type: string
      type: object
    EmailConfigurationUpdateRestRequest:
      properties:
        host:
          description: URL of your SMTP server
          type: string
        port:
          description: "Port of your SMTP server (usually 25, 587 or 465)"
          type: string
        securityProtocol:
          description: Security protocol used to connect to your SMTP server (SSLTLS
            is recommended)
          enum:
          - NONE
          - SSLTLS
          - STARTTLS
          type: string
        fromAddress:
          description: Address emails will come from
          type: string
        fromName:
          description: Name emails will come from (usually "SonarQube")
          type: string
        subjectPrefix:
          description: "Prefix added to email so they can be easily recognized (usually\
            \ \"[SonarQube]\")"
          type: string
        authMethod:
          description: Authentication method used to connect to the SMTP server. OAuth
            is only supported for Microsoft Exchange
          enum:
          - BASIC
          - OAUTH
          type: string
        username:
          description: "For Basic and OAuth authentication: username used to authenticate\
            \ to the SMTP server"
          type: string
        basicPassword:
          description: "For basic authentication: password used to authenticate to\
            \ the SMTP server"
          type: string
        oauthAuthenticationHost:
          description: "For OAuth authentication: host of the Identity Provider issuing\
            \ access tokens"
          type: string
        oauthClientId:
          description: "For OAuth authentication: Client ID provided by Microsoft\
            \ Exchange when registering the application"
          type: string
        oauthClientSecret:
          description: "For OAuth authentication: Client password provided by Microsoft\
            \ Exchange when registering the application"
          type: string
        oauthTenant:
          description: "For OAuth authentication: Microsoft tenant"
          type: string
      type: object
    DevOpsPermissionMappingUpdateRequest:
      properties:
        permissions:
          $ref: '#/components/schemas/PermissionMappingUpdate'
      type: object
    PermissionMappingUpdate:
      description: Set of SonarQube permissions to apply
      properties:
        user:
          type: boolean
        codeViewer:
          type: boolean
        issueAdmin:
          type: boolean
        securityHotspotAdmin:
          type: boolean
        admin:
          type: boolean
        scan:
          type: boolean
      type: object
    GitlabConfigurationUpdateRestRequest:
      properties:
        enabled:
          description: Enable Gitlab authentication
          type: boolean
        applicationId:
          description: Gitlab Application id
          type: string
        url:
          description: Url of Gitlab instance for authentication (for instance https://gitlab.com/api/v4)
          type: string
        secret:
          description: Secret of the application
          nullable: true
          type: string
        synchronizeGroups:
          description: Set whether to synchronize groups
          type: boolean
        allowedGroups:
          description: Root Gitlab groups allowed to authenticate and provisioned
          items:
            type: string
          type: array
        provisioningType:
          description: Type of synchronization
          enum:
          - JIT
          - AUTO_PROVISIONING
          type: string
        allowUsersToSignUp:
          description: Allow user to sign up
          type: boolean
        provisioningToken:
          description: Gitlab token for provisioning
          maxLength: 2147483647
          minLength: 1
          nullable: true
          type: string
      type: object
    GithubConfigurationUpdateRestRequest:
      properties:
        enabled:
          description: Enable GitHub authentication
          type: boolean
        clientId:
          description: GitHub Client ID
          type: string
        clientSecret:
          description: GitHub Client secret
          type: string
        applicationId:
          description: GitHub Application id
          type: string
        privateKey:
          description: GitHub Private key
          type: string
        synchronizeGroups:
          description: Set whether to synchronize groups
          type: boolean
        apiUrl:
          description: Url of GitHub instance for API connectivity (for instance https://api.github.com)
          type: string
        webUrl:
          description: Url of GitHub instance for authentication (for instance https://github.com)
          type: string
        allowedOrganizations:
          description: GitHub organizations allowed to authenticate and provisioned
          items:
            type: string
          type: array
        provisioningType:
          description: Type of synchronization
          enum:
          - JIT
          - AUTO_PROVISIONING
          type: string
        allowUsersToSignUp:
          description: Allow user to sign up
          type: boolean
        projectVisibility:
          description: Sync project visibility
          type: boolean
        userConsentRequiredAfterUpgrade:
          description: Admin consent to synchronize permissions from GitHub
          type: boolean
      type: object
    GroupUpdateRestRequest:
      properties:
        name:
          description: Group name
          maxLength: 255
          minLength: 1
          type: string
        description:
          description: Description of the group
          maxLength: 200
          type: string
      type: object
    PageRestResponse:
      properties:
        pageIndex:
          format: int32
          type: integer
        pageSize:
          format: int32
          type: integer
        total:
          format: int32
          type: integer
      type: object
    UsersSearchRestResponse:
      properties:
        users:
          items:
            $ref: '#/components/schemas/UserRestResponseForAdmins'
          type: array
        page:
          $ref: '#/components/schemas/PageRestResponse'
      type: object
    DatabaseMigrationsResponse:
      properties:
        status:
          type: string
        completedSteps:
          format: int32
          type: integer
        totalSteps:
          format: int32
          type: integer
        startedAt:
          type: string
        message:
          type: string
        expectedFinishTimestamp:
          type: string
      type: object
    Health:
      properties:
        status:
          enum:
          - GREEN
          - YELLOW
          - RED
          type: string
        causes:
          items:
            type: string
          type: array
          uniqueItems: true
      type: object
    EmailConfigurationSearchRestResponse:
      properties:
        emailConfigurations:
          items:
            $ref: '#/components/schemas/EmailConfigurationResource'
          type: array
        page:
          $ref: '#/components/schemas/PageRestResponse'
      type: object
    FixSuggestionIssueResponse:
      properties:
        issueId:
          type: string
        aiSuggestion:
          enum:
          - AVAILABLE
          - NOT_AVAILABLE_FILE_LEVEL_ISSUE
          - NOT_AVAILABLE_UNSUPPORTED_RULE
          - NOT_AVAILABLE_FILE_SIZE
          type: string
      type: object
    ProjectBinding:
      properties:
        id:
          type: string
        devOpsPlatformSettingId:
          type: string
        projectId:
          type: string
        projectKey:
          type: string
        repository:
          type: string
        slug:
          type: string
      required:
      - devOpsPlatformSettingId
      - id
      - projectId
      - projectKey
      type: object
    ProjectBindingsSearchRestResponse:
      properties:
        projectBindings:
          items:
            $ref: '#/components/schemas/ProjectBinding'
          type: array
        page:
          $ref: '#/components/schemas/PageRestResponse'
      type: object
    PermissionMappingsSearchRestResponse:
      properties:
        permissionMappings:
          items:
            $ref: '#/components/schemas/PermissionMappingsResource'
          type: array
      type: object
    GitlabConfigurationSearchRestResponse:
      properties:
        gitlabConfigurations:
          items:
            $ref: '#/components/schemas/GitlabConfigurationResource'
          type: array
        page:
          $ref: '#/components/schemas/PageRestResponse'
      type: object
    GithubConfigurationSearchRestResponse:
      properties:
        githubConfigurations:
          items:
            $ref: '#/components/schemas/GithubConfigurationResource'
          type: array
        page:
          $ref: '#/components/schemas/PageRestResponse'
      type: object
    DopSettingsResource:
      properties:
        id:
          readOnly: true
          type: string
        type:
          description: "Supported DevOps Platform are: github, gitlab, azure, bitbucketcloud,\
            \ bitbucket_server"
          type: string
        key:
          type: string
        url:
          type: string
        appId:
          type: string
      type: object
    DopSettingsRestResponse:
      properties:
        dopSettings:
          items:
            $ref: '#/components/schemas/DopSettingsResource'
          type: array
        page:
          $ref: '#/components/schemas/PageRestResponse'
      type: object
    GroupsSearchRestResponse:
      properties:
        groups:
          items:
            $ref: '#/components/schemas/GroupRestResponse'
          type: array
        page:
          $ref: '#/components/schemas/PageRestResponse'
      type: object
    GroupsMembershipSearchRestResponse:
      properties:
        groupMemberships:
          items:
            $ref: '#/components/schemas/GroupMembershipRestResponse'
          type: array
        page:
          $ref: '#/components/schemas/PageRestResponse'
      type: object
    JreInfoRestResponse:
      properties:
        id:
          type: string
        filename:
          type: string
        sha256:
          type: string
        javaPath:
          type: string
        os:
          type: string
        arch:
          type: string
      type: object
    EngineInfoRestResponse:
      properties:
        filename:
          type: string
        sha256:
          type: string
      type: object
    CveResource:
      properties:
        id:
          type: string
        description:
          type: string
        cvssScore:
          format: double
          type: number
        epssScore:
          format: double
          type: number
        epssPercentile:
          format: double
          type: number
        publishedAt:
          format: int64
          type: integer
        lastModifiedAt:
          format: int64
          type: integer
        cwes:
          items:
            type: string
          type: array
          uniqueItems: true
      type: object