sonarqube-api.json

{
 "openapi": "3.1.0",
 "info": {
  "title": "SonarQube Web API v2",
  "description": "The SonarQube API v2 is a REST API which enables you to interact with SonarQube programmatically. Endpoint listed here should work as expected.\nHowever, 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.\n",
  "version": "2025.2.0.102829"
 },
 "servers": [
  {
   "url": "http://next.sonarqube.com/sonarqube",
   "description": "Generated server url"
  }
 ],
 "paths": {
  "/v2/users-management/users": {
   "get": {
    "tags": [
     "default-user-controller"
    ],
    "summary": "Users search",
    "description": "  Get a list of users. By default, only active users are returned.\n  The following fields are only returned when user has Administer System permission or for logged-in in user :\n    'email',\n    'externalIdentity',\n    'externalProvider',\n    'groups',\n    'lastConnectionDate',\n    'sonarLintLastConnectionDate',\n    'tokensCount'.\n  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.\n  The results are sorted alphabetically by login.\n",
    "operationId": "search",
    "parameters": [
     {
      "name": "active",
      "in": "query",
      "description": "Return active/inactive users",
      "required": false,
      "schema": {
       "type": "boolean",
       "description": "Return active/inactive users",
       "default": true
      }
     },
     {
      "name": "managed",
      "in": "query",
      "description": "Return managed or non-managed users. Only available for managed instances, throws for non-managed instances",
      "required": false,
      "schema": {
       "type": "boolean",
       "description": "Return managed or non-managed users. Only available for managed instances, throws for non-managed instances"
      }
     },
     {
      "name": "q",
      "in": "query",
      "description": "Filter on login, name and email.\nThis parameter performs a partial match (contains), it is case insensitive.",
      "required": false,
      "schema": {
       "type": "string",
       "description": "Filter on login, name and email.\nThis parameter performs a partial match (contains), it is case insensitive."
      }
     },
     {
      "name": "externalIdentity",
      "in": "query",
      "description": "Filter on externalIdentity.\nThis parameter perform a case-sensitive exact match",
      "required": false,
      "schema": {
       "type": "string",
       "description": "Filter on externalIdentity.\nThis parameter perform a case-sensitive exact match"
      }
     },
     {
      "name": "sonarQubeLastConnectionDateFrom",
      "in": "query",
      "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)",
      "required": false,
      "schema": {
       "type": "string",
       "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"
      },
      "example": "2020-01-01T00:00:00+0100"
     },
     {
      "name": "sonarQubeLastConnectionDateTo",
      "in": "query",
      "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)",
      "required": false,
      "schema": {
       "type": "string",
       "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"
      },
      "example": "2020-01-01T00:00:00+0100"
     },
     {
      "name": "sonarLintLastConnectionDateFrom",
      "in": "query",
      "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)",
      "required": false,
      "schema": {
       "type": "string",
       "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"
      },
      "example": "2020-01-01T00:00:00+0100"
     },
     {
      "name": "sonarLintLastConnectionDateTo",
      "in": "query",
      "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)",
      "required": false,
      "schema": {
       "type": "string",
       "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"
      },
      "example": "2020-01-01T00:00:00+0100"
     },
     {
      "name": "groupId",
      "in": "query",
      "description": "Filter users belonging to group. Only available for system administrators. Using != operator will exclude users from this group.",
      "required": false,
      "schema": {
       "type": "string",
       "description": "Filter users belonging to group. Only available for system administrators. Using != operator will exclude users from this group."
      }
     },
     {
      "name": "pageSize",
      "in": "query",
      "description": "Number of results per page. A value of 0 will only return the pagination information.",
      "required": false,
      "schema": {
       "type": "integer",
       "maximum": 500,
       "minimum": 0,
       "format": "int32",
       "description": "Number of results per page. A value of 0 will only return the pagination information.",
       "default": 50
      }
     },
     {
      "name": "pageIndex",
      "in": "query",
      "description": "1-based page index",
      "required": false,
      "schema": {
       "type": "integer",
       "minimum": 1,
       "format": "int32",
       "description": "1-based page index",
       "default": 1
      }
     }
    ],
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/UsersSearchRestResponse"
        }
       }
      }
     }
    }
   },
   "post": {
    "tags": [
     "default-user-controller"
    ],
    "summary": "User creation",
    "description": "  Create a user.\n  If a deactivated user account exists with the given login, it will be reactivated.\n  Requires Administer System permission.\n",
    "operationId": "create",
    "requestBody": {
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/UserCreateRestRequest"
       }
      }
     },
     "required": true
    },
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/UserRestResponseForAdmins"
        }
       }
      }
     }
    }
   }
  },
  "/v2/dop-translation/gitlab-synchronization-runs": {
   "post": {
    "tags": [
     "gitlab-synchronization-run-controller"
    ],
    "summary": "Starts a GitLab synchronization run.",
    "description": "  Adds a new GitLab synchronization run in the background tasks. Requires sys-admins permissions.\n",
    "operationId": "create_2",
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/GitlabSynchronizationRunResource"
        }
       }
      }
     }
    }
   }
  },
  "/v2/users-management/users/{id}": {
   "get": {
    "tags": [
     "default-user-controller"
    ],
    "summary": "Fetch a single user",
    "description": "Fetch a single user.\nThe following fields are only returned when user has Administer System permission or for logged-in in user :\n    'email'\n    'externalIdentity'\n    'externalProvider'\n    'groups'\n    'lastConnectionDate'\n    'sonarLintLastConnectionDate'\n    'tokensCount'\n  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.\n",
    "operationId": "fetchUser",
    "parameters": [
     {
      "name": "id",
      "in": "path",
      "description": "The id of the user to fetch.",
      "required": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/UserRestResponseForAdmins"
        }
       }
      }
     }
    }
   },
   "delete": {
    "tags": [
     "default-user-controller"
    ],
    "summary": "Deactivate a user",
    "description": "Deactivates a user. Requires Administer System permission.",
    "operationId": "deactivate",
    "parameters": [
     {
      "name": "id",
      "in": "path",
      "description": "The ID of the user to delete.",
      "required": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "anonymize",
      "in": "query",
      "description": "Anonymize user in addition to deactivating it.",
      "required": false,
      "schema": {
       "type": "boolean",
       "default": false
      }
     }
    ],
    "responses": {
     "204": {
      "description": "No Content"
     }
    }
   },
   "patch": {
    "tags": [
     "default-user-controller"
    ],
    "summary": "Update a user",
    "description": "Update users attributes.\n",
    "operationId": "updateUser",
    "parameters": [
     {
      "name": "id",
      "in": "path",
      "required": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "requestBody": {
     "content": {
      "application/merge-patch+json": {
       "schema": {
        "$ref": "#/components/schemas/UserUpdateRestRequest"
       }
      }
     },
     "required": true
    },
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/UserRestResponseForAdmins"
        }
       }
      }
     }
    }
   }
  },
  "/v2/authorizations/groups/{id}": {
   "get": {
    "tags": [
     "default-group-controller"
    ],
    "summary": "Fetch a single group",
    "description": "Fetch a single group.",
    "operationId": "fetchGroup",
    "parameters": [
     {
      "name": "id",
      "in": "path",
      "description": "The id of the group to fetch.",
      "required": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/GroupRestResponse"
        }
       }
      }
     }
    }
   },
   "delete": {
    "tags": [
     "default-group-controller"
    ],
    "summary": "Deletes a group",
    "description": "Deletes a group.",
    "operationId": "deleteGroup",
    "parameters": [
     {
      "name": "id",
      "in": "path",
      "description": "The ID of the group to delete.",
      "required": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "204": {
      "description": "No Content"
     }
    }
   },
   "patch": {
    "tags": [
     "default-group-controller"
    ],
    "summary": "Update a group",
    "description": "Update a group name or description.\n",
    "operationId": "updateGroup",
    "parameters": [
     {
      "name": "id",
      "in": "path",
      "required": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "requestBody": {
     "content": {
      "application/merge-patch+json": {
       "schema": {
        "$ref": "#/components/schemas/GroupUpdateRestRequest"
       }
      }
     },
     "required": true
    },
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/GroupRestResponse"
        }
       }
      }
     }
    }
   }
  },
  "/v2/system/liveness": {
   "get": {
    "tags": [
     "default-liveness-controller"
    ],
    "summary": "Provide liveness of SonarQube, meant to be used as a liveness probe on Kubernetes",
    "description": "  Require 'Administer System' permission or authentication with passcode.\n\n  When SonarQube is fully started, liveness check for database connectivity, Compute Engine status, and, except for DataCenter Edition, if ElasticSearch is Green or Yellow.\n\n  When SonarQube is on Safe Mode (for example when a database migration is running), liveness check only for database connectivity\n",
    "operationId": "livenessCheck",
    "parameters": [
     {
      "name": "X-Sonar-Passcode",
      "in": "header",
      "description": "Passcode can be provided, see SonarQube documentation",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "default": {
      "description": "This SonarQube node is not alive and should be rescheduled"
     },
     "204": {
      "description": "This SonarQube node is alive"
     }
    }
   }
  },
  "/v2/system/email-configurations/{id}": {
   "get": {
    "tags": [
     "email-configuration-controller"
    ],
    "summary": "Fetch an email configuration",
    "description": "Fetch a Email configuration. Requires 'Administer System' permission.\n",
    "operationId": "getEmailConfiguration",
    "parameters": [
     {
      "name": "id",
      "in": "path",
      "description": "The id of the configuration to fetch.",
      "required": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/EmailConfigurationResource"
        }
       }
      }
     }
    }
   },
   "delete": {
    "tags": [
     "email-configuration-controller"
    ],
    "summary": "Delete an email configuration",
    "description": "Delete an email configuration.\nRequires 'Administer System' permission.\n",
    "operationId": "deleteEmailConfiguration",
    "parameters": [
     {
      "name": "id",
      "in": "path",
      "description": "The id of the configuration to delete.",
      "required": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "204": {
      "description": "No Content"
     }
    }
   },
   "patch": {
    "tags": [
     "email-configuration-controller"
    ],
    "summary": "Update an email configuration",
    "description": "Update an email configuration. Requires 'Administer System' permission.\n",
    "operationId": "updateEmailConfiguration",
    "parameters": [
     {
      "name": "id",
      "in": "path",
      "required": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "requestBody": {
     "content": {
      "application/merge-patch+json": {
       "schema": {
        "$ref": "#/components/schemas/EmailConfigurationUpdateRestRequest"
       }
      }
     },
     "required": true
    },
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/EmailConfigurationResource"
        }
       }
      }
     }
    }
   }
  },
  "/v2/analysis/version": {
   "get": {
    "tags": [
     "version-controller"
    ],
    "summary": "Server version",
    "description": "Get the version of the Scanner Engine",
    "operationId": "getVersion",
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "text/plain": {
        "schema": {
         "type": "string"
        }
       }
      }
     }
    }
   }
  },
  "/v2/dop-translation/github-permission-mappings/{role}": {
   "delete": {
    "tags": [
     "github-permission-mappings-controller"
    ],
    "summary": "Delete a single permission mappings",
    "description": "Requires 'Administer System' permission.",
    "operationId": "deleteMapping_1",
    "parameters": [
     {
      "name": "role",
      "in": "path",
      "description": "The name of the role to delete",
      "required": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "204": {
      "description": "No Content"
     }
    }
   },
   "patch": {
    "tags": [
     "github-permission-mappings-controller"
    ],
    "summary": "Update a single permission mapping",
    "description": "Requires 'Administer System' permission.",
    "operationId": "updateMapping_1",
    "parameters": [
     {
      "name": "role",
      "in": "path",
      "description": "The name of the role to update",
      "required": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "requestBody": {
     "content": {
      "application/merge-patch+json": {
       "schema": {
        "$ref": "#/components/schemas/DevOpsPermissionMappingUpdateRequest"
       }
      }
     },
     "required": true
    },
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/PermissionMappingsResource"
        }
       }
      }
     }
    }
   }
  },
  "/v2/fix-suggestions/feature-enablements": {
   "patch": {
    "tags": [
     "feature-enablement-controller"
    ],
    "summary": "Enable/Disable the AI CodeFix feature at the instance or project level",
    "operationId": "updateFeatureEnablement",
    "requestBody": {
     "content": {
      "application/merge-patch+json": {
       "schema": {
        "$ref": "#/components/schemas/FeatureEnablementRequest"
       }
      }
     },
     "required": true
    },
    "responses": {
     "204": {
      "description": "No Content"
     }
    }
   }
  },
  "/v2/analysis/jres": {
   "get": {
    "tags": [
     "jres-controller"
    ],
    "summary": "All JREs metadata",
    "description": "Get metadata of all available JREs",
    "operationId": "getJresMetadata",
    "parameters": [
     {
      "name": "os",
      "in": "query",
      "description": "Filter the JRE by operating system. Accepted values are 'windows', 'linux', 'macos', 'alpine' (case-insensitive), with some aliases",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "arch",
      "in": "query",
      "description": "Filter the JRE by CPU architecture. Accepted values are 'x64' and 'aarch64' (case-insensitive), with some aliases.",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "type": "array",
         "items": {
          "$ref": "#/components/schemas/JreInfoRestResponse"
         }
        }
       }
      }
     }
    }
   }
  },
  "/v2/dop-translation/gitlab-configurations": {
   "get": {
    "tags": [
     "gitlab-configuration-controller"
    ],
    "summary": "Search GitLab configs",
    "description": "  Get the list of GitLab configurations.\n  Note that a single configuration is supported at this time.\n  Requires 'Administer System' permission.\n",
    "operationId": "searchGitlabConfiguration",
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/GitlabConfigurationSearchRestResponse"
        }
       }
      }
     }
    }
   },
   "post": {
    "tags": [
     "gitlab-configuration-controller"
    ],
    "summary": "Create Gitlab configuration",
    "description": "  Create a new Gitlab configuration.\n  Note that only a single configuration can exist at a time.\n  Requires 'Administer System' permission.\n",
    "operationId": "create_3",
    "requestBody": {
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/GitlabConfigurationCreateRestRequest"
       }
      }
     },
     "required": true
    },
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/GitlabConfigurationResource"
        }
       }
      }
     }
    }
   }
  },
  "/v2/system/migrations-status": {
   "get": {
    "tags": [
     "database-migrations-controller"
    ],
    "summary": "Gets the status of ongoing database migrations, if any",
    "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": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/DatabaseMigrationsResponse"
        }
       }
      }
     }
    }
   }
  },
  "/v2/dop-translation/gitlab-configurations/{id}": {
   "get": {
    "tags": [
     "gitlab-configuration-controller"
    ],
    "summary": "Fetch a GitLab configuration",
    "description": "Fetch a GitLab configuration. Requires 'Administer System' permission.\n",
    "operationId": "getGitlabConfiguration",
    "parameters": [
     {
      "name": "id",
      "in": "path",
      "description": "The id of the configuration to fetch.",
      "required": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/GitlabConfigurationResource"
        }
       }
      }
     }
    }
   },
   "delete": {
    "tags": [
     "gitlab-configuration-controller"
    ],
    "summary": "Delete a GitLab configuration",
    "description": "Delete a GitLab configuration.\nRequires 'Administer System' permission.\n",
    "operationId": "deleteGitlabConfiguration",
    "parameters": [
     {
      "name": "id",
      "in": "path",
      "description": "The id of the configuration to delete.",
      "required": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "204": {
      "description": "No Content"
     }
    }
   },
   "patch": {
    "tags": [
     "gitlab-configuration-controller"
    ],
    "summary": "Update a Gitlab configuration",
    "description": "Update a Gitlab configuration. Requires 'Administer System' permission.\n",
    "operationId": "updateGitlabConfiguration",
    "parameters": [
     {
      "name": "id",
      "in": "path",
      "required": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "requestBody": {
     "content": {
      "application/merge-patch+json": {
       "schema": {
        "$ref": "#/components/schemas/GitlabConfigurationUpdateRestRequest"
       }
      }
     },
     "required": true
    },
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/GitlabConfigurationResource"
        }
       }
      }
     }
    }
   }
  },
  "/v2/dop-translation/github-permission-mappings": {
   "get": {
    "tags": [
     "github-permission-mappings-controller"
    ],
    "summary": "Fetch permissions mapping",
    "description": "Get the list of all the existing roles with their permission mappings. Requires 'Administer System' permission.",
    "operationId": "fetchAll_1",
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/PermissionMappingsSearchRestResponse"
        }
       }
      }
     }
    }
   },
   "post": {
    "tags": [
     "github-permission-mappings-controller"
    ],
    "summary": "Create a permission mapping for a custom role",
    "description": "Requires 'Administer System' permission.",
    "operationId": "createMapping_1",
    "requestBody": {
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/PermissionMappingsPostRequest"
       }
      }
     },
     "required": true
    },
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/PermissionMappingsResource"
        }
       }
      }
     }
    }
   }
  },
  "/v2/dop-translation/github-configurations/{id}": {
   "get": {
    "tags": [
     "github-configuration-controller"
    ],
    "summary": "Fetch a GitHub configuration",
    "description": "Fetch a GitHub configuration. Requires 'Administer System' permission.\n",
    "operationId": "getGithubConfiguration",
    "parameters": [
     {
      "name": "id",
      "in": "path",
      "description": "The id of the configuration to fetch.",
      "required": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/GithubConfigurationResource"
        }
       }
      }
     }
    }
   },
   "delete": {
    "tags": [
     "github-configuration-controller"
    ],
    "summary": "Delete a GitHub configuration",
    "description": "Delete a GitHub configuration.\nRequires 'Administer System' permission.\n",
    "operationId": "deleteGithubConfiguration",
    "parameters": [
     {
      "name": "id",
      "in": "path",
      "description": "The id of the configuration to delete.",
      "required": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "204": {
      "description": "No Content"
     }
    }
   },
   "patch": {
    "tags": [
     "github-configuration-controller"
    ],
    "summary": "Update a GitHub configuration",
    "description": "Update a GitHub configuration. Requires 'Administer System' permission.\n",
    "operationId": "updateGithubConfiguration",
    "parameters": [
     {
      "name": "id",
      "in": "path",
      "required": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "requestBody": {
     "content": {
      "application/merge-patch+json": {
       "schema": {
        "$ref": "#/components/schemas/GithubConfigurationUpdateRestRequest"
       }
      }
     },
     "required": true
    },
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/GithubConfigurationResource"
        }
       }
      }
     }
    }
   }
  },
  "/v2/dop-translation/project-bindings": {
   "get": {
    "tags": [
     "project-bindings-controller"
    ],
    "summary": "Search across project bindings",
    "operationId": "getProjectBindingByProjectId",
    "parameters": [
     {
      "name": "repository",
      "in": "query",
      "description": "Filter on the repository name.\nThis parameter performs an exact, case insensitive, match.\n",
      "required": false,
      "schema": {
       "type": "string",
       "description": "Filter on the repository name.\nThis parameter performs an exact, case insensitive, match.\n"
      }
     },
     {
      "name": "dopSettingId",
      "in": "query",
      "description": "Filter on the DevOps Platform setting id.",
      "required": false,
      "schema": {
       "type": "string",
       "description": "Filter on the DevOps Platform setting id."
      }
     },
     {
      "name": "pageSize",
      "in": "query",
      "description": "Number of results per page. A value of 0 will only return the pagination information.",
      "required": false,
      "schema": {
       "type": "integer",
       "maximum": 500,
       "minimum": 0,
       "format": "int32",
       "description": "Number of results per page. A value of 0 will only return the pagination information.",
       "default": 50
      }
     },
     {
      "name": "pageIndex",
      "in": "query",
      "description": "1-based page index",
      "required": false,
      "schema": {
       "type": "integer",
       "minimum": 1,
       "format": "int32",
       "description": "1-based page index",
       "default": 1
      }
     }
    ],
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ProjectBindingsSearchRestResponse"
        }
       }
      }
     }
    }
   }
  },
  "/v2/fix-suggestions/ai-suggestions": {
   "post": {
    "tags": [
     "fix-suggestion-controller"
    ],
    "summary": "Suggest a fix for the given issueId",
    "description": "Requires Code Viewer permission.",
    "operationId": "create_1",
    "requestBody": {
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/FixSuggestionPostRequest"
       }
      }
     },
     "required": true
    },
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/FixSuggestionResponse"
        }
       }
      }
     }
    }
   }
  },
  "/v2/fix-suggestions/service-info/subscription-type": {
   "get": {
    "tags": [
     "service-info-controller"
    ],
    "summary": "Request subscription information of AI CodeFix service",
    "operationId": "getSubscriptionType",
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/SubscriptionTypeResponse"
        }
       }
      }
     }
    }
   }
  },
  "/v2/authorizations/groups": {
   "get": {
    "tags": [
     "default-group-controller"
    ],
    "summary": "Group search",
    "description": "  Get the list of groups.\n  The results are sorted alphabetically by group name.\n",
    "operationId": "search_1",
    "parameters": [
     {
      "name": "managed",
      "in": "query",
      "description": "Return managed or non-managed groups. Only available for managed instances, throws for non-managed instances",
      "required": false,
      "schema": {
       "type": "boolean",
       "description": "Return managed or non-managed groups. Only available for managed instances, throws for non-managed instances"
      }
     },
     {
      "name": "q",
      "in": "query",
      "description": "Filter on name.\nThis parameter performs a partial match (contains), it is case insensitive.",
      "required": false,
      "schema": {
       "type": "string",
       "description": "Filter on name.\nThis parameter performs a partial match (contains), it is case insensitive."
      }
     },
     {
      "name": "pageSize",
      "in": "query",
      "description": "Number of results per page. A value of 0 will only return the pagination information.",
      "required": false,
      "schema": {
       "type": "integer",
       "maximum": 500,
       "minimum": 0,
       "format": "int32",
       "description": "Number of results per page. A value of 0 will only return the pagination information.",
       "default": 50
      }
     },
     {
      "name": "pageIndex",
      "in": "query",
      "description": "1-based page index",
      "required": false,
      "schema": {
       "type": "integer",
       "minimum": 1,
       "format": "int32",
       "description": "1-based page index",
       "default": 1
      }
     }
    ],
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/GroupsSearchRestResponse"
        }
       }
      }
     }
    }
   },
   "post": {
    "tags": [
     "default-group-controller"
    ],
    "summary": "Create a new group",
    "description": "Create a new group.",
    "operationId": "create_5",
    "requestBody": {
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/GroupCreateRestRequest"
       }
      }
     },
     "required": true
    },
    "responses": {
     "201": {
      "description": "Created",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/GroupRestResponse"
        }
       }
      }
     }
    }
   }
  },
  "/v2/system/health": {
   "get": {
    "tags": [
     "health-controller"
    ],
    "operationId": "getHealth",
    "parameters": [
     {
      "name": "X-Sonar-Passcode",
      "in": "header",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/Health"
        }
       }
      }
     }
    }
   }
  },
  "/v2/dop-translation/gitlab-permission-mappings/{role}": {
   "delete": {
    "tags": [
     "gitlab-permission-mappings-controller"
    ],
    "summary": "Delete a single permission mappings",
    "description": "Requires 'Administer System' permission.",
    "operationId": "deleteMapping",
    "parameters": [
     {
      "name": "role",
      "in": "path",
      "description": "The name of the role to delete",
      "required": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "204": {
      "description": "No Content"
     }
    }
   },
   "patch": {
    "tags": [
     "gitlab-permission-mappings-controller"
    ],
    "summary": "Update a single permission mapping",
    "description": "Requires 'Administer System' permission.",
    "operationId": "updateMapping",
    "parameters": [
     {
      "name": "role",
      "in": "path",
      "description": "The name of the role to update",
      "required": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "requestBody": {
     "content": {
      "application/merge-patch+json": {
       "schema": {
        "$ref": "#/components/schemas/DevOpsPermissionMappingUpdateRequest"
       }
      }
     },
     "required": true
    },
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/PermissionMappingsResource"
        }
       }
      }
     }
    }
   }
  },
  "/v2/analysis/dependencies": {
   "get": {
    "tags": [
     "p"
    ],
    "summary": "Project dependencies search",
    "description": "Search for dependencies of a project.\nThe results are sorted by findings and by name.\n",
    "operationId": "search_3",
    "parameters": [
     {
      "name": "projectKey",
      "in": "query",
      "description": "Key of the project to fetch all dependencies from",
      "required": true,
      "schema": {
       "type": "string",
       "description": "Key of the project to fetch all dependencies from"
      }
     },
     {
      "name": "branchKey",
      "in": "query",
      "description": "Key of the Branch to fetch all dependencies from. If not provided, the default branch will be used unless a Pull Request Key is provided.",
      "required": false,
      "schema": {
       "type": "string",
       "description": "Key of the Branch to fetch all dependencies from. If not provided, the default branch will be used unless a Pull Request Key is provided."
      }
     },
     {
      "name": "pullRequestKey",
      "in": "query",
      "description": "Key of the Pull Request to fetch all dependencies from.",
      "required": false,
      "schema": {
       "type": "string",
       "description": "Key of the Pull Request to fetch all dependencies from."
      }
     },
     {
      "name": "q",
      "in": "query",
      "description": "Filter on the dependency key and long name. This parameter performs an exact match on the key, and a partial match (contains and case insensitive) on the long name.",
      "required": false,
      "schema": {
       "type": "string",
       "description": "Filter on the dependency key and long name. This parameter performs an exact match on the key, and a partial match (contains and case insensitive) on the long name."
      }
     },
     {
      "name": "pageSize",
      "in": "query",
      "description": "Number of results per page. A value of 0 will only return the pagination information.",
      "required": false,
      "schema": {
       "type": "integer",
       "maximum": 500,
       "minimum": 0,
       "format": "int32",
       "description": "Number of results per page. A value of 0 will only return the pagination information.",
       "default": 50
      }
     },
     {
      "name": "pageIndex",
      "in": "query",
      "description": "1-based page index",
      "required": false,
      "schema": {
       "type": "integer",
       "minimum": 1,
       "format": "int32",
       "description": "1-based page index",
       "default": 1
      }
     }
    ],
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/DependenciesSearchRestResponse"
        }
       }
      }
     }
    }
   }
  },
  "/v2/dop-translation/dop-settings": {
   "get": {
    "tags": [
     "dop-settings-controller"
    ],
    "summary": "List all DevOps Platform Integration settings",
    "description": "Requires the 'Create Projects' permission ",
    "operationId": "fetchAllDopSettings",
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/DopSettingsRestResponse"
        }
       }
      }
     }
    }
   }
  },
  "/v2/clean-code-policy/mode": {
   "get": {
    "tags": [
     "mode-controller"
    ],
    "summary": "Retrieve current instance Mode",
    "description": "Fetch the current instance mode. Can be Multi-Quality Rules (MQR) Mode or Standard Experience.\n",
    "operationId": "getMode",
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ModeResource"
        }
       }
      }
     }
    }
   },
   "patch": {
    "tags": [
     "mode-controller"
    ],
    "summary": "Update current instance Mode",
    "description": "Update the current instance mode. Can be Multi-Quality Rules (MQR) Mode or Standard Experience.\nRequires 'Administer System' permission.\n",
    "operationId": "patchMode",
    "requestBody": {
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/ModeResource"
       }
      }
     },
     "required": true
    },
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ModeResource"
        }
       }
      }
     }
    }
   }
  },
  "/v2/dop-translation/github-configurations": {
   "get": {
    "tags": [
     "github-configuration-controller"
    ],
    "summary": "Search GitHub configs",
    "description": "  Get the list of GitHub configurations.\n  Note that a single configuration is supported at this time.\n  Requires 'Administer System' permission.\n",
    "operationId": "searchGithubConfiguration",
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/GithubConfigurationSearchRestResponse"
        }
       }
      }
     }
    }
   },
   "post": {
    "tags": [
     "github-configuration-controller"
    ],
    "summary": "Create GitHub configuration",
    "description": "  Create a new GitHub configuration.\n  Note that only a single configuration can exist at a time.\n  Requires 'Administer System' permission.\n",
    "operationId": "createGithubConfiguration",
    "requestBody": {
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/GithubConfigurationCreateRestRequest"
       }
      }
     },
     "required": true
    },
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/GithubConfigurationResource"
        }
       }
      }
     }
    }
   }
  },
  "/v2/authorizations/group-memberships/{id}": {
   "delete": {
    "tags": [
     "default-group-membership-controller"
    ],
    "summary": "Remove a group membership",
    "description": "Remove a user from a group",
    "operationId": "delete",
    "parameters": [
     {
      "name": "id",
      "in": "path",
      "description": "The ID of the group membership to delete.",
      "required": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "204": {
      "description": "No Content"
     }
    }
   }
  },
  "/v2/dop-translation/bound-projects": {
   "post": {
    "tags": [
     "bound-projects-controller"
    ],
    "summary": "Create a SonarQube project with the information from the provided DevOps platform project.",
    "description": "Create a SonarQube project with the information from the provided DevOps platform project.\nAutoconfigure Pull-Request decoration mechanism.\nRequires 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\n",
    "operationId": "createBoundProject",
    "requestBody": {
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/BoundProjectCreateRestRequest"
       }
      }
     },
     "required": true
    },
    "responses": {
     "201": {
      "description": "Created",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/BoundProjectCreateRestResponse"
        }
       }
      }
     }
    }
   }
  },
  "/v2/analysis/engine": {
   "get": {
    "tags": [
     "scanner-engine-controller"
    ],
    "summary": "Scanner engine download/metadata",
    "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",
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/octet-stream": {
        "schema": {
         "oneOf": [
          {
           "$ref": "#/components/schemas/EngineInfoRestResponse"
          },
          {
           "type": "string",
           "format": "binary"
          }
         ]
        }
       },
       "application/json": {
        "schema": {
         "oneOf": [
          {
           "$ref": "#/components/schemas/EngineInfoRestResponse"
          },
          {
           "type": "string",
           "format": "binary"
          }
         ]
        }
       }
      }
     }
    }
   }
  },
  "/v2/clean-code-policy/rules": {
   "post": {
    "tags": [
     "default-rule-controller"
    ],
    "summary": "Custom rule creation",
    "description": "  Create a custom rule.\n  Requires the 'Administer Quality Profiles' permission.\n",
    "operationId": "create_4",
    "requestBody": {
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/RuleCreateRestRequest"
       }
      }
     },
     "required": true
    },
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/RuleRestResponse"
        }
       }
      }
     }
    }
   }
  },
  "/v2/fix-suggestions/issues/{issueId}": {
   "get": {
    "tags": [
     "fix-suggestion-issue-controller"
    ],
    "summary": "Fetch AI suggestion availability for the given issueId",
    "description": "Requires Code Viewer permission.",
    "operationId": "get_1",
    "parameters": [
     {
      "name": "issueId",
      "in": "path",
      "required": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/FixSuggestionIssueResponse"
        }
       }
      }
     }
    }
   }
  },
  "/v2/dop-translation/gitlab-permission-mappings": {
   "get": {
    "tags": [
     "gitlab-permission-mappings-controller"
    ],
    "summary": "Fetch permissions mapping",
    "description": "Get the list of all the existing roles with their permission mappings. Requires 'Administer System' permission.",
    "operationId": "fetchAll",
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/PermissionMappingsSearchRestResponse"
        }
       }
      }
     }
    }
   },
   "post": {
    "tags": [
     "gitlab-permission-mappings-controller"
    ],
    "summary": "Create a permission mapping for a custom role",
    "description": "Requires 'Administer System' permission.",
    "operationId": "createMapping",
    "requestBody": {
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/PermissionMappingsPostRequest"
       }
      }
     },
     "required": true
    },
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/PermissionMappingsResource"
        }
       }
      }
     }
    }
   }
  },
  "/v2/analysis/jres/{id}": {
   "get": {
    "tags": [
     "jres-controller"
    ],
    "summary": "JRE download/metadata",
    "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",
    "parameters": [
     {
      "name": "id",
      "in": "path",
      "description": "The ID of the JRE",
      "required": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/octet-stream": {
        "schema": {
         "oneOf": [
          {
           "$ref": "#/components/schemas/JreInfoRestResponse"
          },
          {
           "type": "string",
           "format": "binary"
          }
         ]
        }
       },
       "application/json": {
        "schema": {
         "oneOf": [
          {
           "$ref": "#/components/schemas/JreInfoRestResponse"
          },
          {
           "type": "string",
           "format": "binary"
          }
         ]
        }
       }
      }
     }
    }
   }
  },
  "/v2/dop-translation/project-bindings/{id}": {
   "get": {
    "tags": [
     "project-bindings-controller"
    ],
    "summary": "Fetch a single Project Binding",
    "operationId": "getProjectBinding",
    "parameters": [
     {
      "name": "id",
      "in": "path",
      "description": "The id of the project-bindings to fetch.",
      "required": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ProjectBinding"
        }
       }
      }
     }
    }
   }
  },
  "/v2/fix-suggestions/feature-enablements/awareness-banner-interactions": {
   "post": {
    "tags": [
     "feature-enablement-controller"
    ],
    "summary": "Starts a GitLab synchronization run.",
    "operationId": "createAwarenessBannerClicked",
    "requestBody": {
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/AwarenessBannerClickedRequest"
       }
      }
     },
     "required": true
    },
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/AwarenessBannerClickedResponse"
        }
       }
      }
     }
    }
   }
  },
  "/v2/analysis/active_rules": {
   "get": {
    "tags": [
     "active-rules-controller"
    ],
    "summary": "Get all active rules for a specific project",
    "description": "Used by the scanner-engine to get all active rules for a given project.",
    "operationId": "getActiveRules",
    "parameters": [
     {
      "name": "projectKey",
      "in": "query",
      "description": "Project Key",
      "required": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "type": "array",
         "items": {
          "$ref": "#/components/schemas/ActiveRule"
         }
        }
       }
      }
     }
    }
   }
  },
  "/v2/authorizations/group-memberships": {
   "get": {
    "tags": [
     "default-group-membership-controller"
    ],
    "summary": "Search across group memberships",
    "description": "  Get the list of groups and members matching the query.\n",
    "operationId": "search_2",
    "parameters": [
     {
      "name": "userId",
      "in": "query",
      "description": "ID of the user for which to search groups. If not set, all groups are returned.",
      "required": false,
      "schema": {
       "type": "string",
       "description": "ID of the user for which to search groups. If not set, all groups are returned."
      }
     },
     {
      "name": "groupId",
      "in": "query",
      "description": "ID of the group for which to search members. If not set, all groups are returned.",
      "required": false,
      "schema": {
       "type": "string",
       "description": "ID of the group for which to search members. If not set, all groups are returned."
      }
     },
     {
      "name": "pageSize",
      "in": "query",
      "description": "Number of results per page. A value of 0 will only return the pagination information.",
      "required": false,
      "schema": {
       "type": "integer",
       "maximum": 500,
       "minimum": 0,
       "format": "int32",
       "description": "Number of results per page. A value of 0 will only return the pagination information.",
       "default": 50
      }
     },
     {
      "name": "pageIndex",
      "in": "query",
      "description": "1-based page index",
      "required": false,
      "schema": {
       "type": "integer",
       "minimum": 1,
       "format": "int32",
       "description": "1-based page index",
       "default": 1
      }
     }
    ],
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/GroupsMembershipSearchRestResponse"
        }
       }
      }
     }
    }
   },
   "post": {
    "tags": [
     "default-group-membership-controller"
    ],
    "summary": "Add a group membership",
    "description": "Add a user to a group.",
    "operationId": "create_6",
    "requestBody": {
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/GroupMembershipCreateRestRequest"
       }
      }
     },
     "required": true
    },
    "responses": {
     "201": {
      "description": "Created",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/GroupMembershipRestResponse"
        }
       }
      }
     }
    }
   }
  },
  "/v2/system/email-configurations": {
   "get": {
    "tags": [
     "email-configuration-controller"
    ],
    "summary": "Search email configurations",
    "description": "  Get the list of email configurations.\n  Note that a single configuration is supported at this time.\n  Requires 'Administer System' permission.\n",
    "operationId": "searchEmailConfigurations",
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/EmailConfigurationSearchRestResponse"
        }
       }
      }
     }
    }
   },
   "post": {
    "tags": [
     "email-configuration-controller"
    ],
    "summary": "Create an email configuration",
    "description": "  Create a new email configuration.\n  Note that only a single configuration can exist at a time.\n  Requires 'Administer System' permission.\n",
    "operationId": "createEmailConfiguration",
    "requestBody": {
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/EmailConfigurationCreateRestRequest"
       }
      }
     },
     "required": true
    },
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/EmailConfigurationResource"
        }
       }
      }
     }
    }
   }
  },
  "/v2/fix-suggestions/service-info": {
   "get": {
    "tags": [
     "service-info-controller"
    ],
    "summary": "Request status and subscription information of AI CodeFix service",
    "operationId": "get",
    "responses": {
     "200": {
      "description": "OK",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ServiceInfo"
        }
       }
      }
     }
    }
   }
  },
  "/api/alm_integrations/import_azure_project": {
   "description": "Manage DevOps Platform Integrations",
   "post": {
    "summary": "import azure project",
    "description": "Create a SonarQube project with the information from the provided Azure DevOps project.\u003cbr/\u003eAutoconfigure pull request decoration mechanism.\u003cbr/\u003eRequires 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": [
     {
      "name": "almSetting",
      "in": "query",
      "description": "DevOps Platform configuration key. This parameter is optional if you have only one Azure integration.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "newCodeDefinitionType",
      "in": "query",
      "description": "Project New Code Definition Type\u003cbr/\u003eNew code definitions of the following types are allowed:\u003cul\u003e\u003cli\u003ePREVIOUS_VERSION\u003c/li\u003e\u003cli\u003eNUMBER_OF_DAYS\u003c/li\u003e\u003cli\u003eREFERENCE_BRANCH - will default to the main branch.\u003c/li\u003e\u003c/ul\u003e",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "newCodeDefinitionValue",
      "in": "query",
      "description": "Project New Code Definition Value\u003cbr/\u003eFor each new code definition type, a different value is expected:\u003cul\u003e\u003cli\u003eno value, when the new code definition type is PREVIOUS_VERSION and REFERENCE_BRANCH\u003c/li\u003e\u003cli\u003ea number between 1 and 90, when the new code definition type is NUMBER_OF_DAYS\u003c/li\u003e\u003c/ul\u003e",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "projectName",
      "in": "query",
      "description": "Azure project name",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "repositoryName",
      "in": "query",
      "description": "Azure repository name",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/alm_integrations/import_bitbucketcloud_repo": {
   "description": "Manage DevOps Platform Integrations",
   "post": {
    "summary": "import bitbucketcloud repo",
    "description": "Create a SonarQube project with the information from the provided Bitbucket Cloud repository.\u003cbr/\u003eAutoconfigure pull request decoration mechanism.\u003cbr/\u003eRequires 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": [
     {
      "name": "almSetting",
      "in": "query",
      "description": "DevOps Platform configuration key. This parameter is optional if you have only one BitBucket Cloud integration.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "newCodeDefinitionType",
      "in": "query",
      "description": "Project New Code Definition Type\u003cbr/\u003eNew code definitions of the following types are allowed:\u003cul\u003e\u003cli\u003ePREVIOUS_VERSION\u003c/li\u003e\u003cli\u003eNUMBER_OF_DAYS\u003c/li\u003e\u003cli\u003eREFERENCE_BRANCH - will default to the main branch.\u003c/li\u003e\u003c/ul\u003e",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "newCodeDefinitionValue",
      "in": "query",
      "description": "Project New Code Definition Value\u003cbr/\u003eFor each new code definition type, a different value is expected:\u003cul\u003e\u003cli\u003eno value, when the new code definition type is PREVIOUS_VERSION and REFERENCE_BRANCH\u003c/li\u003e\u003cli\u003ea number between 1 and 90, when the new code definition type is NUMBER_OF_DAYS\u003c/li\u003e\u003c/ul\u003e",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "repositorySlug",
      "in": "query",
      "description": "Bitbucket Cloud repository slug",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/alm_integrations/import_bitbucketserver_project": {
   "description": "Manage DevOps Platform Integrations",
   "post": {
    "summary": "import bitbucketserver project",
    "description": "Create a SonarQube project with the information from the provided BitbucketServer project.\u003cbr/\u003eAutoconfigure pull request decoration mechanism.\u003cbr/\u003eRequires 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": [
     {
      "name": "almSetting",
      "in": "query",
      "description": "DevOps Platform configuration key. This parameter is optional if you have only one BitBucket Server integration.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "newCodeDefinitionType",
      "in": "query",
      "description": "Project New Code Definition Type\u003cbr/\u003eNew code definitions of the following types are allowed:\u003cul\u003e\u003cli\u003ePREVIOUS_VERSION\u003c/li\u003e\u003cli\u003eNUMBER_OF_DAYS\u003c/li\u003e\u003cli\u003eREFERENCE_BRANCH - will default to the main branch.\u003c/li\u003e\u003c/ul\u003e",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "newCodeDefinitionValue",
      "in": "query",
      "description": "Project New Code Definition Value\u003cbr/\u003eFor each new code definition type, a different value is expected:\u003cul\u003e\u003cli\u003eno value, when the new code definition type is PREVIOUS_VERSION and REFERENCE_BRANCH\u003c/li\u003e\u003cli\u003ea number between 1 and 90, when the new code definition type is NUMBER_OF_DAYS\u003c/li\u003e\u003c/ul\u003e",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "projectKey",
      "in": "query",
      "description": "BitbucketServer project key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "repositorySlug",
      "in": "query",
      "description": "BitbucketServer repository slug",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/alm_integrations/import_github_project": {
   "description": "Manage DevOps Platform Integrations",
   "post": {
    "summary": "import github project",
    "description": "Create a SonarQube project with the information from the provided GitHub repository.\u003cbr/\u003eAutoconfigure pull request decoration mechanism. If Automatic Provisioning is enable for GitHub, it will also synchronize permissions from the repository.\u003cbr/\u003eRequires 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": [
     {
      "name": "almSetting",
      "in": "query",
      "description": "DevOps Platform configuration key. This parameter is optional if you have only one GitHub integration.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "newCodeDefinitionType",
      "in": "query",
      "description": "Project New Code Definition Type\u003cbr/\u003eNew code definitions of the following types are allowed:\u003cul\u003e\u003cli\u003ePREVIOUS_VERSION\u003c/li\u003e\u003cli\u003eNUMBER_OF_DAYS\u003c/li\u003e\u003cli\u003eREFERENCE_BRANCH - will default to the main branch.\u003c/li\u003e\u003c/ul\u003e",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "newCodeDefinitionValue",
      "in": "query",
      "description": "Project New Code Definition Value\u003cbr/\u003eFor each new code definition type, a different value is expected:\u003cul\u003e\u003cli\u003eno value, when the new code definition type is PREVIOUS_VERSION and REFERENCE_BRANCH\u003c/li\u003e\u003cli\u003ea number between 1 and 90, when the new code definition type is NUMBER_OF_DAYS\u003c/li\u003e\u003c/ul\u003e",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "repositoryKey",
      "in": "query",
      "description": "GitHub repository key (organization/repoSlug",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/alm_integrations/import_gitlab_project": {
   "description": "Manage DevOps Platform Integrations",
   "post": {
    "summary": "import gitlab project",
    "description": "Import a GitLab project to SonarQube, creating a new project and configuring MR decoration\u003cbr/\u003eRequires 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": [
     {
      "name": "almSetting",
      "in": "query",
      "description": "DevOps Platform configuration key. This parameter is optional if you have only one GitLab integration.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "gitlabProjectId",
      "in": "query",
      "description": "GitLab project ID",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "newCodeDefinitionType",
      "in": "query",
      "description": "Project New Code Definition Type\u003cbr/\u003eNew code definitions of the following types are allowed:\u003cul\u003e\u003cli\u003ePREVIOUS_VERSION\u003c/li\u003e\u003cli\u003eNUMBER_OF_DAYS\u003c/li\u003e\u003cli\u003eREFERENCE_BRANCH - will default to the main branch.\u003c/li\u003e\u003c/ul\u003e",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "newCodeDefinitionValue",
      "in": "query",
      "description": "Project New Code Definition Value\u003cbr/\u003eFor each new code definition type, a different value is expected:\u003cul\u003e\u003cli\u003eno value, when the new code definition type is PREVIOUS_VERSION and REFERENCE_BRANCH\u003c/li\u003e\u003cli\u003ea number between 1 and 90, when the new code definition type is NUMBER_OF_DAYS\u003c/li\u003e\u003c/ul\u003e",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/alm_integrations/list_azure_projects": {
   "description": "Manage DevOps Platform Integrations",
   "get": {
    "summary": "list azure projects",
    "description": "List Azure projects\u003cbr/\u003eRequires 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": [
     {
      "name": "almSetting",
      "in": "query",
      "description": "DevOps Platform setting key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/alm_integrations/list_bitbucketserver_projects": {
   "description": "Manage DevOps Platform Integrations",
   "get": {
    "summary": "list bitbucketserver projects",
    "description": "List the Bitbucket Server projects\u003cbr/\u003eRequires 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": [
     {
      "name": "almSetting",
      "in": "query",
      "description": "DevOps Platform setting key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "pageSize",
      "in": "query",
      "description": "Number of items to return.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "start",
      "in": "query",
      "description": "Start number for the page (inclusive). If not passed, the first page is assumed.",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/alm_integrations/search_azure_repos": {
   "description": "Manage DevOps Platform Integrations",
   "get": {
    "summary": "search azure repos",
    "description": "Search the Azure repositories\u003cbr/\u003eRequires 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": [
     {
      "name": "almSetting",
      "in": "query",
      "description": "DevOps Platform setting key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "projectName",
      "in": "query",
      "description": "Project name filter",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "searchQuery",
      "in": "query",
      "description": "Search query filter",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/alm_integrations/search_bitbucketcloud_repos": {
   "description": "Manage DevOps Platform Integrations",
   "get": {
    "summary": "search bitbucketcloud repos",
    "description": "Search the Bitbucket Cloud repositories\u003cbr/\u003eRequires 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": [
     {
      "name": "almSetting",
      "in": "query",
      "description": "DevOps Platform setting key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "p",
      "in": "query",
      "description": "1-based page number",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "ps",
      "in": "query",
      "description": "Page size. Must be greater than 0 and less or equal than 100",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "repositoryName",
      "in": "query",
      "description": "Repository name filter",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/alm_integrations/search_bitbucketserver_repos": {
   "description": "Manage DevOps Platform Integrations",
   "get": {
    "summary": "search bitbucketserver repos",
    "description": "Search the Bitbucket Server repositories with REPO_ADMIN access\u003cbr/\u003eRequires 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": [
     {
      "name": "almSetting",
      "in": "query",
      "description": "DevOps Platform setting key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "pageSize",
      "in": "query",
      "description": "Number of items to return.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "projectName",
      "in": "query",
      "description": "Project name filter",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "repositoryName",
      "in": "query",
      "description": "Repository name filter",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "start",
      "in": "query",
      "description": "Start number for the page (inclusive). If not passed, the first page is assumed.",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/alm_integrations/search_gitlab_repos": {
   "description": "Manage DevOps Platform Integrations",
   "get": {
    "summary": "search gitlab repos",
    "description": "Search the GitLab projects.\u003cbr/\u003eRequires 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": [
     {
      "name": "almSetting",
      "in": "query",
      "description": "DevOps Platform setting key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "p",
      "in": "query",
      "description": "1-based page number",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "projectName",
      "in": "query",
      "description": "Project name filter",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "ps",
      "in": "query",
      "description": "Page size. Must be greater than 0 and less or equal than 100",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/alm_integrations/set_pat": {
   "description": "Manage DevOps Platform Integrations",
   "post": {
    "summary": "set pat",
    "description": "Set a Personal Access Token for the given DevOps Platform setting\u003cbr/\u003eRequires 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": [
     {
      "name": "almSetting",
      "in": "query",
      "description": "DevOps Platform configuration key. This parameter is optional if you have only one single DevOps Platform integration.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "pat",
      "in": "query",
      "description": "Personal Access Token",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "username",
      "in": "query",
      "description": "Username",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/alm_settings/count_binding": {
   "description": "Manage DevOps Platform Settings",
   "get": {
    "summary": "count binding",
    "description": "Count number of project bound to an DevOps Platform setting.\u003cbr/\u003eRequires 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": [
     {
      "name": "almSetting",
      "in": "query",
      "description": "DevOps Platform setting key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/alm_settings/create_azure": {
   "description": "Manage DevOps Platform Settings",
   "post": {
    "summary": "create azure",
    "description": "Create Azure instance Setting. \u003cbr/\u003eRequires 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": [
     {
      "name": "key",
      "in": "query",
      "description": "Unique key of the Azure Devops instance setting",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "personalAccessToken",
      "in": "query",
      "description": "Azure Devops personal access token",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "url",
      "in": "query",
      "description": "Azure API URL",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/alm_settings/create_bitbucket": {
   "description": "Manage DevOps Platform Settings",
   "post": {
    "summary": "create bitbucket",
    "description": "Create Bitbucket instance Setting. \u003cbr/\u003eRequires 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": [
     {
      "name": "key",
      "in": "query",
      "description": "Unique key of the Bitbucket instance setting",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "personalAccessToken",
      "in": "query",
      "description": "Bitbucket personal access token",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "url",
      "in": "query",
      "description": "BitBucket server API URL",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/alm_settings/create_bitbucketcloud": {
   "description": "Manage DevOps Platform Settings",
   "post": {
    "summary": "create bitbucketcloud",
    "description": "Configure a new instance of Bitbucket Cloud. \u003cbr/\u003eRequires 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": [
     {
      "name": "clientId",
      "in": "query",
      "description": "Bitbucket Cloud Client ID",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "clientSecret",
      "in": "query",
      "description": "Bitbucket Cloud Client Secret",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "key",
      "in": "query",
      "description": "Unique key of the Bitbucket Cloud setting",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "workspace",
      "in": "query",
      "description": "Bitbucket Cloud workspace ID",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/alm_settings/create_github": {
   "description": "Manage DevOps Platform Settings",
   "post": {
    "summary": "create github",
    "description": "Create GitHub instance Setting. \u003cbr/\u003eRequires 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": [
     {
      "name": "appId",
      "in": "query",
      "description": "GitHub App ID",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "clientId",
      "in": "query",
      "description": "GitHub App Client ID",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "clientSecret",
      "in": "query",
      "description": "GitHub App Client Secret",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "key",
      "in": "query",
      "description": "Unique key of the GitHub instance setting",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "privateKey",
      "in": "query",
      "description": "GitHub App private key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "url",
      "in": "query",
      "description": "GitHub API URL",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "webhookSecret",
      "in": "query",
      "description": "GitHub App Webhook Secret",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/alm_settings/create_gitlab": {
   "description": "Manage DevOps Platform Settings",
   "post": {
    "summary": "create gitlab",
    "description": "Create GitLab instance Setting. \u003cbr/\u003eRequires 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": [
     {
      "name": "key",
      "in": "query",
      "description": "Unique key of the GitLab instance setting",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "personalAccessToken",
      "in": "query",
      "description": "GitLab personal access token",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "url",
      "in": "query",
      "description": "GitLab API URL",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/alm_settings/delete": {
   "description": "Manage DevOps Platform Settings",
   "post": {
    "summary": "delete",
    "description": "Delete an DevOps Platform Setting.\u003cbr/\u003eRequires 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": [
     {
      "name": "key",
      "in": "query",
      "description": "DevOps Platform Setting key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/alm_settings/delete_binding": {
   "description": "Manage DevOps Platform Settings",
   "post": {
    "summary": "delete binding",
    "description": "Delete the DevOps Platform binding of a project.\u003cbr/\u003eRequires 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": [
     {
      "name": "project",
      "in": "query",
      "description": "Project key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/alm_settings/get_binding": {
   "description": "Manage DevOps Platform Settings",
   "get": {
    "summary": "get binding",
    "description": "Get DevOps Platform binding of a given project.\u003cbr/\u003eRequires 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": [
     {
      "name": "project",
      "in": "query",
      "description": "Project key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/alm_settings/list": {
   "description": "Manage DevOps Platform Settings",
   "get": {
    "summary": "list",
    "description": "List DevOps Platform setting available for a given project, sorted by DevOps Platform key\u003cbr/\u003eRequires 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": [
     {
      "name": "project",
      "in": "query",
      "description": "Project key",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/alm_settings/list_definitions": {
   "description": "Manage DevOps Platform Settings",
   "get": {
    "summary": "list definitions",
    "description": "List DevOps Platform Settings, sorted by created date.\u003cbr/\u003eRequires 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": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/alm_settings/set_azure_binding": {
   "description": "Manage DevOps Platform Settings",
   "post": {
    "summary": "set azure binding",
    "description": "Bind a Azure DevOps instance to a project.\u003cbr/\u003eIf 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": [
     {
      "name": "almSetting",
      "in": "query",
      "description": "Azure DevOps setting key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "inlineAnnotationsEnabled",
      "in": "query",
      "description": "Enable inline annotations during Pull Request decoration for this project",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "monorepo",
      "in": "query",
      "description": "Is this project part of a monorepo",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "project",
      "in": "query",
      "description": "SonarQube project key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "projectName",
      "in": "query",
      "description": "Azure project name",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "repositoryName",
      "in": "query",
      "description": "Azure repository name",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/alm_settings/set_bitbucket_binding": {
   "description": "Manage DevOps Platform Settings",
   "post": {
    "summary": "set bitbucket binding",
    "description": "Bind a Bitbucket instance to a project.\u003cbr/\u003eIf 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": [
     {
      "name": "almSetting",
      "in": "query",
      "description": "Bitbucket Server setting key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "monorepo",
      "in": "query",
      "description": "Is this project part of a monorepo",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "project",
      "in": "query",
      "description": "Project key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "repository",
      "in": "query",
      "description": "Bitbucket Server repository key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "slug",
      "in": "query",
      "description": "Bitbucket repository slug",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/alm_settings/set_bitbucketcloud_binding": {
   "description": "Manage DevOps Platform Settings",
   "post": {
    "summary": "set bitbucketcloud binding",
    "description": "Bind a Bitbucket Cloud setting to a project.\u003cbr/\u003eIf 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": [
     {
      "name": "almSetting",
      "in": "query",
      "description": "Bitbucket Cloud setting key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "monorepo",
      "in": "query",
      "description": "Is this project part of a monorepo",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "project",
      "in": "query",
      "description": "Project key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "repository",
      "in": "query",
      "description": "Bitbucket Cloud repository key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/alm_settings/set_github_binding": {
   "description": "Manage DevOps Platform Settings",
   "post": {
    "summary": "set github binding",
    "description": "Bind a GitHub instance to a project.\u003cbr/\u003eIf 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": [
     {
      "name": "almSetting",
      "in": "query",
      "description": "GitHub setting key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "monorepo",
      "in": "query",
      "description": "Is this project part of a monorepo",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "project",
      "in": "query",
      "description": "Project key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "repository",
      "in": "query",
      "description": "GitHub Repository",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "summaryCommentEnabled",
      "in": "query",
      "description": "Enable/disable summary in PR discussion tab",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/alm_settings/set_gitlab_binding": {
   "description": "Manage DevOps Platform Settings",
   "post": {
    "summary": "set gitlab binding",
    "description": "Bind a GitLab instance to a project.\u003cbr/\u003eIf 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": [
     {
      "name": "almSetting",
      "in": "query",
      "description": "GitLab setting key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "monorepo",
      "in": "query",
      "description": "Is this project part of a monorepo",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "project",
      "in": "query",
      "description": "Project key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "repository",
      "in": "query",
      "description": "GitLab project ID",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/alm_settings/update_azure": {
   "description": "Manage DevOps Platform Settings",
   "post": {
    "summary": "update azure",
    "description": "Update Azure instance Setting. \u003cbr/\u003eRequires 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": [
     {
      "name": "key",
      "in": "query",
      "description": "Unique key of the Azure instance setting",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "newKey",
      "in": "query",
      "description": "Optional new value for an unique key of the Azure Devops instance setting",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "personalAccessToken",
      "in": "query",
      "description": "Azure Devops personal access token",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "url",
      "in": "query",
      "description": "Azure API URL",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/alm_settings/update_bitbucket": {
   "description": "Manage DevOps Platform Settings",
   "post": {
    "summary": "update bitbucket",
    "description": "Update Bitbucket instance Setting. \u003cbr/\u003eRequires 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": [
     {
      "name": "key",
      "in": "query",
      "description": "Unique key of the Bitbucket instance setting",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "newKey",
      "in": "query",
      "description": "Optional new value for an unique key of the Bitbucket instance setting",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "personalAccessToken",
      "in": "query",
      "description": "Bitbucket personal access token",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "url",
      "in": "query",
      "description": "Bitbucket API URL",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/alm_settings/update_bitbucketcloud": {
   "description": "Manage DevOps Platform Settings",
   "post": {
    "summary": "update bitbucketcloud",
    "description": "Update Bitbucket Cloud Setting. \u003cbr/\u003eRequires 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": [
     {
      "name": "clientId",
      "in": "query",
      "description": "Bitbucket Cloud Client ID",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "clientSecret",
      "in": "query",
      "description": "Optional new value for the Bitbucket Cloud client secret",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "key",
      "in": "query",
      "description": "Unique key of the Bitbucket Cloud setting",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "newKey",
      "in": "query",
      "description": "Optional new value for an unique key of the Bitbucket Cloud setting",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "workspace",
      "in": "query",
      "description": "Bitbucket Cloud workspace ID",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/alm_settings/update_github": {
   "description": "Manage DevOps Platform Settings",
   "post": {
    "summary": "update github",
    "description": "Update GitHub instance Setting. \u003cbr/\u003eRequires 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": [
     {
      "name": "appId",
      "in": "query",
      "description": "GitHub API ID",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "clientId",
      "in": "query",
      "description": "GitHub App Client ID",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "clientSecret",
      "in": "query",
      "description": "GitHub App Client Secret",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "key",
      "in": "query",
      "description": "Unique key of the GitHub instance setting",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "newKey",
      "in": "query",
      "description": "Optional new value for an unique key of the GitHub instance setting",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "privateKey",
      "in": "query",
      "description": "GitHub App private key",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "url",
      "in": "query",
      "description": "GitHub API URL",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "webhookSecret",
      "in": "query",
      "description": "GitHub App Webhook Secret",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/alm_settings/update_gitlab": {
   "description": "Manage DevOps Platform Settings",
   "post": {
    "summary": "update gitlab",
    "description": "Update GitLab instance Setting. \u003cbr/\u003eRequires 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": [
     {
      "name": "key",
      "in": "query",
      "description": "Unique key of the GitLab instance setting",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "newKey",
      "in": "query",
      "description": "Optional new value for an unique key of the GitLab instance setting",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "personalAccessToken",
      "in": "query",
      "description": "GitLab personal access token",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "url",
      "in": "query",
      "description": "GitLab API URL",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/alm_settings/validate": {
   "description": "Manage DevOps Platform Settings",
   "get": {
    "summary": "validate",
    "description": "Validate an DevOps Platform Setting by checking connectivity and permissions\u003cbr/\u003eRequires 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": [
     {
      "name": "key",
      "in": "query",
      "description": "Unique key of the DevOps Platform settings",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/analysis_cache/get": {
   "description": "Access the analysis cache",
   "get": {
    "summary": "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": [
     {
      "name": "branch",
      "in": "query",
      "description": "Branch key. If not provided, main branch will be used.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "project",
      "in": "query",
      "description": "Project key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/applications/add_project": {
   "description": "Manage applications.",
   "post": {
    "summary": "add project",
    "description": "Add a project to an application.\u003cbr/\u003eRequires '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": [
     {
      "name": "application",
      "in": "query",
      "description": "Key of the application",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "project",
      "in": "query",
      "description": "Key of the project",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/applications/create": {
   "description": "Manage applications.",
   "post": {
    "summary": "create",
    "description": "Create a new application.\u003cbr/\u003eRequires '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": [
     {
      "name": "description",
      "in": "query",
      "description": "Application description",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "key",
      "in": "query",
      "description": "Application key. A suitable key will be generated if not provided",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "name",
      "in": "query",
      "description": "Application name",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "visibility",
      "in": "query",
      "description": "Whether the created application should be visible to everyone, or only specific user/groups.\u003cbr/\u003eIf no visibility is specified, the default visibility will be used.",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/applications/create_branch": {
   "description": "Manage applications.",
   "post": {
    "summary": "create branch",
    "description": "Create a new branch on a given application.\u003cbr/\u003eRequires '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": [
     {
      "name": "application",
      "in": "query",
      "description": "Application key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "branch",
      "in": "query",
      "description": "Branch name",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "project",
      "in": "query",
      "description": "Project keys. To set several values, the parameter must be called once for each value.",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "projectBranch",
      "in": "query",
      "description": "Project branches. To set main branch, provide an empty value. To set several values, the parameter must be called once for each value.",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/applications/delete": {
   "description": "Manage applications.",
   "post": {
    "summary": "delete",
    "description": "Delete an application definition.\u003cbr/\u003eRequires '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": [
     {
      "name": "application",
      "in": "query",
      "description": "Application key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/applications/delete_branch": {
   "description": "Manage applications.",
   "post": {
    "summary": "delete branch",
    "description": "Delete a branch on a given application.\u003cbr/\u003eRequires '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": [
     {
      "name": "application",
      "in": "query",
      "description": "Application key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "branch",
      "in": "query",
      "description": "Branch name",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/applications/remove_project": {
   "description": "Manage applications.",
   "post": {
    "summary": "remove project",
    "description": "Remove a project from an application\u003cbr/\u003eRequires '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": [
     {
      "name": "application",
      "in": "query",
      "description": "Key of the application",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "project",
      "in": "query",
      "description": "Key of the project",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/applications/set_tags": {
   "description": "Manage applications.",
   "post": {
    "summary": "set tags",
    "description": "Set tags on a application.\u003cbr\u003eRequires 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": [
     {
      "name": "application",
      "in": "query",
      "description": "Application key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "tags",
      "in": "query",
      "description": "Comma-separated list of tags",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/applications/show": {
   "description": "Manage applications.",
   "get": {
    "summary": "show",
    "description": "Returns an application and its associated projects. \u003cbr\u003e 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": [
     {
      "name": "application",
      "in": "query",
      "description": "Application key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "branch",
      "in": "query",
      "description": "Branch name",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/applications/update": {
   "description": "Manage applications.",
   "post": {
    "summary": "update",
    "description": "Update an application.\u003cbr/\u003eRequires '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": [
     {
      "name": "application",
      "in": "query",
      "description": "Application key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "description",
      "in": "query",
      "description": "New description for the application",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "name",
      "in": "query",
      "description": "New name for the application",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/applications/update_branch": {
   "description": "Manage applications.",
   "post": {
    "summary": "update branch",
    "description": "Update a branch on a given application.\u003cbr/\u003eRequires '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": [
     {
      "name": "application",
      "in": "query",
      "description": "Application key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "branch",
      "in": "query",
      "description": "Branch name",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "name",
      "in": "query",
      "description": "New branch name",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "project",
      "in": "query",
      "description": "Project keys. To set several values, the parameter must be called once for each value.",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "projectBranch",
      "in": "query",
      "description": "Project branches. To set main branch, provide an empty value. To set several values, the parameter must be called once for each value.",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/audit_logs/download": {
   "description": "Manage Audit logs",
   "get": {
    "summary": "download",
    "description": "Returns security related audits of this SonarQube instance. Logs are returned in JSON format.\u003cbr/\u003eRequires the system administration permission\u003cbr/\u003e",
    "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": [
     {
      "name": "from",
      "in": "query",
      "description": "Date in ISO 8601 datetime format (YYYY-MM-DDThh:mm:ss±hh:mm) from which the logs will be returned. Inclusive.",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "to",
      "in": "query",
      "description": "Date in ISO 8601 datetime format (YYYY-MM-DDThh:mm:ss±hh:mm) until which the logs will be returned. Inclusive.",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/authentication/login": {
   "description": "Handle authentication.",
   "post": {
    "summary": "login",
    "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": [
     {
      "name": "login",
      "in": "query",
      "description": "Login of the user",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "password",
      "in": "query",
      "description": "Password of the user",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/authentication/logout": {
   "description": "Handle authentication.",
   "post": {
    "summary": "logout",
    "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": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/authentication/validate": {
   "description": "Handle authentication.",
   "get": {
    "summary": "validate",
    "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": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/ce/activity": {
   "description": "Get information on Compute Engine tasks.",
   "get": {
    "summary": "activity",
    "description": "Search for tasks.\u003cbr\u003e 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": [
     {
      "name": "component",
      "in": "query",
      "description": "Key of the component (project) to filter on",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "maxExecutedAt",
      "in": "query",
      "description": "Maximum date of end of task processing (inclusive)",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "minSubmittedAt",
      "in": "query",
      "description": "Minimum date of task submission (inclusive)",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "onlyCurrents",
      "in": "query",
      "description": "Filter on the last tasks (only the most recent finished task by project)",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "p",
      "in": "query",
      "description": "1-based page number",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "ps",
      "in": "query",
      "description": "Page size. Must be greater than 0 and less or equal than 1000",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "q",
      "in": "query",
      "description": "Limit search to: \u003cul\u003e\u003cli\u003ecomponent names that contain the supplied string\u003c/li\u003e\u003cli\u003ecomponent keys that are exactly the same as the supplied string\u003c/li\u003e\u003cli\u003etask ids that are exactly the same as the supplied string\u003c/li\u003e\u003c/ul\u003e",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "status",
      "in": "query",
      "description": "Comma separated list of task statuses",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "type",
      "in": "query",
      "description": "Task type",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/ce/activity_status": {
   "description": "Get information on Compute Engine tasks.",
   "get": {
    "summary": "activity status",
    "description": "Returns CE activity related metrics.\u003cbr\u003eRequires '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": [
     {
      "name": "component",
      "in": "query",
      "description": "Key of the component (project) to filter on",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/ce/component": {
   "description": "Get information on Compute Engine tasks.",
   "get": {
    "summary": "component",
    "description": "Get the pending tasks, in-progress tasks and the last executed task of a given component (usually a project).\u003cbr\u003eRequires 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": [
     {
      "name": "component",
      "in": "query",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/ce/task": {
   "description": "Get information on Compute Engine tasks.",
   "get": {
    "summary": "task",
    "description": "Give Compute Engine task details such as type, status, duration and associated component.\u003cbr/\u003eRequires one of the following permissions: \u003cul\u003e\u003cli\u003e'Administer' at global or project level\u003c/li\u003e\u003cli\u003e'Execute Analysis' at global or project level\u003c/li\u003e\u003c/ul\u003eSince 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": [
     {
      "name": "additionalFields",
      "in": "query",
      "description": "Comma-separated list of the optional fields to be returned in response.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "id",
      "in": "query",
      "description": "Id of task",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/components/search": {
   "description": "Get information about a component (file, directory, project, ...) and its ancestors or descendants. Update a project or module key.",
   "get": {
    "summary": "search",
    "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": [
     {
      "name": "p",
      "in": "query",
      "description": "1-based page number",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "ps",
      "in": "query",
      "description": "Page size. Must be greater than 0 and less or equal than 500",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "q",
      "in": "query",
      "description": "Limit search to: \u003cul\u003e\u003cli\u003ecomponent names that contain the supplied string\u003c/li\u003e\u003cli\u003ecomponent keys that are exactly the same as the supplied string\u003c/li\u003e\u003c/ul\u003e\u003cbr\u003eThe value length of the param must be between 2 and 15 (inclusive) characters. In case longer value is provided it will be truncated.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "qualifiers",
      "in": "query",
      "description": "Comma-separated list of component qualifiers. Filter the results with the specified qualifiers. Possible values are:\u003cul\u003e\u003cli\u003eAPP - Applications\u003c/li\u003e\u003cli\u003eVW - Portfolios\u003c/li\u003e\u003cli\u003eSVW - Portfolios\u003c/li\u003e\u003cli\u003eTRK - Projects\u003c/li\u003e\u003c/ul\u003e",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/components/show": {
   "description": "Get information about a component (file, directory, project, ...) and its ancestors or descendants. Update a project or module key.",
   "get": {
    "summary": "show",
    "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": [
     {
      "name": "branch",
      "in": "query",
      "description": "Branch key. Not available in the community edition.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "component",
      "in": "query",
      "description": "Component key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "pullRequest",
      "in": "query",
      "description": "Pull request id. Not available in the community edition.",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/components/tree": {
   "description": "Get information about a component (file, directory, project, ...) and its ancestors or descendants. Update a project or module key.",
   "get": {
    "summary": "tree",
    "description": "Navigate through components based on the chosen strategy.\u003cbr\u003eRequires the following permission: 'Browse' on the specified project.\u003cbr\u003eWhen 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": [
     {
      "name": "asc",
      "in": "query",
      "description": "Ascending sort",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "branch",
      "in": "query",
      "description": "Branch key. Not available in the community edition.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "component",
      "in": "query",
      "description": "Base component key. The search is based on this component.",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "p",
      "in": "query",
      "description": "1-based page number",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "ps",
      "in": "query",
      "description": "Page size. Must be greater than 0 and less or equal than 500",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "pullRequest",
      "in": "query",
      "description": "Pull request id. Not available in the community edition.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "q",
      "in": "query",
      "description": "Limit search to: \u003cul\u003e\u003cli\u003ecomponent names that contain the supplied string\u003c/li\u003e\u003cli\u003ecomponent keys that are exactly the same as the supplied string\u003c/li\u003e\u003c/ul\u003e",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "qualifiers",
      "in": "query",
      "description": "Comma-separated list of component qualifiers. Filter the results with the specified qualifiers. Possible values are:\u003cul\u003e\u003cli\u003eAPP - Applications\u003c/li\u003e\u003cli\u003eVW - Portfolios\u003c/li\u003e\u003cli\u003eSVW - Portfolios\u003c/li\u003e\u003cli\u003eUTS - Test Files\u003c/li\u003e\u003cli\u003eFIL - Files\u003c/li\u003e\u003cli\u003eDIR - Directories\u003c/li\u003e\u003cli\u003eTRK - Projects\u003c/li\u003e\u003c/ul\u003e",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "s",
      "in": "query",
      "description": "Comma-separated list of sort fields",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "strategy",
      "in": "query",
      "description": "Strategy to search for base component descendants:\u003cul\u003e\u003cli\u003echildren: return the children components of the base component. Grandchildren components are not returned\u003c/li\u003e\u003cli\u003eall: return all the descendants components of the base component. Grandchildren are returned.\u003c/li\u003e\u003cli\u003eleaves: return all the descendant components (files, in general) which don't have other children. They are the leaves of the component tree.\u003c/li\u003e\u003c/ul\u003e",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/duplications/show": {
   "description": "Get duplication information for a project.",
   "get": {
    "summary": "show",
    "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": [
     {
      "name": "key",
      "in": "query",
      "description": "File key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/editions/activate_grace_period": {
   "description": "Manage SonarSource commercial editions",
   "post": {
    "summary": "activate grace period",
    "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": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/editions/set_license": {
   "description": "Manage SonarSource commercial editions",
   "post": {
    "summary": "set license",
    "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": [
     {
      "name": "license",
      "in": "query",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/favorites/add": {
   "description": "Manage user favorites",
   "post": {
    "summary": "add",
    "description": "Add a component (project, portfolio, etc.) as favorite for the authenticated user.\u003cbr\u003eOnly 100 components by qualifier can be added as favorite.\u003cbr\u003eRequires 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": [
     {
      "name": "component",
      "in": "query",
      "description": "Component key. Only components with qualifiers TRK, VW, SVW, APP are supported",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/favorites/remove": {
   "description": "Manage user favorites",
   "post": {
    "summary": "remove",
    "description": "Remove a component (project, portfolio, application etc.) as favorite for the authenticated user.\u003cbr\u003eRequires 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": [
     {
      "name": "component",
      "in": "query",
      "description": "Component key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/favorites/search": {
   "description": "Manage user favorites",
   "get": {
    "summary": "search",
    "description": "Search for the authenticated user favorites.\u003cbr\u003eRequires 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": [
     {
      "name": "p",
      "in": "query",
      "description": "1-based page number",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "ps",
      "in": "query",
      "description": "Page size. Must be greater than 0 and less or equal than 500",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/hotspots/change_status": {
   "description": "Read and update Security Hotspots.",
   "post": {
    "summary": "change status",
    "description": "Change the status of a Security Hotpot.\u003cbr/\u003eRequires 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": [
     {
      "name": "comment",
      "in": "query",
      "description": "Comment text.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "hotspot",
      "in": "query",
      "description": "Key of the Security Hotspot",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "resolution",
      "in": "query",
      "description": "Resolution of the Security Hotspot when new status is REVIEWED, otherwise must not be set.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "status",
      "in": "query",
      "description": "New status of the Security Hotspot.",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/hotspots/search": {
   "description": "Read and update Security Hotspots.",
   "get": {
    "summary": "search",
    "description": "Search for Security Hotpots. \u003cbr\u003eRequires the 'Browse' permission on the specified project(s). \u003cbr\u003eFor applications, it also requires 'Browse' permission on its child projects. \u003cbr\u003eWhen 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": [
     {
      "name": "branch",
      "in": "query",
      "description": "Branch key. Not available in the community edition.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "casa",
      "in": "query",
      "description": "Comma-separated list of CASA categories.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "cwe",
      "in": "query",
      "description": "Comma-separated list of CWE numbers",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "files",
      "in": "query",
      "description": "Comma-separated list of files. Returns only hotspots found in those files",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "hotspots",
      "in": "query",
      "description": "Comma-separated list of Security Hotspot keys. This parameter is required unless project is provided.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "inNewCodePeriod",
      "in": "query",
      "description": "If 'inNewCodePeriod' is provided, only Security Hotspots created in the new code period are returned.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "onlyMine",
      "in": "query",
      "description": "If 'projectKey' is provided, returns only Security Hotspots assigned to the current user",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "owaspAsvs-4.0",
      "in": "query",
      "description": "Comma-separated list of OWASP ASVS v4.0 categories or rules.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "owaspAsvsLevel",
      "in": "query",
      "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.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "owaspTop10",
      "in": "query",
      "description": "Comma-separated list of OWASP 2017 Top 10 lowercase categories.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "owaspTop10-2021",
      "in": "query",
      "description": "Comma-separated list of OWASP 2021 Top 10 lowercase categories.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "p",
      "in": "query",
      "description": "1-based page number",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "pciDss-3.2",
      "in": "query",
      "description": "Comma-separated list of PCI DSS v3.2 categories.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "pciDss-4.0",
      "in": "query",
      "description": "Comma-separated list of PCI DSS v4.0 categories.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "project",
      "in": "query",
      "description": "Key of the project or application. This parameter is required unless hotspots is provided.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "ps",
      "in": "query",
      "description": "Page size. Must be greater than 0.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "pullRequest",
      "in": "query",
      "description": "Pull request id. Not available in the community edition.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "resolution",
      "in": "query",
      "description": "If 'project' is provided and if status is 'REVIEWED', only Security Hotspots with the specified resolution are returned.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "sansTop25",
      "in": "query",
      "description": "Comma-separated list of SANS Top 25 categories.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "sonarsourceSecurity",
      "in": "query",
      "description": "Comma-separated list of SonarSource security categories. Use 'others' to select issues not associated with any category",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "status",
      "in": "query",
      "description": "If 'project' is provided, only Security Hotspots with the specified status are returned.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "stig-ASD_V5R3",
      "in": "query",
      "description": "Comma-separated list of STIG V5R3 lowercase categories.",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/hotspots/show": {
   "description": "Read and update Security Hotspots.",
   "get": {
    "summary": "show",
    "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": [
     {
      "name": "hotspot",
      "in": "query",
      "description": "Key of the Security Hotspot",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/issues/add_comment": {
   "description": "Read and update issues.",
   "post": {
    "summary": "add comment",
    "description": "Add a comment.\u003cbr/\u003eRequires 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": [
     {
      "name": "issue",
      "in": "query",
      "description": "Issue key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "text",
      "in": "query",
      "description": "Comment text",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/issues/assign": {
   "description": "Read and update issues.",
   "post": {
    "summary": "assign",
    "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": [
     {
      "name": "assignee",
      "in": "query",
      "description": "Login of the assignee. When not set, it will unassign the issue. Use '_me' to assign to current user",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "issue",
      "in": "query",
      "description": "Issue key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/issues/authors": {
   "description": "Read and update issues.",
   "get": {
    "summary": "authors",
    "description": "Search SCM accounts which match a given query.\u003cbr/\u003eRequires authentication.\u003cbr/\u003eWhen 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": [
     {
      "name": "project",
      "in": "query",
      "description": "Project key",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "ps",
      "in": "query",
      "description": "Page size. Must be greater than 0 and less or equal than 100",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "q",
      "in": "query",
      "description": "Limit search to authors that contain the supplied string.",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/issues/bulk_change": {
   "description": "Read and update issues.",
   "post": {
    "summary": "bulk change",
    "description": "Bulk change on issues. Up to 500 issues can be updated. \u003cbr/\u003eRequires 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": [
     {
      "name": "add_tags",
      "in": "query",
      "description": "Add tags",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "assign",
      "in": "query",
      "description": "To assign the list of issues to a specific user (login), or un-assign all the issues",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "comment",
      "in": "query",
      "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.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "do_transition",
      "in": "query",
      "description": "Transition",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "issues",
      "in": "query",
      "description": "Comma-separated list of issue keys",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "remove_tags",
      "in": "query",
      "description": "Remove tags",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "sendNotifications",
      "in": "query",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "set_severity",
      "in": "query",
      "description": "To change the severity of the list of issues",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "set_type",
      "in": "query",
      "description": "To change the type of the list of issues",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/issues/changelog": {
   "description": "Read and update issues.",
   "get": {
    "summary": "changelog",
    "description": "Display changelog of an issue.\u003cbr/\u003eRequires 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": [
     {
      "name": "issue",
      "in": "query",
      "description": "Issue key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/issues/delete_comment": {
   "description": "Read and update issues.",
   "post": {
    "summary": "delete comment",
    "description": "Delete a comment.\u003cbr/\u003eRequires 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": [
     {
      "name": "comment",
      "in": "query",
      "description": "Comment key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/issues/do_transition": {
   "description": "Read and update issues.",
   "post": {
    "summary": "do transition",
    "description": "Do workflow transition on an issue. Requires authentication and Browse permission on project.\u003cbr/\u003e\nThe transitions 'accept', 'wontfix' and 'falsepositive' require the permission 'Administer Issues'.\u003cbr/\u003e\nThe transitions involving security hotspots require the permission 'Administer Security Hotspot'.\n",
    "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": [
     {
      "name": "issue",
      "in": "query",
      "description": "Issue key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "transition",
      "in": "query",
      "description": "Transition",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/issues/edit_comment": {
   "description": "Read and update issues.",
   "post": {
    "summary": "edit comment",
    "description": "Edit a comment.\u003cbr/\u003eRequires 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": [
     {
      "name": "comment",
      "in": "query",
      "description": "Comment key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "text",
      "in": "query",
      "description": "Comment text",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/issues/gitlab_sast_export": {
   "description": "Read and update issues.",
   "get": {
    "summary": "gitlab sast export",
    "description": "Return a list of vulnerabilities according to the Gitlab SAST JSON format.\u003cbr\u003e 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": [
     {
      "name": "branch",
      "in": "query",
      "description": "Branch key.If this parameter is set, pullRequest must not be set.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "projectKey",
      "in": "query",
      "description": "The project key for which the vulnerabilities are being fetched",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "pullRequest",
      "in": "query",
      "description": "Pull request id.If this parameter is set, branch must not be set.",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/issues/reindex": {
   "description": "Read and update issues.",
   "post": {
    "summary": "reindex",
    "description": "Reindex issues for a project.\u003cbr\u003e 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": [
     {
      "name": "project",
      "in": "query",
      "description": "Project key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/issues/search": {
   "description": "Read and update issues.",
   "get": {
    "summary": "search",
    "description": "Search for issues.\u003cbr\u003eRequires the 'Browse' permission on the specified project(s). \u003cbr\u003eFor applications, it also requires 'Browse' permission on its child projects.\u003cbr/\u003eWhen 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": [
     {
      "name": "additionalFields",
      "in": "query",
      "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.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "asc",
      "in": "query",
      "description": "Ascending sort",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "assigned",
      "in": "query",
      "description": "To retrieve assigned or unassigned issues",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "assignees",
      "in": "query",
      "description": "Comma-separated list of assignee logins. The value '__me__' can be used as a placeholder for user who performs the request",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "author",
      "in": "query",
      "description": "SCM accounts. To set several values, the parameter must be called once for each value.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "branch",
      "in": "query",
      "description": "Branch key. Not available in the community edition.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "casa",
      "in": "query",
      "description": "Comma-separated list of CASA categories.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "cleanCodeAttributeCategories",
      "in": "query",
      "description": "Comma-separated list of Clean Code Attribute Categories",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "codeVariants",
      "in": "query",
      "description": "Comma-separated list of code variants.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "components",
      "in": "query",
      "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.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "createdAfter",
      "in": "query",
      "description": "To retrieve issues created after the given date (inclusive). \u003cbr\u003eEither a date (use 'timeZone' attribute or it will default to server timezone) or datetime can be provided. \u003cbr\u003eIf this parameter is set, createdInLast must not be set",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "createdAt",
      "in": "query",
      "description": "Datetime to retrieve issues created during a specific analysis",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "createdBefore",
      "in": "query",
      "description": "To retrieve issues created before the given date (exclusive). \u003cbr\u003eEither a date (use 'timeZone' attribute or it will default to server timezone) or datetime can be provided.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "createdInLast",
      "in": "query",
      "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",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "cwe",
      "in": "query",
      "description": "Comma-separated list of CWE identifiers. Use 'unknown' to select issues not associated to any CWE.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "facets",
      "in": "query",
      "description": "Comma-separated list of the facets to be computed. No facet is computed by default.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "fixedInPullRequest",
      "in": "query",
      "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.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "impactSeverities",
      "in": "query",
      "description": "Comma-separated list of Software Quality Severities",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "impactSoftwareQualities",
      "in": "query",
      "description": "Comma-separated list of Software Qualities",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "inNewCodePeriod",
      "in": "query",
      "description": "To retrieve issues created in the new code period.\u003cbr\u003eIf this parameter is set to a truthy value, createdAfter must not be set and one component uuid or key must be provided.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "issueStatuses",
      "in": "query",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "issues",
      "in": "query",
      "description": "Comma-separated list of issue keys",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "languages",
      "in": "query",
      "description": "Comma-separated list of languages. Available since 4.4",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "onComponentOnly",
      "in": "query",
      "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.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "owaspAsvs-4.0",
      "in": "query",
      "description": "Comma-separated list of OWASP ASVS v4.0 categories.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "owaspAsvsLevel",
      "in": "query",
      "description": "Level of OWASP ASVS categories.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "owaspTop10",
      "in": "query",
      "description": "Comma-separated list of OWASP Top 10 2017 lowercase categories.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "owaspTop10-2021",
      "in": "query",
      "description": "Comma-separated list of OWASP Top 10 2021 lowercase categories.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "p",
      "in": "query",
      "description": "1-based page number",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "pciDss-3.2",
      "in": "query",
      "description": "Comma-separated list of PCI DSS v3.2 categories.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "pciDss-4.0",
      "in": "query",
      "description": "Comma-separated list of PCI DSS v4.0 categories.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "prioritizedRule",
      "in": "query",
      "description": "To match issues with prioritized rule or not",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "ps",
      "in": "query",
      "description": "Page size. Must be greater than 0 and less or equal than 500",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "pullRequest",
      "in": "query",
      "description": "Pull request id. Not available in the community edition.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "resolutions",
      "in": "query",
      "description": "Comma-separated list of resolutions",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "resolved",
      "in": "query",
      "description": "To match resolved or unresolved issues",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "rules",
      "in": "query",
      "description": "Comma-separated list of coding rule keys. Format is \u0026lt;repository\u0026gt;:\u0026lt;rule\u0026gt;",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "s",
      "in": "query",
      "description": "Sort field",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "sansTop25",
      "in": "query",
      "description": "Comma-separated list of SANS Top 25 categories.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "scopes",
      "in": "query",
      "description": "Comma-separated list of scopes. Available since 8.5",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "severities",
      "in": "query",
      "description": "Comma-separated list of severities",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "sonarsourceSecurity",
      "in": "query",
      "description": "Comma-separated list of SonarSource security categories. Use 'others' to select issues not associated with any category",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "statuses",
      "in": "query",
      "description": "Comma-separated list of statuses",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "stig-ASD_V5R3",
      "in": "query",
      "description": "Comma-separated list of STIG V5R3 categories.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "tags",
      "in": "query",
      "description": "Comma-separated list of tags.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "timeZone",
      "in": "query",
      "description": "To resolve dates passed to 'createdAfter' or 'createdBefore' (does not apply to datetime) and to compute creation date histogram",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "types",
      "in": "query",
      "description": "Comma-separated list of types.",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/issues/set_severity": {
   "description": "Read and update issues.",
   "post": {
    "summary": "set severity",
    "description": "Change severity.\u003cbr/\u003eRequires the following permissions:\u003cul\u003e  \u003cli\u003e'Authentication'\u003c/li\u003e  \u003cli\u003e'Browse' rights on project of the specified issue\u003c/li\u003e  \u003cli\u003e'Administer Issues' rights on project of the specified issue\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "impact",
      "in": "query",
      "description": "Override of impact severity for the rule. Cannot be used as the same time as 'severity'",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "issue",
      "in": "query",
      "description": "Issue key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "severity",
      "in": "query",
      "description": "New severity",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/issues/set_tags": {
   "description": "Read and update issues.",
   "post": {
    "summary": "set tags",
    "description": "Set tags on an issue. \u003cbr/\u003eRequires 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": [
     {
      "name": "issue",
      "in": "query",
      "description": "Issue key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "tags",
      "in": "query",
      "description": "Comma-separated list of tags. All tags are removed if parameter is empty or not set.",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/issues/set_type": {
   "description": "Read and update issues.",
   "post": {
    "summary": "set type",
    "description": "Change type of issue, for instance from 'code smell' to 'bug'.\u003cbr/\u003eRequires the following permissions:\u003cul\u003e  \u003cli\u003e'Authentication'\u003c/li\u003e  \u003cli\u003e'Browse' rights on project of the specified issue\u003c/li\u003e  \u003cli\u003e'Administer Issues' rights on project of the specified issue\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "issue",
      "in": "query",
      "description": "Issue key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "type",
      "in": "query",
      "description": "New type",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/issues/tags": {
   "description": "Read and update issues.",
   "get": {
    "summary": "tags",
    "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": [
     {
      "name": "all",
      "in": "query",
      "description": "Indicator to search for all tags or only for tags in the main branch of a project",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "branch",
      "in": "query",
      "description": "Branch key",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "project",
      "in": "query",
      "description": "Project key",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "ps",
      "in": "query",
      "description": "Page size. Must be greater than 0 and less or equal than 500",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "q",
      "in": "query",
      "description": "Limit search to tags that contain the supplied string.",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/languages/list": {
   "description": "Get the list of programming languages supported in this instance.",
   "get": {
    "summary": "list",
    "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": [
     {
      "name": "ps",
      "in": "query",
      "description": "The size of the list to return, 0 for all languages",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "q",
      "in": "query",
      "description": "A pattern to match language keys/names against",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/measures/component": {
   "description": "Get components or children with specified measures.",
   "get": {
    "summary": "component",
    "description": "Return component with specified measures.\u003cbr\u003eRequires 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": [
     {
      "name": "additionalFields",
      "in": "query",
      "description": "Comma-separated list of additional fields that can be returned in the response.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "branch",
      "in": "query",
      "description": "Branch key. Not available in the community edition.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "component",
      "in": "query",
      "description": "Component key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "metricKeys",
      "in": "query",
      "description": "Comma-separated list of metric keys",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "pullRequest",
      "in": "query",
      "description": "Pull request id. Not available in the community edition.",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/measures/component_tree": {
   "description": "Get components or children with specified measures.",
   "get": {
    "summary": "component tree",
    "description": "Navigate through components based on the chosen strategy with specified measures.\u003cbr\u003eRequires the following permission: 'Browse' on the specified project.\u003cbr\u003eFor applications, it also requires 'Browse' permission on its child projects. \u003cbr\u003eWhen 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": [
     {
      "name": "additionalFields",
      "in": "query",
      "description": "Comma-separated list of additional fields that can be returned in the response.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "asc",
      "in": "query",
      "description": "Ascending sort",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "branch",
      "in": "query",
      "description": "Branch key. Not available in the community edition.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "component",
      "in": "query",
      "description": "Component key. The search is based on this component.",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "metricKeys",
      "in": "query",
      "description": "Comma-separated list of metric keys. Types DISTRIB are not allowed. For type DATA only new_reliability_issues, new_security_issues, new_maintainability_issues, reliability_issues, maintainability_issues, security_issues metrics are supported",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "metricPeriodSort",
      "in": "query",
      "description": "Sort measures by leak period or not ?. The 's' parameter must contain the 'metricPeriod' value.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "metricSort",
      "in": "query",
      "description": "Metric key to sort by. The 's' parameter must contain the 'metric' or 'metricPeriod' value. It must be part of the 'metricKeys' parameter",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "metricSortFilter",
      "in": "query",
      "description": "Filter components. Sort must be on a metric. Possible values are: \u003cul\u003e\u003cli\u003eall: return all components\u003c/li\u003e\u003cli\u003ewithMeasuresOnly: filter out components that do not have a measure on the sorted metric\u003c/li\u003e\u003c/ul\u003e",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "p",
      "in": "query",
      "description": "1-based page number",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "ps",
      "in": "query",
      "description": "Page size. Must be greater than 0 and less or equal than 500",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "pullRequest",
      "in": "query",
      "description": "Pull request id. Not available in the community edition.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "q",
      "in": "query",
      "description": "Limit search to: \u003cul\u003e\u003cli\u003ecomponent names that contain the supplied string\u003c/li\u003e\u003cli\u003ecomponent keys that are exactly the same as the supplied string\u003c/li\u003e\u003c/ul\u003e",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "qualifiers",
      "in": "query",
      "description": "Comma-separated list of component qualifiers. Filter the results with the specified qualifiers. Possible values are:\u003cul\u003e\u003cli\u003eAPP - Applications\u003c/li\u003e\u003cli\u003eVW - Portfolios\u003c/li\u003e\u003cli\u003eSVW - Portfolios\u003c/li\u003e\u003cli\u003eUTS - Test Files\u003c/li\u003e\u003cli\u003eFIL - Files\u003c/li\u003e\u003cli\u003eDIR - Directories\u003c/li\u003e\u003cli\u003eTRK - Projects\u003c/li\u003e\u003c/ul\u003e",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "s",
      "in": "query",
      "description": "Comma-separated list of sort fields",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "strategy",
      "in": "query",
      "description": "Strategy to search for base component descendants:\u003cul\u003e\u003cli\u003echildren: return the children components of the base component. Grandchildren components are not returned\u003c/li\u003e\u003cli\u003eall: return all the descendants components of the base component. Grandchildren are returned.\u003c/li\u003e\u003cli\u003eleaves: return all the descendant components (files, in general) which don't have other children. They are the leaves of the component tree.\u003c/li\u003e\u003c/ul\u003e",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/measures/search_history": {
   "description": "Get components or children with specified measures.",
   "get": {
    "summary": "search history",
    "description": "Search measures history of a component.\u003cbr\u003eMeasures are ordered chronologically.\u003cbr\u003ePagination applies to the number of measures for each metric.\u003cbr\u003eRequires the following permission: 'Browse' on the specified component. \u003cbr\u003eFor 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": [
     {
      "name": "branch",
      "in": "query",
      "description": "Branch key. Not available in the community edition.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "component",
      "in": "query",
      "description": "Component key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "from",
      "in": "query",
      "description": "Filter measures created after the given date (inclusive). \u003cbr\u003eEither a date (server timezone) or datetime can be provided",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "metrics",
      "in": "query",
      "description": "Comma-separated list of metric keys",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "p",
      "in": "query",
      "description": "1-based page number",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "ps",
      "in": "query",
      "description": "Page size. Must be greater than 0 and less or equal than 1000",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "pullRequest",
      "in": "query",
      "description": "Pull request id. Not available in the community edition.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "to",
      "in": "query",
      "description": "Filter measures created before the given date (inclusive). \u003cbr\u003eEither a date (server timezone) or datetime can be provided",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/metrics/search": {
   "description": "Get information on automatic metrics",
   "get": {
    "summary": "search",
    "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": [
     {
      "name": "p",
      "in": "query",
      "description": "1-based page number",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "ps",
      "in": "query",
      "description": "Page size. Must be greater than 0 and less or equal than 500",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/metrics/types": {
   "description": "Get information on automatic metrics",
   "get": {
    "summary": "types",
    "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": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/monitoring/metrics": {
   "description": "Monitoring",
   "get": {
    "summary": "metrics",
    "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": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/new_code_periods/list": {
   "description": "Manage \u003ca href=\"https://sonar-documentations-preview.netlify.app/sonarqube/project-administration/setting-up-clean-as-you-code/#setting-a-new-code-definition\" target=\"_blank\" rel=\"noopener noreferrer\"\u003enew code definition\u003c/a\u003e.",
   "get": {
    "summary": "list",
    "description": "Lists the \u003ca href=\"https://sonar-documentations-preview.netlify.app/sonarqube/project-administration/setting-up-clean-as-you-code/#setting-a-new-code-definition\" target=\"_blank\" rel=\"noopener noreferrer\"\u003enew code definition\u003c/a\u003e for all branches in a project.\u003cbr\u003eRequires 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": [
     {
      "name": "project",
      "in": "query",
      "description": "Project key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/new_code_periods/set": {
   "description": "Manage \u003ca href=\"https://sonar-documentations-preview.netlify.app/sonarqube/project-administration/setting-up-clean-as-you-code/#setting-a-new-code-definition\" target=\"_blank\" rel=\"noopener noreferrer\"\u003enew code definition\u003c/a\u003e.",
   "post": {
    "summary": "set",
    "description": "Updates the \u003ca href=\"https://sonar-documentations-preview.netlify.app/sonarqube/project-administration/setting-up-clean-as-you-code/#setting-a-new-code-definition\" target=\"_blank\" rel=\"noopener noreferrer\"\u003enew code definition\u003c/a\u003e on different levels:\u003cbr\u003e\u003cul\u003e\u003cli\u003eNot 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\u003c/li\u003e\u003cli\u003eProject key must be provided to update the value for a project\u003c/li\u003e\u003cli\u003eBoth project and branch keys must be provided to update the value for a branch\u003c/li\u003e\u003c/ul\u003eRequires one of the following permissions: \u003cul\u003e\u003cli\u003e'Administer System' to change the global setting\u003c/li\u003e\u003cli\u003e'Administer' rights on the specified project to change the project setting\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "branch",
      "in": "query",
      "description": "Branch key",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "project",
      "in": "query",
      "description": "Project key",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "type",
      "in": "query",
      "description": "Type\u003cbr/\u003eNew code definitions of the following types are allowed:\u003cul\u003e\u003cli\u003eSPECIFIC_ANALYSIS - can be set at branch level only\u003c/li\u003e\u003cli\u003ePREVIOUS_VERSION - can be set at any level (global, project, branch)\u003c/li\u003e\u003cli\u003eNUMBER_OF_DAYS - can be set at any level (global, project, branch)\u003c/li\u003e\u003cli\u003eREFERENCE_BRANCH - can only be set for projects and branches\u003c/li\u003e\u003c/ul\u003e",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "value",
      "in": "query",
      "description": "Value\u003cbr/\u003eFor each type, a different value is expected:\u003cul\u003e\u003cli\u003ethe uuid of an analysis, when type is SPECIFIC_ANALYSIS\u003c/li\u003e\u003cli\u003eno value, when type is PREVIOUS_VERSION\u003c/li\u003e\u003cli\u003ea number between 1 and 90, when type is NUMBER_OF_DAYS\u003c/li\u003e\u003cli\u003ea string, when type is REFERENCE_BRANCH\u003c/li\u003e\u003c/ul\u003e",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/new_code_periods/show": {
   "description": "Manage \u003ca href=\"https://sonar-documentations-preview.netlify.app/sonarqube/project-administration/setting-up-clean-as-you-code/#setting-a-new-code-definition\" target=\"_blank\" rel=\"noopener noreferrer\"\u003enew code definition\u003c/a\u003e.",
   "get": {
    "summary": "show",
    "description": "Shows the \u003ca href=\"https://sonar-documentations-preview.netlify.app/sonarqube/project-administration/setting-up-clean-as-you-code/#setting-a-new-code-definition\" target=\"_blank\" rel=\"noopener noreferrer\"\u003enew code definition\u003c/a\u003e.\u003cbr\u003e 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: \u003cul\u003e\u003cli\u003e'Administer' rights on the specified component\u003c/li\u003e\u003cli\u003e'Execute analysis' rights on the specified component\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "branch",
      "in": "query",
      "description": "Branch key",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "project",
      "in": "query",
      "description": "Project key",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/new_code_periods/unset": {
   "description": "Manage \u003ca href=\"https://sonar-documentations-preview.netlify.app/sonarqube/project-administration/setting-up-clean-as-you-code/#setting-a-new-code-definition\" target=\"_blank\" rel=\"noopener noreferrer\"\u003enew code definition\u003c/a\u003e.",
   "post": {
    "summary": "unset",
    "description": "Unsets the \u003ca href=\"https://sonar-documentations-preview.netlify.app/sonarqube/project-administration/setting-up-clean-as-you-code/#setting-a-new-code-definition\" target=\"_blank\" rel=\"noopener noreferrer\"\u003enew code definition\u003c/a\u003e 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: \u003cul\u003e\u003cli\u003e'Administer System' to change the global setting\u003c/li\u003e\u003cli\u003e'Administer' rights for a specified component\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "branch",
      "in": "query",
      "description": "Branch key",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "project",
      "in": "query",
      "description": "Project key",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/notifications/add": {
   "description": "Manage notifications of the authenticated user",
   "post": {
    "summary": "add",
    "description": "Add a notification for the authenticated user.\u003cbr\u003eRequires one of the following permissions:\u003cul\u003e \u003cli\u003eAuthentication if no login is provided. If a project is provided, requires the 'Browse' permission on the specified project.\u003c/li\u003e \u003cli\u003eSystem administration if a login is provided. If a project is provided, requires the 'Browse' permission on the specified project.\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "channel",
      "in": "query",
      "description": "Channel through which the notification is sent. For example, notifications can be sent by email.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "login",
      "in": "query",
      "description": "User login",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "project",
      "in": "query",
      "description": "Project key",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "type",
      "in": "query",
      "description": "Notification type. Possible values are for:\u003cul\u003e  \u003cli\u003eGlobal notifications: CeReportTaskFailure, ChangesOnMyIssue, NewAlerts, QualityGateConditionsMismatch, SQ-MyNewIssues\u003c/li\u003e  \u003cli\u003ePer project notifications: CeReportTaskFailure, ChangesOnMyIssue, NewAlerts, NewFalsePositiveIssue, NewIssues, SQ-MyNewIssues\u003c/li\u003e\u003c/ul\u003e",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/notifications/list": {
   "description": "Manage notifications of the authenticated user",
   "get": {
    "summary": "list",
    "description": "List notifications of the authenticated user.\u003cbr\u003eRequires one of the following permissions:\u003cul\u003e  \u003cli\u003eAuthentication if no login is provided\u003c/li\u003e  \u003cli\u003eSystem administration if a login is provided\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "login",
      "in": "query",
      "description": "User login",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/notifications/remove": {
   "description": "Manage notifications of the authenticated user",
   "post": {
    "summary": "remove",
    "description": "Remove a notification for the authenticated user.\u003cbr\u003eRequires one of the following permissions:\u003cul\u003e  \u003cli\u003eAuthentication if no login is provided\u003c/li\u003e  \u003cli\u003eSystem administration if a login is provided\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "channel",
      "in": "query",
      "description": "Channel through which the notification is sent. For example, notifications can be sent by email.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "login",
      "in": "query",
      "description": "User login",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "project",
      "in": "query",
      "description": "Project key",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "type",
      "in": "query",
      "description": "Notification type. Possible values are for:\u003cul\u003e  \u003cli\u003eGlobal notifications: CeReportTaskFailure, ChangesOnMyIssue, NewAlerts, QualityGateConditionsMismatch, SQ-MyNewIssues\u003c/li\u003e  \u003cli\u003ePer project notifications: CeReportTaskFailure, ChangesOnMyIssue, NewAlerts, NewFalsePositiveIssue, NewIssues, SQ-MyNewIssues\u003c/li\u003e\u003c/ul\u003e",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/permissions/add_group": {
   "description": "Manage permission templates, and the granting and revoking of permissions at the global and project levels.",
   "post": {
    "summary": "add group",
    "description": "Add a permission to a group.\u003cbr /\u003e This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.\u003cbr /\u003e The group name must be provided. \u003cbr /\u003eRequires one of the following permissions:\u003cul\u003e\u003cli\u003e'Administer System'\u003c/li\u003e\u003cli\u003e'Administer' rights on the specified project\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "groupName",
      "in": "query",
      "description": "Group name or 'anyone' (case insensitive)",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "permission",
      "in": "query",
      "description": "The permission you would like to grant to the group.\u003cul\u003e\u003cli\u003ePossible values for global permissions: admin, gateadmin, profileadmin, provisioning, scan, applicationcreator, portfoliocreator\u003c/li\u003e\u003cli\u003ePossible values for project permissions admin, codeviewer, issueadmin, securityhotspotadmin, scan, user\u003c/li\u003e\u003c/ul\u003e",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "projectId",
      "in": "query",
      "description": "Project id",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "projectKey",
      "in": "query",
      "description": "Project key",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/permissions/add_group_to_template": {
   "description": "Manage permission templates, and the granting and revoking of permissions at the global and project levels.",
   "post": {
    "summary": "add group to template",
    "description": "Add a group to a permission template.\u003cbr /\u003e The group name must be provided. \u003cbr /\u003eRequires 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": [
     {
      "name": "groupName",
      "in": "query",
      "description": "Group name or 'anyone' (case insensitive)",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "permission",
      "in": "query",
      "description": "Permission\u003cul\u003e\u003cli\u003ePossible values for project permissions admin, codeviewer, issueadmin, securityhotspotadmin, scan, user\u003c/li\u003e\u003c/ul\u003e",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "templateId",
      "in": "query",
      "description": "Template id",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "templateName",
      "in": "query",
      "description": "Template name",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/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": {
    "summary": "add project creator to template",
    "description": "Add a project creator to a permission template.\u003cbr\u003eRequires 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": [
     {
      "name": "permission",
      "in": "query",
      "description": "Permission\u003cul\u003e\u003cli\u003ePossible values for project permissions admin, codeviewer, issueadmin, securityhotspotadmin, scan, user\u003c/li\u003e\u003c/ul\u003e",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "templateId",
      "in": "query",
      "description": "Template id",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "templateName",
      "in": "query",
      "description": "Template name",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/permissions/add_user": {
   "description": "Manage permission templates, and the granting and revoking of permissions at the global and project levels.",
   "post": {
    "summary": "add user",
    "description": "Add permission to a user.\u003cbr /\u003e This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.\u003cbr /\u003eRequires one of the following permissions:\u003cul\u003e\u003cli\u003e'Administer System'\u003c/li\u003e\u003cli\u003e'Administer' rights on the specified project\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "login",
      "in": "query",
      "description": "User login",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "permission",
      "in": "query",
      "description": "The permission you would like to grant to the user\u003cul\u003e\u003cli\u003ePossible values for global permissions: admin, gateadmin, profileadmin, provisioning, scan, applicationcreator, portfoliocreator\u003c/li\u003e\u003cli\u003ePossible values for project permissions admin, codeviewer, issueadmin, securityhotspotadmin, scan, user\u003c/li\u003e\u003c/ul\u003e",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "projectId",
      "in": "query",
      "description": "Project id",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "projectKey",
      "in": "query",
      "description": "Project key",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/permissions/add_user_to_template": {
   "description": "Manage permission templates, and the granting and revoking of permissions at the global and project levels.",
   "post": {
    "summary": "add user to template",
    "description": "Add a user to a permission template.\u003cbr /\u003e 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": [
     {
      "name": "login",
      "in": "query",
      "description": "User login",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "permission",
      "in": "query",
      "description": "Permission\u003cul\u003e\u003cli\u003ePossible values for project permissions admin, codeviewer, issueadmin, securityhotspotadmin, scan, user\u003c/li\u003e\u003c/ul\u003e",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "templateId",
      "in": "query",
      "description": "Template id",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "templateName",
      "in": "query",
      "description": "Template name",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/permissions/apply_template": {
   "description": "Manage permission templates, and the granting and revoking of permissions at the global and project levels.",
   "post": {
    "summary": "apply template",
    "description": "Apply a permission template to one project.\u003cbr\u003eThe project id or project key must be provided.\u003cbr\u003eThe template id or name must be provided.\u003cbr\u003eRequires 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": [
     {
      "name": "projectId",
      "in": "query",
      "description": "Project id",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "projectKey",
      "in": "query",
      "description": "Project key",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "templateId",
      "in": "query",
      "description": "Template id",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "templateName",
      "in": "query",
      "description": "Template name",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/permissions/bulk_apply_template": {
   "description": "Manage permission templates, and the granting and revoking of permissions at the global and project levels.",
   "post": {
    "summary": "bulk apply template",
    "description": "Apply a permission template to several components. Managed projects will be ignored.\u003cbr /\u003eThe template id or name must be provided.\u003cbr /\u003eRequires 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": [
     {
      "name": "analyzedBefore",
      "in": "query",
      "description": "Filter the projects for which last analysis is older than the given date (exclusive).\u003cbr\u003e Either a date (server timezone) or datetime can be provided.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "onProvisionedOnly",
      "in": "query",
      "description": "Filter the projects that are provisioned",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "projects",
      "in": "query",
      "description": "Comma-separated list of project keys",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "q",
      "in": "query",
      "description": "Limit search to: \u003cul\u003e\u003cli\u003eproject names that contain the supplied string\u003c/li\u003e\u003cli\u003eproject keys that are exactly the same as the supplied string\u003c/li\u003e\u003c/ul\u003e",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "qualifiers",
      "in": "query",
      "description": "Comma-separated list of component qualifiers. Filter the results with the specified qualifiers. Possible values are:\u003cul\u003e\u003cli\u003eAPP - Applications\u003c/li\u003e\u003cli\u003eTRK - Projects\u003c/li\u003e\u003cli\u003eVW - Portfolios\u003c/li\u003e\u003c/ul\u003e",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "templateId",
      "in": "query",
      "description": "Template id",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "templateName",
      "in": "query",
      "description": "Template name",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/permissions/create_template": {
   "description": "Manage permission templates, and the granting and revoking of permissions at the global and project levels.",
   "post": {
    "summary": "create template",
    "description": "Create a permission template.\u003cbr /\u003eRequires 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": [
     {
      "name": "description",
      "in": "query",
      "description": "Description",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "name",
      "in": "query",
      "description": "Name",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "projectKeyPattern",
      "in": "query",
      "description": "Project key pattern. Must be a valid Java regular expression",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/permissions/delete_template": {
   "description": "Manage permission templates, and the granting and revoking of permissions at the global and project levels.",
   "post": {
    "summary": "delete template",
    "description": "Delete a permission template.\u003cbr /\u003eRequires 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": [
     {
      "name": "templateId",
      "in": "query",
      "description": "Template id",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "templateName",
      "in": "query",
      "description": "Template name",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/permissions/remove_group": {
   "description": "Manage permission templates, and the granting and revoking of permissions at the global and project levels.",
   "post": {
    "summary": "remove group",
    "description": "Remove a permission from a group.\u003cbr /\u003e This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.\u003cbr /\u003e The group name must be provided.\u003cbr /\u003eRequires one of the following permissions:\u003cul\u003e\u003cli\u003e'Administer System'\u003c/li\u003e\u003cli\u003e'Administer' rights on the specified project\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "groupName",
      "in": "query",
      "description": "Group name or 'anyone' (case insensitive)",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "permission",
      "in": "query",
      "description": "The permission you would like to revoke from the group.\u003cul\u003e\u003cli\u003ePossible values for global permissions: admin, gateadmin, profileadmin, provisioning, scan, applicationcreator, portfoliocreator\u003c/li\u003e\u003cli\u003ePossible values for project permissions admin, codeviewer, issueadmin, securityhotspotadmin, scan, user\u003c/li\u003e\u003c/ul\u003e",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "projectId",
      "in": "query",
      "description": "Project id",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "projectKey",
      "in": "query",
      "description": "Project key",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/permissions/remove_group_from_template": {
   "description": "Manage permission templates, and the granting and revoking of permissions at the global and project levels.",
   "post": {
    "summary": "remove group from template",
    "description": "Remove a group from a permission template.\u003cbr /\u003e The group name must be provided. \u003cbr /\u003eRequires 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": [
     {
      "name": "groupName",
      "in": "query",
      "description": "Group name or 'anyone' (case insensitive)",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "permission",
      "in": "query",
      "description": "Permission\u003cul\u003e\u003cli\u003ePossible values for project permissions admin, codeviewer, issueadmin, securityhotspotadmin, scan, user\u003c/li\u003e\u003c/ul\u003e",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "templateId",
      "in": "query",
      "description": "Template id",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "templateName",
      "in": "query",
      "description": "Template name",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/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": {
    "summary": "remove project creator from template",
    "description": "Remove a project creator from a permission template.\u003cbr\u003eRequires 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": [
     {
      "name": "permission",
      "in": "query",
      "description": "Permission\u003cul\u003e\u003cli\u003ePossible values for project permissions admin, codeviewer, issueadmin, securityhotspotadmin, scan, user\u003c/li\u003e\u003c/ul\u003e",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "templateId",
      "in": "query",
      "description": "Template id",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "templateName",
      "in": "query",
      "description": "Template name",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/permissions/remove_user": {
   "description": "Manage permission templates, and the granting and revoking of permissions at the global and project levels.",
   "post": {
    "summary": "remove user",
    "description": "Remove permission from a user.\u003cbr /\u003e This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.\u003cbr /\u003e Requires one of the following permissions:\u003cul\u003e\u003cli\u003e'Administer System'\u003c/li\u003e\u003cli\u003e'Administer' rights on the specified project\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "login",
      "in": "query",
      "description": "User login",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "permission",
      "in": "query",
      "description": "The permission you would like to revoke from the user.\u003cul\u003e\u003cli\u003ePossible values for global permissions: admin, gateadmin, profileadmin, provisioning, scan, applicationcreator, portfoliocreator\u003c/li\u003e\u003cli\u003ePossible values for project permissions admin, codeviewer, issueadmin, securityhotspotadmin, scan, user\u003c/li\u003e\u003c/ul\u003e",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "projectId",
      "in": "query",
      "description": "Project id",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "projectKey",
      "in": "query",
      "description": "Project key",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/permissions/remove_user_from_template": {
   "description": "Manage permission templates, and the granting and revoking of permissions at the global and project levels.",
   "post": {
    "summary": "remove user from template",
    "description": "Remove a user from a permission template.\u003cbr /\u003e 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": [
     {
      "name": "login",
      "in": "query",
      "description": "User login",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "permission",
      "in": "query",
      "description": "Permission\u003cul\u003e\u003cli\u003ePossible values for project permissions admin, codeviewer, issueadmin, securityhotspotadmin, scan, user\u003c/li\u003e\u003c/ul\u003e",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "templateId",
      "in": "query",
      "description": "Template id",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "templateName",
      "in": "query",
      "description": "Template name",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/permissions/search_templates": {
   "description": "Manage permission templates, and the granting and revoking of permissions at the global and project levels.",
   "get": {
    "summary": "search templates",
    "description": "List permission templates.\u003cbr /\u003eRequires 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": [
     {
      "name": "q",
      "in": "query",
      "description": "Limit search to permission template names that contain the supplied string.",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/permissions/set_default_template": {
   "description": "Manage permission templates, and the granting and revoking of permissions at the global and project levels.",
   "post": {
    "summary": "set default template",
    "description": "Set a permission template as default.\u003cbr /\u003eRequires 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": [
     {
      "name": "qualifier",
      "in": "query",
      "description": "Project qualifier. Filter the results with the specified qualifier. Possible values are:\u003cul\u003e\u003cli\u003eAPP - Applications\u003c/li\u003e\u003cli\u003eTRK - Projects\u003c/li\u003e\u003cli\u003eVW - Portfolios\u003c/li\u003e\u003c/ul\u003e",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "templateId",
      "in": "query",
      "description": "Template id",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "templateName",
      "in": "query",
      "description": "Template name",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/permissions/update_template": {
   "description": "Manage permission templates, and the granting and revoking of permissions at the global and project levels.",
   "post": {
    "summary": "update template",
    "description": "Update a permission template.\u003cbr /\u003eRequires 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": [
     {
      "name": "description",
      "in": "query",
      "description": "Description",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "id",
      "in": "query",
      "description": "Id",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "name",
      "in": "query",
      "description": "Name",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "projectKeyPattern",
      "in": "query",
      "description": "Project key pattern. Must be a valid Java regular expression",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/plugins/available": {
   "description": "Manage the plugins on the server, including installing, uninstalling, and upgrading.",
   "get": {
    "summary": "available",
    "description": "Get the list of all the plugins available for installation on the SonarQube instance, sorted by plugin name.\u003cbr/\u003ePlugin information is retrieved from Update Center. Date and time at which Update Center was last refreshed is provided in the response.\u003cbr/\u003eUpdate status values are: \u003cul\u003e\u003cli\u003eCOMPATIBLE: plugin is compatible with current SonarQube instance.\u003c/li\u003e\u003cli\u003eINCOMPATIBLE: plugin is not compatible with current SonarQube instance.\u003c/li\u003e\u003cli\u003eREQUIRES_SYSTEM_UPGRADE: plugin requires SonarQube to be upgraded before being installed.\u003c/li\u003e\u003cli\u003eDEPS_REQUIRE_SYSTEM_UPGRADE: at least one plugin on which the plugin is dependent requires SonarQube to be upgraded.\u003c/li\u003e\u003c/ul\u003eRequire '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": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/plugins/cancel_all": {
   "description": "Manage the plugins on the server, including installing, uninstalling, and upgrading.",
   "post": {
    "summary": "cancel all",
    "description": "Cancels any operation pending on any plugin (install, update or uninstall)\u003cbr/\u003eRequires 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": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/plugins/install": {
   "description": "Manage the plugins on the server, including installing, uninstalling, and upgrading.",
   "post": {
    "summary": "install",
    "description": "Installs the latest version of a plugin specified by its key.\u003cbr/\u003ePlugin information is retrieved from Update Center.\u003cbr/\u003eFails if used on commercial editions or plugin risk consent has not been accepted.\u003cbr/\u003eRequires 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": [
     {
      "name": "key",
      "in": "query",
      "description": "The key identifying the plugin to install",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/plugins/installed": {
   "description": "Manage the plugins on the server, including installing, uninstalling, and upgrading.",
   "get": {
    "summary": "installed",
    "description": "Get the list of all the plugins installed on the SonarQube instance, sorted by plugin name.\u003cbr/\u003eRequires 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": [
     {
      "name": "f",
      "in": "query",
      "description": "Comma-separated list of the additional fields to be returned in response. No additional field is returned by default. Possible values are:\u003cul\u003e\u003cli\u003ecategory - category as defined in the Update Center. A connection to the Update Center is needed\u003c/li\u003e\u003c/ul\u003e",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/plugins/pending": {
   "description": "Manage the plugins on the server, including installing, uninstalling, and upgrading.",
   "get": {
    "summary": "pending",
    "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.\u003cbr/\u003eRequire '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": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/plugins/uninstall": {
   "description": "Manage the plugins on the server, including installing, uninstalling, and upgrading.",
   "post": {
    "summary": "uninstall",
    "description": "Uninstalls the plugin specified by its key.\u003cbr/\u003eRequires 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": [
     {
      "name": "key",
      "in": "query",
      "description": "The key identifying the plugin to uninstall",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/plugins/update": {
   "description": "Manage the plugins on the server, including installing, uninstalling, and upgrading.",
   "post": {
    "summary": "update",
    "description": "Updates a plugin specified by its key to the latest version compatible with the SonarQube instance.\u003cbr/\u003ePlugin information is retrieved from Update Center.\u003cbr/\u003eRequires 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": [
     {
      "name": "key",
      "in": "query",
      "description": "The key identifying the plugin to update",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/plugins/updates": {
   "description": "Manage the plugins on the server, including installing, uninstalling, and upgrading.",
   "get": {
    "summary": "updates",
    "description": "Lists plugins installed on the SonarQube instance for which at least one newer version is available, sorted by plugin name.\u003cbr/\u003eEach newer version is listed, ordered from the oldest to the newest, with its own update/compatibility status.\u003cbr/\u003ePlugin information is retrieved from Update Center. Date and time at which Update Center was last refreshed is provided in the response.\u003cbr/\u003eUpdate status values are: [COMPATIBLE, INCOMPATIBLE, REQUIRES_UPGRADE, DEPS_REQUIRE_UPGRADE].\u003cbr/\u003eRequire '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": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/project_analyses/create_event": {
   "description": "Manage project analyses.",
   "post": {
    "summary": "create event",
    "description": "Create a project analysis event.\u003cbr\u003eOnly event of category 'VERSION' and 'OTHER' can be created.\u003cbr\u003eRequires one of the following permissions:\u003cul\u003e  \u003cli\u003e'Administer System'\u003c/li\u003e  \u003cli\u003e'Administer' rights on the specified project\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "analysis",
      "in": "query",
      "description": "Analysis key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "category",
      "in": "query",
      "description": "Category",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "name",
      "in": "query",
      "description": "Name",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/project_analyses/delete": {
   "description": "Manage project analyses.",
   "post": {
    "summary": "delete",
    "description": "Delete a project analysis.\u003cbr\u003eRequires one of the following permissions:\u003cul\u003e  \u003cli\u003e'Administer System'\u003c/li\u003e  \u003cli\u003e'Administer' rights on the project of the specified analysis\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "analysis",
      "in": "query",
      "description": "Analysis key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/project_analyses/delete_event": {
   "description": "Manage project analyses.",
   "post": {
    "summary": "delete event",
    "description": "Delete a project analysis event.\u003cbr\u003eOnly event of category 'VERSION' and 'OTHER' can be deleted.\u003cbr\u003eRequires one of the following permissions:\u003cul\u003e  \u003cli\u003e'Administer System'\u003c/li\u003e  \u003cli\u003e'Administer' rights on the specified project\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "event",
      "in": "query",
      "description": "Event key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/project_analyses/search": {
   "description": "Manage project analyses.",
   "get": {
    "summary": "search",
    "description": "Search a project analyses and attached events.\u003cbr\u003eRequires the following permission: 'Browse' on the specified project. \u003cbr\u003eFor 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": [
     {
      "name": "category",
      "in": "query",
      "description": "Event category. Filter analyses that have at least one event of the category specified.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "from",
      "in": "query",
      "description": "Filter analyses created after the given date (inclusive). \u003cbr\u003eEither a date (server timezone) or datetime can be provided",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "p",
      "in": "query",
      "description": "1-based page number",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "project",
      "in": "query",
      "description": "Project key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "ps",
      "in": "query",
      "description": "Page size. Must be greater than 0 and less or equal than 500",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "to",
      "in": "query",
      "description": "Filter analyses created before the given date (inclusive). \u003cbr\u003eEither a date (server timezone) or datetime can be provided",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/project_analyses/update_event": {
   "description": "Manage project analyses.",
   "post": {
    "summary": "update event",
    "description": "Update a project analysis event.\u003cbr\u003eOnly events of category 'VERSION' and 'OTHER' can be updated.\u003cbr\u003eRequires one of the following permissions:\u003cul\u003e  \u003cli\u003e'Administer System'\u003c/li\u003e  \u003cli\u003e'Administer' rights on the specified project\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "event",
      "in": "query",
      "description": "Event key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "name",
      "in": "query",
      "description": "New name",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/project_badges/ai_code_assurance": {
   "description": "Generate badges based on quality gates or measures",
   "get": {
    "summary": "ai code assurance",
    "description": "Generate a badge for project's AI assurance as an SVG.\u003cbr/\u003eRequires '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": [
     {
      "name": "project",
      "in": "query",
      "description": "Project or application key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "token",
      "in": "query",
      "description": "Project badge token",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/project_badges/measure": {
   "description": "Generate badges based on quality gates or measures",
   "get": {
    "summary": "measure",
    "description": "Generate badge for project's measure as an SVG.\u003cbr/\u003eRequires '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": [
     {
      "name": "branch",
      "in": "query",
      "description": "Branch key",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "metric",
      "in": "query",
      "description": "Metric key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "project",
      "in": "query",
      "description": "Project or application key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "token",
      "in": "query",
      "description": "Project badge token",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/project_badges/quality_gate": {
   "description": "Generate badges based on quality gates or measures",
   "get": {
    "summary": "quality gate",
    "description": "Generate badge for project's quality gate as an SVG.\u003cbr/\u003eRequires '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": [
     {
      "name": "branch",
      "in": "query",
      "description": "Branch key",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "project",
      "in": "query",
      "description": "Project or application key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "token",
      "in": "query",
      "description": "Project badge token",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/project_badges/renew_token": {
   "description": "Generate badges based on quality gates or measures",
   "post": {
    "summary": "renew token",
    "description": "Creates new token replacing any existing token for project or application badge access for private projects and applications.\u003cbr/\u003eThis token can be used to authenticate with api/project_badges/quality_gate and api/project_badges/measure endpoints.\u003cbr/\u003eRequires '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": [
     {
      "name": "project",
      "in": "query",
      "description": "Project or application key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/project_badges/token": {
   "description": "Generate badges based on quality gates or measures",
   "get": {
    "summary": "token",
    "description": "Retrieve a token to use for project or application badge access for private projects or applications.\u003cbr/\u003eThis token can be used to authenticate with api/project_badges/quality_gate and api/project_badges/measure endpoints.\u003cbr/\u003eRequires '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": [
     {
      "name": "project",
      "in": "query",
      "description": "Project or application key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/project_branches/delete": {
   "description": "Manage branch",
   "post": {
    "summary": "delete",
    "description": "Delete a non-main branch of a project or application.\u003cbr/\u003eRequires '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": [
     {
      "name": "branch",
      "in": "query",
      "description": "Branch key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "project",
      "in": "query",
      "description": "Project key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/project_branches/list": {
   "description": "Manage branch",
   "get": {
    "summary": "list",
    "description": "List the branches of a project or application.\u003cbr/\u003eRequires '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": [
     {
      "name": "project",
      "in": "query",
      "description": "Project key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/project_branches/rename": {
   "description": "Manage branch",
   "post": {
    "summary": "rename",
    "description": "Rename the main branch of a project or application.\u003cbr/\u003eRequires '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": [
     {
      "name": "name",
      "in": "query",
      "description": "New name of the main branch",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "project",
      "in": "query",
      "description": "Project key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/project_branches/set_automatic_deletion_protection": {
   "description": "Manage branch",
   "post": {
    "summary": "set automatic deletion protection",
    "description": "Protect a specific branch from automatic deletion. Protection can't be disabled for the main branch.\u003cbr/\u003eRequires '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": [
     {
      "name": "branch",
      "in": "query",
      "description": "Branch key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "project",
      "in": "query",
      "description": "Project key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "value",
      "in": "query",
      "description": "Sets whether the branch should be protected from automatic deletion when it hasn't been analyzed for a set period of time.",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/project_branches/set_main": {
   "description": "Manage branch",
   "post": {
    "summary": "set main",
    "description": "Allow to set a new main branch.\u003cbr/\u003e. Caution, only applicable on projects.\u003cbr\u003eRequires '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": [
     {
      "name": "branch",
      "in": "query",
      "description": "Branch key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "project",
      "in": "query",
      "description": "Project key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/project_dump/export": {
   "description": "Project export/import",
   "post": {
    "summary": "export",
    "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": [
     {
      "name": "key",
      "in": "query",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/project_dump/import": {
   "description": "Project export/import",
   "post": {
    "summary": "import",
    "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": [
     {
      "name": "key",
      "in": "query",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/project_links/create": {
   "description": "Manage projects links.",
   "post": {
    "summary": "create",
    "description": "Create a new project link.\u003cbr\u003eRequires '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": [
     {
      "name": "name",
      "in": "query",
      "description": "Link name",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "projectId",
      "in": "query",
      "description": "Project id",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "projectKey",
      "in": "query",
      "description": "Project key",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "url",
      "in": "query",
      "description": "Link url",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/project_links/delete": {
   "description": "Manage projects links.",
   "post": {
    "summary": "delete",
    "description": "Delete existing project link.\u003cbr\u003eRequires '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": [
     {
      "name": "id",
      "in": "query",
      "description": "Link id",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/project_links/search": {
   "description": "Manage projects links.",
   "get": {
    "summary": "search",
    "description": "List links of a project.\u003cbr\u003eThe 'projectId' or 'projectKey' must be provided.\u003cbr\u003eRequires one of the following permissions:\u003cul\u003e\u003cli\u003e'Administer System'\u003c/li\u003e\u003cli\u003e'Administer' rights on the specified project\u003c/li\u003e\u003cli\u003e'Browse' on the specified project\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "projectId",
      "in": "query",
      "description": "Project Id",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "projectKey",
      "in": "query",
      "description": "Project Key",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/project_pull_requests/delete": {
   "description": "Manage pull request",
   "post": {
    "summary": "delete",
    "description": "Delete a pull request.\u003cbr/\u003eRequires '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": [
     {
      "name": "project",
      "in": "query",
      "description": "Project key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "pullRequest",
      "in": "query",
      "description": "Pull request id",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/project_pull_requests/list": {
   "description": "Manage pull request",
   "get": {
    "summary": "list",
    "description": "List the pull requests of a project.\u003cbr/\u003eOne of the following permissions is required: \u003cul\u003e\u003cli\u003e'Browse' rights on the specified project\u003c/li\u003e\u003cli\u003e'Execute Analysis' rights on the specified project\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "project",
      "in": "query",
      "description": "Project key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/project_tags/search": {
   "description": "Manage project tags",
   "get": {
    "summary": "search",
    "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": [
     {
      "name": "p",
      "in": "query",
      "description": "1-based page number",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "ps",
      "in": "query",
      "description": "Page size. Must be greater than 0 and less or equal than 100",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "q",
      "in": "query",
      "description": "Limit search to tags that contain the supplied string.",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/project_tags/set": {
   "description": "Manage project tags",
   "post": {
    "summary": "set",
    "description": "Set tags on a project.\u003cbr\u003eRequires 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": [
     {
      "name": "project",
      "in": "query",
      "description": "Project key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "tags",
      "in": "query",
      "description": "Comma-separated list of tags",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/projects/bulk_delete": {
   "description": "Manage project existence.",
   "post": {
    "summary": "bulk delete",
    "description": "Delete one or several projects.\u003cbr /\u003eOnly the 1'000 first items in project filters are taken into account.\u003cbr /\u003eRequires 'Administer System' permission.\u003cbr /\u003eAt 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": [
     {
      "name": "analyzedBefore",
      "in": "query",
      "description": "Filter the projects for which last analysis of any branch is older than the given date (exclusive).\u003cbr\u003e Either a date (server timezone) or datetime can be provided.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "onProvisionedOnly",
      "in": "query",
      "description": "Filter the projects that are provisioned",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "projects",
      "in": "query",
      "description": "Comma-separated list of project keys",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "q",
      "in": "query",
      "description": "Limit to: \u003cul\u003e\u003cli\u003ecomponent names that contain the supplied string\u003c/li\u003e\u003cli\u003ecomponent keys that contain the supplied string\u003c/li\u003e\u003c/ul\u003e",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "qualifiers",
      "in": "query",
      "description": "Comma-separated list of component qualifiers. Filter the results with the specified qualifiers",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/projects/create": {
   "description": "Manage project existence.",
   "post": {
    "summary": "create",
    "description": "Create a project.\u003cbr/\u003eIf 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.\u003cbr/\u003e",
    "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": [
     {
      "name": "mainBranch",
      "in": "query",
      "description": "Key of the main branch of the project. If not provided, the default main branch key will be used.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "name",
      "in": "query",
      "description": "Name of the project. If name is longer than 500, it is abbreviated.",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "newCodeDefinitionType",
      "in": "query",
      "description": "Project New Code Definition Type\u003cbr/\u003eNew code definitions of the following types are allowed:\u003cul\u003e\u003cli\u003ePREVIOUS_VERSION\u003c/li\u003e\u003cli\u003eNUMBER_OF_DAYS\u003c/li\u003e\u003cli\u003eREFERENCE_BRANCH - will default to the main branch.\u003c/li\u003e\u003c/ul\u003e",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "newCodeDefinitionValue",
      "in": "query",
      "description": "Project New Code Definition Value\u003cbr/\u003eFor each new code definition type, a different value is expected:\u003cul\u003e\u003cli\u003eno value, when the new code definition type is PREVIOUS_VERSION and REFERENCE_BRANCH\u003c/li\u003e\u003cli\u003ea number between 1 and 90, when the new code definition type is NUMBER_OF_DAYS\u003c/li\u003e\u003c/ul\u003e",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "project",
      "in": "query",
      "description": "Key of the project",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "visibility",
      "in": "query",
      "description": "Whether the created project should be visible to everyone, or only specific user/groups.\u003cbr/\u003eIf no visibility is specified, the default project visibility will be used.",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/projects/delete": {
   "description": "Manage project existence.",
   "post": {
    "summary": "delete",
    "description": "Delete a project.\u003cbr\u003e 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": [
     {
      "name": "project",
      "in": "query",
      "description": "Project key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/projects/export_findings": {
   "description": "Manage project existence.",
   "get": {
    "summary": "export findings",
    "description": "Export all findings (issues and hotspots) of a specific project branch.\u003cbr/\u003eRequires '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": [
     {
      "name": "branch",
      "in": "query",
      "description": "Branch key. When not specified, if no Pull Request key is defined either, it will default to the main branch",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "project",
      "in": "query",
      "description": "Project key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "pullRequest",
      "in": "query",
      "description": "Pull Request key. When not specified, the branch data will be returned instead",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/projects/get_contains_ai_code": {
   "description": "Manage project existence.",
   "get": {
    "summary": "get contains ai code",
    "description": "Get whether a project contains AI code or not",
    "externalDocs": {
     "description": "Sonarqube Documentation for get_contains_ai_code",
     "url": "https://next.sonarqube.com/sonarqube/web_api/api/api/projects/get_contains_ai_code"
    },
    "operationId": "v1_post_api_projects_get_contains_ai_code",
    "parameters": [
     {
      "name": "project",
      "in": "query",
      "description": "Project key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/projects/license_usage": {
   "description": "Manage project existence.",
   "get": {
    "summary": "license usage",
    "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.\u003cbr/\u003eRequires 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": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/projects/search": {
   "description": "Manage project existence.",
   "get": {
    "summary": "search",
    "description": "Search for projects or views to administrate them.\n\u003cul\u003e\n  \u003cli\u003eThe response field 'lastAnalysisDate' takes into account the analysis of all branches and pull requests, not only the main branch.\u003c/li\u003e\n  \u003cli\u003eThe response field 'revision' takes into account the analysis of the main branch only.\u003c/li\u003e\n\u003c/ul\u003e\nRequires '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": [
     {
      "name": "analyzedBefore",
      "in": "query",
      "description": "Filter the projects for which the last analysis of all branches are older than the given date (exclusive).\u003cbr\u003e Either a date (server timezone) or datetime can be provided.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "onProvisionedOnly",
      "in": "query",
      "description": "Filter the projects that are provisioned",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "p",
      "in": "query",
      "description": "1-based page number",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "projects",
      "in": "query",
      "description": "Comma-separated list of project keys",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "ps",
      "in": "query",
      "description": "Page size. Must be greater than 0 and less or equal than 500",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "q",
      "in": "query",
      "description": "Limit search to: \u003cul\u003e\u003cli\u003ecomponent names that contain the supplied string\u003c/li\u003e\u003cli\u003ecomponent keys that contain the supplied string\u003c/li\u003e\u003c/ul\u003e",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "qualifiers",
      "in": "query",
      "description": "Comma-separated list of component qualifiers. Filter the results with the specified qualifiers",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/projects/set_contains_ai_code": {
   "description": "Manage project existence.",
   "post": {
    "summary": "set contains ai code",
    "description": "Sets if the project passed as parameter contains or not AI code according to the value of the contains_ai_code parameter.\u003cbr/\u003eRequires 'Administer' rights on the specified project.",
    "externalDocs": {
     "description": "Sonarqube Documentation for set_contains_ai_code",
     "url": "https://next.sonarqube.com/sonarqube/web_api/api/api/projects/set_contains_ai_code"
    },
    "operationId": "v1_get_api_projects_set_contains_ai_code",
    "parameters": [
     {
      "name": "contains_ai_code",
      "in": "query",
      "description": "Flag to set whether the project contains AI code or not.",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "project",
      "in": "query",
      "description": "Project key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/projects/update_key": {
   "description": "Manage project existence.",
   "post": {
    "summary": "update key",
    "description": "Update a project all its sub-components keys.\u003cbr\u003eRequires '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": [
     {
      "name": "from",
      "in": "query",
      "description": "Project key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "to",
      "in": "query",
      "description": "New project key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/projects/update_visibility": {
   "description": "Manage project existence.",
   "post": {
    "summary": "update visibility",
    "description": "Updates visibility of a project, application or a portfolio.\u003cbr\u003eRequires '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": [
     {
      "name": "project",
      "in": "query",
      "description": "Project, application or portfolio key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "visibility",
      "in": "query",
      "description": "New visibility",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualitygates/add_group": {
   "description": "Manage quality gates, including conditions and project association.",
   "post": {
    "summary": "add group",
    "description": "Allow a group of users to edit a Quality Gate.\u003cbr\u003eRequires one of the following permissions:\u003cul\u003e  \u003cli\u003e'Administer Quality Gates'\u003c/li\u003e  \u003cli\u003eEdit right on the specified quality gate\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "gateName",
      "in": "query",
      "description": "Quality Gate name",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "groupName",
      "in": "query",
      "description": "Group name or 'anyone' (case insensitive)",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualitygates/add_user": {
   "description": "Manage quality gates, including conditions and project association.",
   "post": {
    "summary": "add user",
    "description": "Allow a user to edit a Quality Gate.\u003cbr\u003eRequires one of the following permissions:\u003cul\u003e  \u003cli\u003e'Administer Quality Gates'\u003c/li\u003e  \u003cli\u003eEdit right on the specified quality gate\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "gateName",
      "in": "query",
      "description": "Quality Gate name",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "login",
      "in": "query",
      "description": "User login",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualitygates/copy": {
   "description": "Manage quality gates, including conditions and project association.",
   "post": {
    "summary": "copy",
    "description": "Copy a Quality Gate.\u003cbr\u003e'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": [
     {
      "name": "name",
      "in": "query",
      "description": "The name of the quality gate to create",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "sourceName",
      "in": "query",
      "description": "The name of the quality gate to copy",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualitygates/create": {
   "description": "Manage quality gates, including conditions and project association.",
   "post": {
    "summary": "create",
    "description": "Create a Quality Gate.\u003cbr\u003eRequires 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": [
     {
      "name": "name",
      "in": "query",
      "description": "The name of the quality gate to create",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualitygates/create_condition": {
   "description": "Manage quality gates, including conditions and project association.",
   "post": {
    "summary": "create condition",
    "description": "Add a new condition to a quality gate.\u003cbr\u003eParameter '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": [
     {
      "name": "error",
      "in": "query",
      "description": "Condition error threshold",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "gateName",
      "in": "query",
      "description": "Name of the quality gate",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "metric",
      "in": "query",
      "description": "Condition metric.\u003cbr/\u003e Only metric of the following types are allowed:\u003cul\u003e\u003cli\u003eINT\u003c/li\u003e\u003cli\u003eMILLISEC\u003c/li\u003e\u003cli\u003eRATING\u003c/li\u003e\u003cli\u003eWORK_DUR\u003c/li\u003e\u003cli\u003eFLOAT\u003c/li\u003e\u003cli\u003ePERCENT\u003c/li\u003e\u003cli\u003eLEVEL\u003c/li\u003e\u003c/ul\u003eFollowing metrics are forbidden:\u003cul\u003e\u003cli\u003enew_security_hotspots\u003c/li\u003e\u003cli\u003esecurity_hotspots\u003c/li\u003e\u003cli\u003ealert_status\u003c/li\u003e\u003c/ul\u003e",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "op",
      "in": "query",
      "description": "Condition operator:\u003cbr/\u003e\u003cul\u003e\u003cli\u003eLT = is lower than\u003c/li\u003e\u003cli\u003eGT = is greater than\u003c/li\u003e\u003c/ul\u003e",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualitygates/delete_condition": {
   "description": "Manage quality gates, including conditions and project association.",
   "post": {
    "summary": "delete condition",
    "description": "Delete a condition from a quality gate.\u003cbr\u003eRequires 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": [
     {
      "name": "id",
      "in": "query",
      "description": "Condition UUID",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualitygates/deselect": {
   "description": "Manage quality gates, including conditions and project association.",
   "post": {
    "summary": "deselect",
    "description": "Remove the association of a project from a quality gate.\u003cbr\u003eRequires one of the following permissions:\u003cul\u003e\u003cli\u003e'Administer Quality Gates'\u003c/li\u003e\u003cli\u003e'Administer' rights on the project\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "projectKey",
      "in": "query",
      "description": "Project key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualitygates/destroy": {
   "description": "Manage quality gates, including conditions and project association.",
   "post": {
    "summary": "destroy",
    "description": "Delete a Quality Gate.\u003cbr\u003eParameter '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": [
     {
      "name": "name",
      "in": "query",
      "description": "Name of the quality gate to delete",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualitygates/get_by_project": {
   "description": "Manage quality gates, including conditions and project association.",
   "get": {
    "summary": "get by project",
    "description": "Get the quality gate of a project.\u003cbr /\u003eRequires one of the following permissions:\u003cul\u003e\u003cli\u003e'Administer System'\u003c/li\u003e\u003cli\u003e'Administer' rights on the specified project\u003c/li\u003e\u003cli\u003e'Browse' on the specified project\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "project",
      "in": "query",
      "description": "Project key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualitygates/list": {
   "description": "Manage quality gates, including conditions and project association.",
   "get": {
    "summary": "list",
    "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": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualitygates/project_status": {
   "description": "Manage quality gates, including conditions and project association.",
   "get": {
    "summary": "project status",
    "description": "Get the quality gate status of a project or a Compute Engine task.\u003cbr /\u003eEither 'analysisId', 'projectId' or 'projectKey' must be provided \u003cbr /\u003eThe different statuses returned are: OK, WARN, ERROR, NONE. The NONE status is returned when there is no quality gate associated with the analysis.\u003cbr /\u003eReturns an HTTP code 404 if the analysis associated with the task is not found or does not exist.\u003cbr /\u003eRequires one of the following permissions:\u003cul\u003e\u003cli\u003e'Administer System'\u003c/li\u003e\u003cli\u003e'Administer' rights on the specified project\u003c/li\u003e\u003cli\u003e'Browse' on the specified project\u003c/li\u003e\u003cli\u003e'Execute Analysis' on the specified project\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "analysisId",
      "in": "query",
      "description": "Analysis id",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "branch",
      "in": "query",
      "description": "Branch key",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "projectId",
      "in": "query",
      "description": "Project UUID. Doesn't work with branches or pull requests",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "projectKey",
      "in": "query",
      "description": "Project key",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "pullRequest",
      "in": "query",
      "description": "Pull request id",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualitygates/remove_group": {
   "description": "Manage quality gates, including conditions and project association.",
   "post": {
    "summary": "remove group",
    "description": "Remove the ability from a group to edit a Quality Gate.\u003cbr\u003eRequires one of the following permissions:\u003cul\u003e  \u003cli\u003e'Administer Quality Gates'\u003c/li\u003e  \u003cli\u003eEdit right on the specified quality gate\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "gateName",
      "in": "query",
      "description": "Quality Gate name",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "groupName",
      "in": "query",
      "description": "Group name or 'anyone' (case insensitive)",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualitygates/remove_user": {
   "description": "Manage quality gates, including conditions and project association.",
   "post": {
    "summary": "remove user",
    "description": "Remove the ability from an user to edit a Quality Gate.\u003cbr\u003eRequires one of the following permissions:\u003cul\u003e  \u003cli\u003e'Administer Quality Gates'\u003c/li\u003e  \u003cli\u003eEdit right on the specified quality gate\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "gateName",
      "in": "query",
      "description": "Quality Gate name",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "login",
      "in": "query",
      "description": "User login",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualitygates/rename": {
   "description": "Manage quality gates, including conditions and project association.",
   "post": {
    "summary": "rename",
    "description": "Rename a Quality Gate.\u003cbr\u003e'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": [
     {
      "name": "currentName",
      "in": "query",
      "description": "Current name of the quality gate",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "name",
      "in": "query",
      "description": "New name of the quality gate",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualitygates/search": {
   "description": "Manage quality gates, including conditions and project association.",
   "get": {
    "summary": "search",
    "description": "Search for projects associated (or not) to a quality gate.\u003cbr/\u003eOnly 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": [
     {
      "name": "gateName",
      "in": "query",
      "description": "Quality Gate name",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "page",
      "in": "query",
      "description": "Page number",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "pageSize",
      "in": "query",
      "description": "Page size",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "query",
      "in": "query",
      "description": "To search for projects containing this string. If this parameter is set, \"selected\" is set to \"all\".",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "selected",
      "in": "query",
      "description": "Depending on the value, show only selected items (selected=selected), deselected items (selected=deselected), or all items with their selection status (selected=all).",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualitygates/search_groups": {
   "description": "Manage quality gates, including conditions and project association.",
   "get": {
    "summary": "search groups",
    "description": "List the groups that are allowed to edit a Quality Gate.\u003cbr\u003eRequires one of the following permissions:\u003cul\u003e  \u003cli\u003e'Administer Quality Gates'\u003c/li\u003e  \u003cli\u003eEdit right on the specified quality gate\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "gateName",
      "in": "query",
      "description": "Quality Gate name",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "p",
      "in": "query",
      "description": "1-based page number",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "ps",
      "in": "query",
      "description": "Page size. Must be greater than 0.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "q",
      "in": "query",
      "description": "Limit search to group names that contain the supplied string.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "selected",
      "in": "query",
      "description": "Depending on the value, show only selected items (selected=selected), deselected items (selected=deselected), or all items with their selection status (selected=all).",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualitygates/search_users": {
   "description": "Manage quality gates, including conditions and project association.",
   "get": {
    "summary": "search users",
    "description": "List the users that are allowed to edit a Quality Gate.\u003cbr\u003eRequires one of the following permissions:\u003cul\u003e  \u003cli\u003e'Administer Quality Gates'\u003c/li\u003e  \u003cli\u003eEdit right on the specified quality gate\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "gateName",
      "in": "query",
      "description": "Quality Gate name",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "p",
      "in": "query",
      "description": "1-based page number",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "ps",
      "in": "query",
      "description": "Page size. Must be greater than 0.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "q",
      "in": "query",
      "description": "Limit search to names or logins that contain the supplied string.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "selected",
      "in": "query",
      "description": "Depending on the value, show only selected items (selected=selected), deselected items (selected=deselected), or all items with their selection status (selected=all).",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualitygates/select": {
   "description": "Manage quality gates, including conditions and project association.",
   "post": {
    "summary": "select",
    "description": "Associate a project to a quality gate.\u003cbr\u003eRequires one of the following permissions:\u003cul\u003e  \u003cli\u003e'Administer Quality Gates'\u003c/li\u003e  \u003cli\u003e'Administer' right on the specified project\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "gateName",
      "in": "query",
      "description": "Name of the quality gate",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "projectKey",
      "in": "query",
      "description": "Project key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualitygates/set_as_default": {
   "description": "Manage quality gates, including conditions and project association.",
   "post": {
    "summary": "set as default",
    "description": "Set a quality gate as the default quality gate.\u003cbr\u003eParameter '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": [
     {
      "name": "name",
      "in": "query",
      "description": "Name of the quality gate to set as default",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualitygates/show": {
   "description": "Manage quality gates, including conditions and project association.",
   "get": {
    "summary": "show",
    "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": [
     {
      "name": "name",
      "in": "query",
      "description": "Name of the quality gate. Either id or name must be set",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualitygates/update_condition": {
   "description": "Manage quality gates, including conditions and project association.",
   "post": {
    "summary": "update condition",
    "description": "Update a condition attached to a quality gate.\u003cbr\u003eRequires 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": [
     {
      "name": "error",
      "in": "query",
      "description": "Condition error threshold",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "id",
      "in": "query",
      "description": "Condition ID",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "metric",
      "in": "query",
      "description": "Condition metric.\u003cbr/\u003e Only metric of the following types are allowed:\u003cul\u003e\u003cli\u003eINT\u003c/li\u003e\u003cli\u003eMILLISEC\u003c/li\u003e\u003cli\u003eRATING\u003c/li\u003e\u003cli\u003eWORK_DUR\u003c/li\u003e\u003cli\u003eFLOAT\u003c/li\u003e\u003cli\u003ePERCENT\u003c/li\u003e\u003cli\u003eLEVEL\u003c/li\u003e\u003c/ul\u003eFollowing metrics are forbidden:\u003cul\u003e\u003cli\u003enew_security_hotspots\u003c/li\u003e\u003cli\u003esecurity_hotspots\u003c/li\u003e\u003cli\u003ealert_status\u003c/li\u003e\u003c/ul\u003e",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "op",
      "in": "query",
      "description": "Condition operator:\u003cbr/\u003e\u003cul\u003e\u003cli\u003eLT = is lower than\u003c/li\u003e\u003cli\u003eGT = is greater than\u003c/li\u003e\u003c/ul\u003e",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualityprofiles/activate_rule": {
   "description": "Manage quality profiles.",
   "post": {
    "summary": "activate rule",
    "description": "Activate a rule on a Quality Profile.\u003cbr\u003e Requires one of the following permissions:\u003cul\u003e  \u003cli\u003e'Administer Quality Profiles'\u003c/li\u003e  \u003cli\u003eEdit right on the specified quality profile\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "impacts",
      "in": "query",
      "description": "Override of impact severities for the rule. Cannot be used as the same time as 'severity'. Ignored if parameter reset is true.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "key",
      "in": "query",
      "description": "Quality Profile key. Can be obtained through \u003ccode\u003eapi/qualityprofiles/search\u003c/code\u003e",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "params",
      "in": "query",
      "description": "Parameters as semi-colon list of \u003ccode\u003ekey=value\u003c/code\u003e. Ignored if parameter reset is true.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "prioritizedRule",
      "in": "query",
      "description": "Mark activated rule as prioritized, so all corresponding Issues will have to be fixed.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "reset",
      "in": "query",
      "description": "Reset severity and parameters of activated rule. Set the values defined on parent profile or from rule default values.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "rule",
      "in": "query",
      "description": "Rule key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "severity",
      "in": "query",
      "description": "Severity. Cannot be used as the same time as 'impacts'.Ignored if parameter reset is true.",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualityprofiles/activate_rules": {
   "description": "Manage quality profiles.",
   "post": {
    "summary": "activate rules",
    "description": "Bulk-activate rules on one quality profile.\u003cbr\u003e Requires one of the following permissions:\u003cul\u003e  \u003cli\u003e'Administer Quality Profiles'\u003c/li\u003e  \u003cli\u003eEdit right on the specified quality profile\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "activation",
      "in": "query",
      "description": "Filter rules that are activated or deactivated on the selected Quality profile. Ignored if the parameter 'qprofile' is not set.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "active_impactSeverities",
      "in": "query",
      "description": "Comma-separated list of Activation Software Quality Severities, i.e the impact severity of rules in Quality profiles.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "active_severities",
      "in": "query",
      "description": "Comma-separated list of activation severities, i.e the severity of rules in Quality profiles.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "asc",
      "in": "query",
      "description": "Ascending sort",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "available_since",
      "in": "query",
      "description": "Filters rules added since date. Format is yyyy-MM-dd",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "cleanCodeAttributeCategories",
      "in": "query",
      "description": "Comma-separated list of Clean Code Attribute Categories",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "cwe",
      "in": "query",
      "description": "Comma-separated list of CWE identifiers. Use 'unknown' to select rules not associated to any CWE.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "impactSeverities",
      "in": "query",
      "description": "Comma-separated list of Software Quality Severities",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "impactSoftwareQualities",
      "in": "query",
      "description": "Comma-separated list of Software Qualities",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "inheritance",
      "in": "query",
      "description": "Comma-separated list of values of inheritance for a rule within a quality profile. Used only if the parameter 'activation' is set.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "is_template",
      "in": "query",
      "description": "Filter template rules",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "languages",
      "in": "query",
      "description": "Comma-separated list of languages",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "owaspTop10",
      "in": "query",
      "description": "Comma-separated list of OWASP Top 10 2017 lowercase categories.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "owaspTop10-2021",
      "in": "query",
      "description": "Comma-separated list of OWASP Top 10 2021 lowercase categories.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "prioritizedRule",
      "in": "query",
      "description": "Mark activated rules as prioritized, so all corresponding Issues will have to be fixed.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "q",
      "in": "query",
      "description": "UTF-8 search query",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "qprofile",
      "in": "query",
      "description": "Quality profile key to filter on. Only rules of the same language as this profile are returned. By default only rules activated in this profile are returned. You can change that using the 'activation' parameter.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "repositories",
      "in": "query",
      "description": "Comma-separated list of repositories",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "rule_key",
      "in": "query",
      "description": "Key of rule to search for",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "s",
      "in": "query",
      "description": "Sort field",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "sansTop25",
      "in": "query",
      "description": "Comma-separated list of SANS Top 25 categories.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "severities",
      "in": "query",
      "description": "Comma-separated list of default severities. Not the same than severity of rules in Quality profiles.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "sonarsourceSecurity",
      "in": "query",
      "description": "Comma-separated list of SonarSource security categories. Use 'others' to select rules not associated with any category",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "statuses",
      "in": "query",
      "description": "Comma-separated list of status codes",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "tags",
      "in": "query",
      "description": "Comma-separated list of tags. Returned rules match any of the tags (OR operator)",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "targetKey",
      "in": "query",
      "description": "Quality Profile key on which the rule activation is done. To retrieve a quality profile key please see \u003ccode\u003eapi/qualityprofiles/search\u003c/code\u003e",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "targetSeverity",
      "in": "query",
      "description": "Severity to set on the activated rules",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "template_key",
      "in": "query",
      "description": "Key of the template rule to filter on. Used to search for the custom rules based on this template.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "types",
      "in": "query",
      "description": "Comma-separated list of types. Returned rules match any of the tags (OR operator)",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualityprofiles/add_project": {
   "description": "Manage quality profiles.",
   "post": {
    "summary": "add project",
    "description": "Associate a project with a quality profile.\u003cbr\u003e Requires one of the following permissions:\u003cul\u003e  \u003cli\u003e'Administer Quality Profiles'\u003c/li\u003e  \u003cli\u003eAdminister right on the specified project\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "language",
      "in": "query",
      "description": "Quality profile language.",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "project",
      "in": "query",
      "description": "Project key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "qualityProfile",
      "in": "query",
      "description": "Quality profile name.",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualityprofiles/backup": {
   "description": "Manage quality profiles.",
   "get": {
    "summary": "backup",
    "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": [
     {
      "name": "language",
      "in": "query",
      "description": "Quality profile language.",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "qualityProfile",
      "in": "query",
      "description": "Quality profile name.",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualityprofiles/change_parent": {
   "description": "Manage quality profiles.",
   "post": {
    "summary": "change parent",
    "description": "Change a quality profile's parent.\u003cbr\u003eRequires one of the following permissions:\u003cul\u003e  \u003cli\u003e'Administer Quality Profiles'\u003c/li\u003e  \u003cli\u003eEdit right on the specified quality profile\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "language",
      "in": "query",
      "description": "Quality profile language.",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "parentQualityProfile",
      "in": "query",
      "description": "New parent profile name. \u003cbr\u003e 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.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "qualityProfile",
      "in": "query",
      "description": "Quality profile name.",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualityprofiles/changelog": {
   "description": "Manage quality profiles.",
   "get": {
    "summary": "changelog",
    "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": [
     {
      "name": "filterMode",
      "in": "query",
      "description": "If specified, will return changelog events related to MQR or STANDARD mode. If not specified, all the events are returned",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "language",
      "in": "query",
      "description": "Quality profile language.",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "p",
      "in": "query",
      "description": "1-based page number",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "ps",
      "in": "query",
      "description": "Page size. Must be greater than 0 and less or equal than 500",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "qualityProfile",
      "in": "query",
      "description": "Quality profile name.",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "since",
      "in": "query",
      "description": "Start date for the changelog (inclusive). \u003cbr\u003eEither a date (server timezone) or datetime can be provided.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "to",
      "in": "query",
      "description": "End date for the changelog (exclusive, strictly before). \u003cbr\u003eEither a date (server timezone) or datetime can be provided.",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualityprofiles/copy": {
   "description": "Manage quality profiles.",
   "post": {
    "summary": "copy",
    "description": "Copy a quality profile.\u003cbr\u003e 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": [
     {
      "name": "fromKey",
      "in": "query",
      "description": "Quality profile key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "toName",
      "in": "query",
      "description": "Name for the new quality profile.",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualityprofiles/create": {
   "description": "Manage quality profiles.",
   "post": {
    "summary": "create",
    "description": "Create a quality profile.\u003cbr\u003eRequires 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": [
     {
      "name": "language",
      "in": "query",
      "description": "Quality profile language",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "name",
      "in": "query",
      "description": "Quality profile name",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualityprofiles/deactivate_rule": {
   "description": "Manage quality profiles.",
   "post": {
    "summary": "deactivate rule",
    "description": "Deactivate a rule on a quality profile.\u003cbr\u003e Requires one of the following permissions:\u003cul\u003e  \u003cli\u003e'Administer Quality Profiles'\u003c/li\u003e  \u003cli\u003eEdit right on the specified quality profile\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "key",
      "in": "query",
      "description": "Quality Profile key. Can be obtained through \u003ccode\u003eapi/qualityprofiles/search\u003c/code\u003e",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "rule",
      "in": "query",
      "description": "Rule key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualityprofiles/deactivate_rules": {
   "description": "Manage quality profiles.",
   "post": {
    "summary": "deactivate rules",
    "description": "Bulk deactivate rules on Quality profiles.\u003cbr\u003eRequires one of the following permissions:\u003cul\u003e  \u003cli\u003e'Administer Quality Profiles'\u003c/li\u003e  \u003cli\u003eEdit right on the specified quality profile\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "activation",
      "in": "query",
      "description": "Filter rules that are activated or deactivated on the selected Quality profile. Ignored if the parameter 'qprofile' is not set.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "active_impactSeverities",
      "in": "query",
      "description": "Comma-separated list of Activation Software Quality Severities, i.e the impact severity of rules in Quality profiles.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "active_severities",
      "in": "query",
      "description": "Comma-separated list of activation severities, i.e the severity of rules in Quality profiles.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "asc",
      "in": "query",
      "description": "Ascending sort",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "available_since",
      "in": "query",
      "description": "Filters rules added since date. Format is yyyy-MM-dd",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "cleanCodeAttributeCategories",
      "in": "query",
      "description": "Comma-separated list of Clean Code Attribute Categories",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "cwe",
      "in": "query",
      "description": "Comma-separated list of CWE identifiers. Use 'unknown' to select rules not associated to any CWE.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "impactSeverities",
      "in": "query",
      "description": "Comma-separated list of Software Quality Severities",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "impactSoftwareQualities",
      "in": "query",
      "description": "Comma-separated list of Software Qualities",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "inheritance",
      "in": "query",
      "description": "Comma-separated list of values of inheritance for a rule within a quality profile. Used only if the parameter 'activation' is set.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "is_template",
      "in": "query",
      "description": "Filter template rules",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "languages",
      "in": "query",
      "description": "Comma-separated list of languages",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "owaspTop10",
      "in": "query",
      "description": "Comma-separated list of OWASP Top 10 2017 lowercase categories.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "owaspTop10-2021",
      "in": "query",
      "description": "Comma-separated list of OWASP Top 10 2021 lowercase categories.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "q",
      "in": "query",
      "description": "UTF-8 search query",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "qprofile",
      "in": "query",
      "description": "Quality profile key to filter on. Only rules of the same language as this profile are returned. By default only rules activated in this profile are returned. You can change that using the 'activation' parameter.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "repositories",
      "in": "query",
      "description": "Comma-separated list of repositories",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "rule_key",
      "in": "query",
      "description": "Key of rule to search for",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "s",
      "in": "query",
      "description": "Sort field",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "sansTop25",
      "in": "query",
      "description": "Comma-separated list of SANS Top 25 categories.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "severities",
      "in": "query",
      "description": "Comma-separated list of default severities. Not the same than severity of rules in Quality profiles.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "sonarsourceSecurity",
      "in": "query",
      "description": "Comma-separated list of SonarSource security categories. Use 'others' to select rules not associated with any category",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "statuses",
      "in": "query",
      "description": "Comma-separated list of status codes",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "tags",
      "in": "query",
      "description": "Comma-separated list of tags. Returned rules match any of the tags (OR operator)",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "targetKey",
      "in": "query",
      "description": "Quality Profile key on which the rule deactivation is done. To retrieve a profile key please see \u003ccode\u003eapi/qualityprofiles/search\u003c/code\u003e",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "template_key",
      "in": "query",
      "description": "Key of the template rule to filter on. Used to search for the custom rules based on this template.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "types",
      "in": "query",
      "description": "Comma-separated list of types. Returned rules match any of the tags (OR operator)",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualityprofiles/delete": {
   "description": "Manage quality profiles.",
   "post": {
    "summary": "delete",
    "description": "Delete a quality profile and all its descendants. The default quality profile cannot be deleted.\u003cbr\u003e Requires one of the following permissions:\u003cul\u003e  \u003cli\u003e'Administer Quality Profiles'\u003c/li\u003e  \u003cli\u003eEdit right on the specified quality profile\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "language",
      "in": "query",
      "description": "Quality profile language.",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "qualityProfile",
      "in": "query",
      "description": "Quality profile name.",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualityprofiles/export": {
   "description": "Manage quality profiles.",
   "get": {
    "summary": "export",
    "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": [
     {
      "name": "language",
      "in": "query",
      "description": "Quality profile language",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "qualityProfile",
      "in": "query",
      "description": "Quality profile name to export. If left empty, the default profile for the language is exported.",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualityprofiles/exporters": {
   "description": "Manage quality profiles.",
   "get": {
    "summary": "exporters",
    "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": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualityprofiles/importers": {
   "description": "Manage quality profiles.",
   "get": {
    "summary": "importers",
    "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": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualityprofiles/inheritance": {
   "description": "Manage quality profiles.",
   "get": {
    "summary": "inheritance",
    "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": [
     {
      "name": "language",
      "in": "query",
      "description": "Quality profile language.",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "qualityProfile",
      "in": "query",
      "description": "Quality profile name.",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualityprofiles/projects": {
   "description": "Manage quality profiles.",
   "get": {
    "summary": "projects",
    "description": "List projects with their association status regarding a quality profile. \u003cbr/\u003eOnly projects explicitly bound to the profile are returned, those associated with the profile because it is the default one are not. \u003cbr/\u003eSee 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": [
     {
      "name": "key",
      "in": "query",
      "description": "Quality profile key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "p",
      "in": "query",
      "description": "1-based page number",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "ps",
      "in": "query",
      "description": "Page size. Must be greater than 0 and less or equal than 500",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "q",
      "in": "query",
      "description": "Limit search to projects that contain the supplied string.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "selected",
      "in": "query",
      "description": "Depending on the value, show only selected items (selected=selected), deselected items (selected=deselected), or all items with their selection status (selected=all).",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualityprofiles/remove_project": {
   "description": "Manage quality profiles.",
   "post": {
    "summary": "remove project",
    "description": "Remove a project's association with a quality profile.\u003cbr\u003e Requires one of the following permissions:\u003cul\u003e  \u003cli\u003e'Administer Quality Profiles'\u003c/li\u003e  \u003cli\u003eEdit right on the specified quality profile\u003c/li\u003e  \u003cli\u003eAdminister right on the specified project\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "language",
      "in": "query",
      "description": "Quality profile language.",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "project",
      "in": "query",
      "description": "Project key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "qualityProfile",
      "in": "query",
      "description": "Quality profile name.",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualityprofiles/rename": {
   "description": "Manage quality profiles.",
   "post": {
    "summary": "rename",
    "description": "Rename a quality profile.\u003cbr\u003e Requires one of the following permissions:\u003cul\u003e  \u003cli\u003e'Administer Quality Profiles'\u003c/li\u003e  \u003cli\u003eEdit right on the specified quality profile\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "key",
      "in": "query",
      "description": "Quality profile key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "name",
      "in": "query",
      "description": "New quality profile name",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualityprofiles/restore": {
   "description": "Manage quality profiles.",
   "post": {
    "summary": "restore",
    "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.\u003cbr\u003e 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": [
     {
      "name": "backup",
      "in": "query",
      "description": "A profile backup file in XML format, as generated by api/qualityprofiles/backup or the former api/profiles/backup.",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualityprofiles/search": {
   "description": "Manage quality profiles.",
   "get": {
    "summary": "search",
    "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": [
     {
      "name": "defaults",
      "in": "query",
      "description": "If set to true, return only the quality profiles marked as default for each language",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "language",
      "in": "query",
      "description": "Language key. If provided, only profiles for the given language are returned.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "project",
      "in": "query",
      "description": "Project key",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "qualityProfile",
      "in": "query",
      "description": "Quality profile name",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/qualityprofiles/set_default": {
   "description": "Manage quality profiles.",
   "post": {
    "summary": "set default",
    "description": "Select the default profile for a given language.\u003cbr\u003e 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": [
     {
      "name": "language",
      "in": "query",
      "description": "Quality profile language.",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "qualityProfile",
      "in": "query",
      "description": "Quality profile name.",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/rules/create": {
   "description": "Get and update some details of automatic rules, and manage custom rules.",
   "post": {
    "summary": "create",
    "description": "Create a custom rule.\u003cbr\u003eRequires 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": [
     {
      "name": "cleanCodeAttribute",
      "in": "query",
      "description": "Clean code attribute",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "customKey",
      "in": "query",
      "description": "Key of the custom rule",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "impacts",
      "in": "query",
      "description": "Impacts as semi-colon list of \u0026lt;software_quality\u0026gt;=\u0026lt;severity\u0026gt;",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "markdownDescription",
      "in": "query",
      "description": "Rule description in \u003ca href='/formatting/help'\u003emarkdown format\u003c/a\u003e",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "name",
      "in": "query",
      "description": "Rule name",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "params",
      "in": "query",
      "description": "Parameters as semi-colon list of \u0026lt;key\u0026gt;=\u0026lt;value\u0026gt;",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "preventReactivation",
      "in": "query",
      "description": "If set to true and if the rule has been deactivated (status 'REMOVED'), a status 409 will be returned",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "severity",
      "in": "query",
      "description": "Rule severity",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "status",
      "in": "query",
      "description": "Rule status",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "templateKey",
      "in": "query",
      "description": "Key of the template rule in order to create a custom rule",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "type",
      "in": "query",
      "description": "Rule type",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/rules/delete": {
   "description": "Get and update some details of automatic rules, and manage custom rules.",
   "post": {
    "summary": "delete",
    "description": "Delete custom rule.\u003cbr/\u003eRequires 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": [
     {
      "name": "key",
      "in": "query",
      "description": "Rule key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/rules/repositories": {
   "description": "Get and update some details of automatic rules, and manage custom rules.",
   "get": {
    "summary": "repositories",
    "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": [
     {
      "name": "language",
      "in": "query",
      "description": "A language key; if provided, only repositories for the given language will be returned",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "q",
      "in": "query",
      "description": "A pattern to match repository keys/names against",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/rules/search": {
   "description": "Get and update some details of automatic rules, and manage custom rules.",
   "get": {
    "summary": "search",
    "description": "Search for a collection of relevant rules matching a specified query.\u003cbr/\u003e",
    "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": [
     {
      "name": "activation",
      "in": "query",
      "description": "Filter rules that are activated or deactivated on the selected Quality profile. Ignored if the parameter 'qprofile' is not set.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "active_impactSeverities",
      "in": "query",
      "description": "Comma-separated list of Activation Software Quality Severities, i.e the impact severity of rules in Quality profiles.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "active_severities",
      "in": "query",
      "description": "Comma-separated list of activation severities, i.e the severity of rules in Quality profiles.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "asc",
      "in": "query",
      "description": "Ascending sort",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "available_since",
      "in": "query",
      "description": "Filters rules added since date. Format is yyyy-MM-dd",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "cleanCodeAttributeCategories",
      "in": "query",
      "description": "Comma-separated list of Clean Code Attribute Categories",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "cwe",
      "in": "query",
      "description": "Comma-separated list of CWE identifiers. Use 'unknown' to select rules not associated to any CWE.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "f",
      "in": "query",
      "description": "Comma-separated list of additional fields to be returned in the response. All the fields are returned by default, except actives.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "facets",
      "in": "query",
      "description": "Comma-separated list of the facets to be computed. No facet is computed by default.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "impactSeverities",
      "in": "query",
      "description": "Comma-separated list of Software Quality Severities",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "impactSoftwareQualities",
      "in": "query",
      "description": "Comma-separated list of Software Qualities",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "include_external",
      "in": "query",
      "description": "Include external engine rules in the results",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "inheritance",
      "in": "query",
      "description": "Comma-separated list of values of inheritance for a rule within a quality profile. Used only if the parameter 'activation' is set.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "is_template",
      "in": "query",
      "description": "Filter template rules",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "languages",
      "in": "query",
      "description": "Comma-separated list of languages",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "owaspTop10",
      "in": "query",
      "description": "Comma-separated list of OWASP Top 10 2017 lowercase categories.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "owaspTop10-2021",
      "in": "query",
      "description": "Comma-separated list of OWASP Top 10 2021 lowercase categories.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "p",
      "in": "query",
      "description": "1-based page number",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "prioritizedRule",
      "in": "query",
      "description": "Filter on prioritized rules. Ignored if the parameter 'qprofile' is not set.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "ps",
      "in": "query",
      "description": "Page size. Must be greater than 0 and less or equal than 500",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "q",
      "in": "query",
      "description": "UTF-8 search query",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "qprofile",
      "in": "query",
      "description": "Quality profile key to filter on. Only rules of the same language as this profile are returned. By default only rules activated in this profile are returned. You can change that using the 'activation' parameter.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "repositories",
      "in": "query",
      "description": "Comma-separated list of repositories",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "rule_key",
      "in": "query",
      "description": "Key of rule to search for",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "s",
      "in": "query",
      "description": "Sort field",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "sansTop25",
      "in": "query",
      "description": "Comma-separated list of SANS Top 25 categories.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "severities",
      "in": "query",
      "description": "Comma-separated list of default severities. Not the same than severity of rules in Quality profiles.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "sonarsourceSecurity",
      "in": "query",
      "description": "Comma-separated list of SonarSource security categories. Use 'others' to select rules not associated with any category",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "statuses",
      "in": "query",
      "description": "Comma-separated list of status codes",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "tags",
      "in": "query",
      "description": "Comma-separated list of tags. Returned rules match any of the tags (OR operator)",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "template_key",
      "in": "query",
      "description": "Key of the template rule to filter on. Used to search for the custom rules based on this template.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "types",
      "in": "query",
      "description": "Comma-separated list of types. Returned rules match any of the tags (OR operator)",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/rules/show": {
   "description": "Get and update some details of automatic rules, and manage custom rules.",
   "get": {
    "summary": "show",
    "description": "Get detailed information about a rule\u003cbr\u003e",
    "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": [
     {
      "name": "actives",
      "in": "query",
      "description": "Show rule's activations for all profiles (\"active rules\")",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "key",
      "in": "query",
      "description": "Rule key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/rules/tags": {
   "description": "Get and update some details of automatic rules, and manage custom rules.",
   "get": {
    "summary": "tags",
    "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": [
     {
      "name": "ps",
      "in": "query",
      "description": "Page size. Must be greater than 0 and less or equal than 500",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "q",
      "in": "query",
      "description": "Limit search to tags that contain the supplied string.",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/rules/update": {
   "description": "Get and update some details of automatic rules, and manage custom rules.",
   "post": {
    "summary": "update",
    "description": "Update an existing rule.\u003cbr\u003eRequires 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": [
     {
      "name": "impacts",
      "in": "query",
      "description": "Rule impacts, semicolon-separated (Only when updating a custom rule impact severity)",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "key",
      "in": "query",
      "description": "Key of the rule to update",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "markdownDescription",
      "in": "query",
      "description": "Rule description (mandatory for custom rule and manual rule) in \u003ca href='/formatting/help'\u003emarkdown format\u003c/a\u003e",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "markdown_note",
      "in": "query",
      "description": "Optional note in \u003ca href='/formatting/help'\u003emarkdown format\u003c/a\u003e. Use empty value to remove current note. Note is not changed if the parameter is not set.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "name",
      "in": "query",
      "description": "Rule name (mandatory for custom rule)",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "params",
      "in": "query",
      "description": "Parameters as semi-colon list of \u003ckey\u003e=\u003cvalue\u003e, for example 'params=key1=v1;key2=v2' (Only when updating a custom rule)",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "remediation_fn_base_effort",
      "in": "query",
      "description": "Base effort of the remediation function of the rule",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "remediation_fn_type",
      "in": "query",
      "description": "Type of the remediation function of the rule",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "remediation_fy_gap_multiplier",
      "in": "query",
      "description": "Gap multiplier of the remediation function of the rule",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "severity",
      "in": "query",
      "description": "Rule severity (Only when updating a custom rule)",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "status",
      "in": "query",
      "description": "Rule status (Only when updating a custom rule)",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "tags",
      "in": "query",
      "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.",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/server/version": {
   "get": {
    "summary": "version",
    "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": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/settings/list_definitions": {
   "description": "Manage settings.",
   "get": {
    "summary": "list definitions",
    "description": "List settings definitions.\u003cbr\u003eRequires 'Browse' permission when a component is specified\u003cbr/\u003eTo access licensed settings, authentication is required\u003cbr/\u003eTo access secured settings, one of the following permissions is required: \u003cul\u003e\u003cli\u003e'Execute Analysis'\u003c/li\u003e\u003cli\u003e'Administer System'\u003c/li\u003e\u003cli\u003e'Administer' rights on the specified component\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "component",
      "in": "query",
      "description": "Component key",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/settings/reset": {
   "description": "Manage settings.",
   "post": {
    "summary": "reset",
    "description": "Remove a setting value.\u003cbr\u003eThe settings defined in conf/sonar.properties are read-only and can't be changed.\u003cbr/\u003eRequires one of the following permissions: \u003cul\u003e\u003cli\u003e'Administer System'\u003c/li\u003e\u003cli\u003e'Administer' rights on the specified component\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "component",
      "in": "query",
      "description": "Component key. Only keys for projects, applications, portfolios or subportfolios are accepted.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "keys",
      "in": "query",
      "description": "Comma-separated list of keys",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/settings/set": {
   "description": "Manage settings.",
   "post": {
    "summary": "set",
    "description": "Update a setting value.\u003cbr\u003eEither 'value' or 'values' must be provided.\u003cbr\u003e The settings defined in conf/sonar.properties are read-only and can't be changed.\u003cbr/\u003eRequires one of the following permissions: \u003cul\u003e\u003cli\u003e'Administer System'\u003c/li\u003e\u003cli\u003e'Administer' rights on the specified component\u003c/li\u003e\u003c/ul\u003e",
    "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": [
     {
      "name": "component",
      "in": "query",
      "description": "Component key. Only keys for projects, applications, portfolios or subportfolios are accepted.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "fieldValues",
      "in": "query",
      "description": "Setting field values. To set several values, the parameter must be called once for each value.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "key",
      "in": "query",
      "description": "Setting key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "value",
      "in": "query",
      "description": "Setting value. To reset a value, please use the reset web service.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "values",
      "in": "query",
      "description": "Setting multi value. To set several values, the parameter must be called once for each value.",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/settings/values": {
   "description": "Manage settings.",
   "get": {
    "summary": "values",
    "description": "List settings values.\u003cbr\u003eIf no value has been set for a setting, then the default value is returned.\u003cbr\u003eThe settings from conf/sonar.properties are excluded from results.\u003cbr\u003eRequires 'Browse' or 'Execute Analysis' permission when a component is specified.\u003cbr/\u003eSecured settings values are not returned by the endpoint.\u003cbr/\u003e",
    "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": [
     {
      "name": "component",
      "in": "query",
      "description": "Component key",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "keys",
      "in": "query",
      "description": "List of setting keys",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/sources/raw": {
   "description": "Get details on source files. See also api/tests.",
   "get": {
    "summary": "raw",
    "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": [
     {
      "name": "key",
      "in": "query",
      "description": "File key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/sources/scm": {
   "description": "Get details on source files. See also api/tests.",
   "get": {
    "summary": "scm",
    "description": "Get SCM information of source files. Require See Source Code permission on file's project\u003cbr/\u003eEach element of the result array is composed of:\u003col\u003e\u003cli\u003eLine number\u003c/li\u003e\u003cli\u003eAuthor of the commit\u003c/li\u003e\u003cli\u003eDatetime of the commit (before 5.2 it was only the Date)\u003c/li\u003e\u003cli\u003eRevision of the commit (added in 5.2)\u003c/li\u003e\u003c/ol\u003e",
    "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": [
     {
      "name": "commits_by_line",
      "in": "query",
      "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.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "from",
      "in": "query",
      "description": "First line to return. Starts at 1",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "key",
      "in": "query",
      "description": "File key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "to",
      "in": "query",
      "description": "Last line to return (inclusive)",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/sources/show": {
   "description": "Get details on source files. See also api/tests.",
   "get": {
    "summary": "show",
    "description": "Get source code. Requires See Source Code permission on file's project\u003cbr/\u003eEach element of the result array is composed of:\u003col\u003e\u003cli\u003eLine number\u003c/li\u003e\u003cli\u003eContent of the line\u003c/li\u003e\u003c/ol\u003e",
    "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": [
     {
      "name": "from",
      "in": "query",
      "description": "First line to return. Starts at 1",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "key",
      "in": "query",
      "description": "File key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "to",
      "in": "query",
      "description": "Last line to return (inclusive)",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/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": {
    "summary": "change log level",
    "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": [
     {
      "name": "level",
      "in": "query",
      "description": "The new level. Be cautious: DEBUG, and even more TRACE, may have performance impacts.",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/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": {
    "summary": "db migration status",
    "description": "Display the database migration status of SonarQube.\u003cbr/\u003eState values are:\u003cul\u003e\u003cli\u003eNO_MIGRATION: DB is up to date with current version of SonarQube.\u003c/li\u003e\u003cli\u003eNOT_SUPPORTED: Migration is not supported on embedded databases.\u003c/li\u003e\u003cli\u003eMIGRATION_RUNNING: DB migration is under go.\u003c/li\u003e\u003cli\u003eMIGRATION_SUCCEEDED: DB migration has run and has been successful.\u003c/li\u003e\u003cli\u003eMIGRATION_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).\u003c/li\u003e\u003cli\u003eMIGRATION_REQUIRED: DB migration is required.\u003c/li\u003e\u003c/ul\u003e",
    "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": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/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": {
    "summary": "health",
    "description": "Provide health status of SonarQube.\u003cp\u003eAlthough global health is calculated based on both application and search nodes, detailed information is returned only for application nodes.\u003c/p\u003e\u003cp\u003e  \u003cul\u003e \u003cli\u003eGREEN: SonarQube is fully operational\u003c/li\u003e \u003cli\u003eYELLOW: SonarQube is usable, but it needs attention in order to be fully operational\u003c/li\u003e \u003cli\u003eRED: SonarQube is not operational\u003c/li\u003e \u003c/ul\u003e\u003c/p\u003e\u003cbr\u003eRequires the 'Administer System' permission or system passcode (see WEB_SYSTEM_PASS_CODE in sonar.properties).\u003cbr\u003eWhen 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": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/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": {
    "summary": "info",
    "description": "Get detailed information about system configuration.\u003cbr/\u003eRequires '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": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/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": {
    "summary": "logs",
    "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": [
     {
      "name": "name",
      "in": "query",
      "description": "Name of the logs to get",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/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": {
    "summary": "migrate db",
    "description": "Migrate the database to match the current version of SonarQube.\u003cbr/\u003eSending a POST request to this URL starts the DB migration. It is strongly advised to \u003cstrong\u003emake a database backup\u003c/strong\u003e before invoking this WS.\u003cbr/\u003eState values are:\u003cul\u003e\u003cli\u003eNO_MIGRATION: DB is up to date with current version of SonarQube.\u003c/li\u003e\u003cli\u003eNOT_SUPPORTED: Migration is not supported on embedded databases.\u003c/li\u003e\u003cli\u003eMIGRATION_RUNNING: DB migration is under go.\u003c/li\u003e\u003cli\u003eMIGRATION_SUCCEEDED: DB migration has run and has been successful.\u003c/li\u003e\u003cli\u003eMIGRATION_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).\u003c/li\u003e\u003cli\u003eMIGRATION_REQUIRED: DB migration is required.\u003c/li\u003e\u003c/ul\u003e",
    "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": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/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": {
    "summary": "ping",
    "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": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/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": {
    "summary": "restart",
    "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": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/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": {
    "summary": "status",
    "description": "Get state information about SonarQube.\u003cp\u003estatus: the running status \u003cul\u003e \u003cli\u003eSTARTING: SonarQube Web Server is up and serving some Web Services (eg. api/system/status) but initialization is still ongoing\u003c/li\u003e \u003cli\u003eUP: SonarQube instance is up and running\u003c/li\u003e \u003cli\u003eDOWN: 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).\u003c/li\u003e \u003cli\u003eRESTARTING: SonarQube instance is still up but a restart has been requested (refer to WS /api/system/restart for details).\u003c/li\u003e \u003cli\u003eDB_MIGRATION_NEEDED: database migration is required. DB migration can be started using WS /api/system/migrate_db.\u003c/li\u003e \u003cli\u003eDB_MIGRATION_RUNNING: DB migration is running (refer to WS /api/system/migrate_db for details)\u003c/li\u003e \u003c/ul\u003e\u003c/p\u003e",
    "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": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/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": {
    "summary": "upgrades",
    "description": "Lists available upgrades for the SonarQube instance (if any) and for each one, lists incompatible plugins and plugins requiring upgrade.\u003cbr/\u003ePlugin 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": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/user_groups/add_user": {
   "description": "Manage user groups.",
   "post": {
    "summary": "add user",
    "description": "Add a user to a group.\u003cbr /\u003e'name' must be provided.\u003cbr /\u003eRequires 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": [
     {
      "name": "login",
      "in": "query",
      "description": "User login",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "name",
      "in": "query",
      "description": "Group name",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/user_groups/create": {
   "description": "Manage user groups.",
   "post": {
    "summary": "create",
    "description": "Create a group.\u003cbr\u003eRequires 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": [
     {
      "name": "description",
      "in": "query",
      "description": "Description for the new group. A group description cannot be larger than 200 characters.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "name",
      "in": "query",
      "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.",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/user_groups/delete": {
   "description": "Manage user groups.",
   "post": {
    "summary": "delete",
    "description": "Delete a group. The default groups cannot be deleted.\u003cbr/\u003e'name' must be provided.\u003cbr /\u003eRequires 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": [
     {
      "name": "name",
      "in": "query",
      "description": "Group name",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/user_groups/remove_user": {
   "description": "Manage user groups.",
   "post": {
    "summary": "remove user",
    "description": "Remove a user from a group.\u003cbr /\u003e'name' must be provided.\u003cbr\u003eRequires 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": [
     {
      "name": "login",
      "in": "query",
      "description": "User login",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "name",
      "in": "query",
      "description": "Group name",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/user_groups/search": {
   "description": "Manage user groups.",
   "get": {
    "summary": "search",
    "description": "Search for user groups.\u003cbr\u003eRequires 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": [
     {
      "name": "f",
      "in": "query",
      "description": "Comma-separated list of the fields to be returned in response. All the fields are returned by default.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "managed",
      "in": "query",
      "description": "Return managed or non-managed groups. Only available for managed instances, throws for non-managed instances.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "p",
      "in": "query",
      "description": "1-based page number",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "ps",
      "in": "query",
      "description": "Page size. Must be greater than 0 and less or equal than 500",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "q",
      "in": "query",
      "description": "Limit search to names that contain the supplied string.",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/user_groups/update": {
   "description": "Manage user groups.",
   "post": {
    "summary": "update",
    "description": "Update a group.\u003cbr\u003eRequires 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": [
     {
      "name": "currentName",
      "in": "query",
      "description": "Name of the group to be updated.",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "description",
      "in": "query",
      "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.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "name",
      "in": "query",
      "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.",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/user_groups/users": {
   "description": "Manage user groups.",
   "get": {
    "summary": "users",
    "description": "Search for users with membership information with respect to a group.\u003cbr\u003eRequires 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": [
     {
      "name": "name",
      "in": "query",
      "description": "Group name",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "p",
      "in": "query",
      "description": "1-based page number",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "ps",
      "in": "query",
      "description": "Page size. Must be greater than 0.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "q",
      "in": "query",
      "description": "Limit search to names or logins that contain the supplied string.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "selected",
      "in": "query",
      "description": "Depending on the value, show only selected items (selected=selected), deselected items (selected=deselected), or all items with their selection status (selected=all).",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/user_tokens/generate": {
   "description": "List, create, and delete a user's access tokens.",
   "post": {
    "summary": "generate",
    "description": "Generate a user access token. \u003cbr /\u003ePlease keep your tokens secret. They enable to authenticate and analyze projects.\u003cbr /\u003eIt 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": [
     {
      "name": "expirationDate",
      "in": "query",
      "description": "The expiration date of the token being generated, in ISO 8601 format (YYYY-MM-DD). If not set, default to no expiration.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "login",
      "in": "query",
      "description": "User login. If not set, the token is generated for the authenticated user.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "name",
      "in": "query",
      "description": "Token name",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "projectKey",
      "in": "query",
      "description": "The key of the only project that can be analyzed by the PROJECT_ANALYSIS_TOKEN being generated.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "type",
      "in": "query",
      "description": "Token Type. If this parameters is set to PROJECT_ANALYSIS_TOKEN, it is necessary to provide the projectKey parameter too.",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/user_tokens/revoke": {
   "description": "List, create, and delete a user's access tokens.",
   "post": {
    "summary": "revoke",
    "description": "Revoke a user access token. \u003cbr/\u003eIt 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": [
     {
      "name": "login",
      "in": "query",
      "description": "User login",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "name",
      "in": "query",
      "description": "Token name",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/user_tokens/search": {
   "description": "List, create, and delete a user's access tokens.",
   "get": {
    "summary": "search",
    "description": "List the access tokens of a user.\u003cbr\u003eThe login must exist and active.\u003cbr\u003eField '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.\u003cbr\u003e It requires administration permissions to specify a 'login' and list the tokens of another user. Otherwise, tokens for the current user are listed. \u003cbr\u003e 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": [
     {
      "name": "login",
      "in": "query",
      "description": "User login",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/users/anonymize": {
   "description": "Manage users.",
   "post": {
    "summary": "anonymize",
    "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": [
     {
      "name": "login",
      "in": "query",
      "description": "User login",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/users/change_password": {
   "description": "Manage users.",
   "post": {
    "summary": "change password",
    "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": [
     {
      "name": "login",
      "in": "query",
      "description": "User login",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "password",
      "in": "query",
      "description": "The password needs to fulfill the following requirements: at least 12 characters and contain at least one uppercase character, one lowercase character, one digit and one special character.",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "previousPassword",
      "in": "query",
      "description": "Previous password. Required when changing one's own password.",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/users/create": {
   "description": "Manage users.",
   "post": {
    "summary": "create",
    "description": "Create a user.\u003cbr/\u003eIf a deactivated user account exists with the given login, it will be reactivated.\u003cbr/\u003eRequires 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": [
     {
      "name": "email",
      "in": "query",
      "description": "User email",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "local",
      "in": "query",
      "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.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "login",
      "in": "query",
      "description": "User login",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "name",
      "in": "query",
      "description": "User name",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "password",
      "in": "query",
      "description": "User password. Only mandatory when creating local user, otherwise it should not be set",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "scmAccount",
      "in": "query",
      "description": "List of SCM accounts. To set several values, the parameter must be called once for each value.",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/users/deactivate": {
   "description": "Manage users.",
   "post": {
    "summary": "deactivate",
    "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": [
     {
      "name": "anonymize",
      "in": "query",
      "description": "Anonymize user in addition to deactivating it",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "login",
      "in": "query",
      "description": "User login",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/users/groups": {
   "description": "Manage users.",
   "get": {
    "summary": "groups",
    "description": "Lists the groups a user belongs to. \u003cbr/\u003eRequires 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": [
     {
      "name": "login",
      "in": "query",
      "description": "A user login",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "p",
      "in": "query",
      "description": "1-based page number",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "ps",
      "in": "query",
      "description": "Page size. Must be greater than 0.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "q",
      "in": "query",
      "description": "Limit search to group names that contain the supplied string.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "selected",
      "in": "query",
      "description": "Depending on the value, show only selected items (selected=selected), deselected items (selected=deselected), or all items with their selection status (selected=all).",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/users/search": {
   "description": "Manage users.",
   "get": {
    "summary": "search",
    "description": "Get a list of users. By default, only active users are returned.\u003cbr/\u003eThe following fields are only returned when user has Administer System permission or for logged-in in user :\u003cul\u003e   \u003cli\u003e'email'\u003c/li\u003e   \u003cli\u003e'externalIdentity'\u003c/li\u003e   \u003cli\u003e'externalProvider'\u003c/li\u003e   \u003cli\u003e'groups'\u003c/li\u003e   \u003cli\u003e'lastConnectionDate'\u003c/li\u003e   \u003cli\u003e'sonarLintLastConnectionDate'\u003c/li\u003e   \u003cli\u003e'tokensCount'\u003c/li\u003e\u003c/ul\u003eField '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": [
     {
      "name": "deactivated",
      "in": "query",
      "description": "Return deactivated users instead of active users",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "externalIdentity",
      "in": "query",
      "description": "Find a user by its external identity (ie. its login in the Identity Provider).\nThis is case sensitive and only available with Administer System permission.\n",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "lastConnectedAfter",
      "in": "query",
      "description": "Filter the users based on the last connection date field.\nOnly users who interacted with this instance at or after the date will be returned.\nThe format must be ISO 8601 datetime format (YYYY-MM-DDThh:mm:ss±hhmm)",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "lastConnectedBefore",
      "in": "query",
      "description": "Filter the users based on the last connection date field.\nOnly users that never connected or who interacted with this instance at or before the date will be returned.\nThe format must be ISO 8601 datetime format (YYYY-MM-DDThh:mm:ss±hhmm)",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "managed",
      "in": "query",
      "description": "Return managed or non-managed users. Only available for managed instances, throws for non-managed instances.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "p",
      "in": "query",
      "description": "1-based page number",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "ps",
      "in": "query",
      "description": "Page size. Must be greater than 0 and less or equal than 500",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "q",
      "in": "query",
      "description": "Filter on login, name and email.\u003cbr /\u003eThis parameter performs a partial match (contains), it is case insensitive.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "slLastConnectedAfter",
      "in": "query",
      "description": "Filter the users based on the sonar lint last connection date field\nOnly users who interacted with this instance using SonarLint at or after the date will be returned.\nThe format must be ISO 8601 datetime format (YYYY-MM-DDThh:mm:ss±hhmm)",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "slLastConnectedBefore",
      "in": "query",
      "description": "Filter the users based on the sonar lint last connection date field.\nOnly users that never connected or who interacted with this instance using SonarLint at or before the date will be returned.\nThe format must be ISO 8601 datetime format (YYYY-MM-DDThh:mm:ss±hhmm)",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/users/update": {
   "description": "Manage users.",
   "post": {
    "summary": "update",
    "description": "Update a user.\u003cbr/\u003eRequires 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": [
     {
      "name": "email",
      "in": "query",
      "description": "User email",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "login",
      "in": "query",
      "description": "User login",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "name",
      "in": "query",
      "description": "User name",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "scmAccount",
      "in": "query",
      "description": "SCM accounts. To set several values, the parameter must be called once for each value.",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/users/update_identity_provider": {
   "description": "Manage users.",
   "post": {
    "summary": "update identity provider",
    "description": "Update identity provider information. \u003cbr/\u003eIt'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.\u003cbr/\u003eRequires 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": [
     {
      "name": "login",
      "in": "query",
      "description": "User login",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "newExternalIdentity",
      "in": "query",
      "description": "New external identity, usually the login used in the authentication system. If not provided previous identity will be used.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "newExternalProvider",
      "in": "query",
      "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.",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/users/update_login": {
   "description": "Manage users.",
   "post": {
    "summary": "update login",
    "description": "Update a user login. A login can be updated many times.\u003cbr/\u003eRequires 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": [
     {
      "name": "login",
      "in": "query",
      "description": "The current login (case-sensitive)",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "newLogin",
      "in": "query",
      "description": "The new login. It must not already exist.",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/views/add_application": {
   "description": "Manage portfolios.",
   "post": {
    "summary": "add application",
    "description": "Add an existing application to a portfolio.\u003cbr\u003eAuthentication 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": [
     {
      "name": "application",
      "in": "query",
      "description": "Key of the application to be added",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "portfolio",
      "in": "query",
      "description": "Key of the portfolio where the application will be added",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/views/add_application_branch": {
   "description": "Manage portfolios.",
   "post": {
    "summary": "add application branch",
    "description": "Add a branch of an application selected in a portfolio.\u003cbr/\u003eRequires '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": [
     {
      "name": "application",
      "in": "query",
      "description": "Key of the application",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "branch",
      "in": "query",
      "description": "Key of the branch",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "key",
      "in": "query",
      "description": "Key of the portfolio",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/views/add_portfolio": {
   "description": "Manage portfolios.",
   "post": {
    "summary": "add portfolio",
    "description": "Add an existing portfolio to the structure of another portfolio.\u003cbr\u003e 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": [
     {
      "name": "portfolio",
      "in": "query",
      "description": "Key of the portfolio where a reference will be added",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "reference",
      "in": "query",
      "description": "Key of the portfolio to be added",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/views/add_project": {
   "description": "Manage portfolios.",
   "post": {
    "summary": "add project",
    "description": "Add a project to a portfolio.\u003cbr/\u003eRequires '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": [
     {
      "name": "key",
      "in": "query",
      "description": "Key of the portfolio",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "project",
      "in": "query",
      "description": "Key of the project",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/views/add_project_branch": {
   "description": "Manage portfolios.",
   "post": {
    "summary": "add project branch",
    "description": "Add a branch of a project selected in a portfolio.\u003cbr/\u003eRequires '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": [
     {
      "name": "branch",
      "in": "query",
      "description": "Key of the branch",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "key",
      "in": "query",
      "description": "Key of the portfolio",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "project",
      "in": "query",
      "description": "Key of the project",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/views/applications": {
   "description": "Manage portfolios.",
   "get": {
    "summary": "applications",
    "description": "List applications which the user has access to that can be added to a portfolio. \u003cbr\u003e 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": [
     {
      "name": "portfolio",
      "in": "query",
      "description": "Key of the would-be parent portfolio",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/views/create": {
   "description": "Manage portfolios.",
   "post": {
    "summary": "create",
    "description": "Create a new portfolio.\u003cbr/\u003eRequires '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": [
     {
      "name": "description",
      "in": "query",
      "description": "Description for the new portfolio, can be left blank",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "key",
      "in": "query",
      "description": "Key for the new portfolio. A suitable key will be generated if not provided",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "name",
      "in": "query",
      "description": "Name for the new portfolio",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "parent",
      "in": "query",
      "description": "Key of the parent portfolio, when creating a sub portfolio",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "visibility",
      "in": "query",
      "description": "Whether the created portfolio or application should be visible to everyone, or only specific user/groups.\u003cbr/\u003eOnly applies to root portfolios. If no visibility is specified, the default visibility will be used.",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/views/delete": {
   "description": "Manage portfolios.",
   "post": {
    "summary": "delete",
    "description": "Delete a portfolio definition. \u003cbr/\u003eRequires '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": [
     {
      "name": "key",
      "in": "query",
      "description": "Portfolio key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/views/list": {
   "description": "Manage portfolios.",
   "get": {
    "summary": "list",
    "description": "List root portfolios. \u003cbr\u003eRequires 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": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/views/move": {
   "description": "Manage portfolios.",
   "post": {
    "summary": "move",
    "description": "Move a portfolio. \u003cbr\u003e 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": [
     {
      "name": "destination",
      "in": "query",
      "description": "Key of the destination portfolio",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "key",
      "in": "query",
      "description": "Key of the portfolio to move",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/views/move_options": {
   "description": "Manage portfolios.",
   "get": {
    "summary": "move options",
    "description": "List possible portfolio destinations. \u003cbr\u003e 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": [
     {
      "name": "key",
      "in": "query",
      "description": "Key of the portfolio to move",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/views/portfolios": {
   "description": "Manage portfolios.",
   "get": {
    "summary": "portfolios",
    "description": "List portfolios that can be referenced. \u003cbr\u003e 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": [
     {
      "name": "portfolio",
      "in": "query",
      "description": "Key of the would-be parent portfolio",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/views/remove_application": {
   "description": "Manage portfolios.",
   "post": {
    "summary": "remove application",
    "description": "Remove an application from a portfolio. \u003cbr/\u003eRequires '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": [
     {
      "name": "application",
      "in": "query",
      "description": "Key of the application to be removed",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "portfolio",
      "in": "query",
      "description": "Portfolio key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/views/remove_application_branch": {
   "description": "Manage portfolios.",
   "post": {
    "summary": "remove application branch",
    "description": "Remove a branch of an application selected in a portfolio.\u003cbr/\u003eRequires '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": [
     {
      "name": "application",
      "in": "query",
      "description": "Key of the project",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "branch",
      "in": "query",
      "description": "Key of the branch",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "key",
      "in": "query",
      "description": "Key of the portfolio",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/views/remove_portfolio": {
   "description": "Manage portfolios.",
   "post": {
    "summary": "remove portfolio",
    "description": "Remove a reference to a portfolio. \u003cbr/\u003eRequires '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": [
     {
      "name": "portfolio",
      "in": "query",
      "description": "Portfolio key",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "reference",
      "in": "query",
      "description": "Key of the referenced portfolio to be removed",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/views/remove_project": {
   "description": "Manage portfolios.",
   "post": {
    "summary": "remove project",
    "description": "Remove a project from a portfolio.\u003cbr/\u003eRequires '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": [
     {
      "name": "key",
      "in": "query",
      "description": "Key of the portfolio",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "project",
      "in": "query",
      "description": "Key of the project",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/views/remove_project_branch": {
   "description": "Manage portfolios.",
   "post": {
    "summary": "remove project branch",
    "description": "Remove a branch of a project selected in a portfolio.\u003cbr/\u003eRequires '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": [
     {
      "name": "branch",
      "in": "query",
      "description": "Key of the branch",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "key",
      "in": "query",
      "description": "Key of the portfolio",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "project",
      "in": "query",
      "description": "Key of the project",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/views/set_manual_mode": {
   "description": "Manage portfolios.",
   "post": {
    "summary": "set manual mode",
    "description": "Set the projects selection mode of a portfolio on manual selection.\u003cbr/\u003eIn order to add project, please use api/view/add_project.\u003cbr/\u003eRequires '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": [
     {
      "name": "portfolio",
      "in": "query",
      "description": "Key of the portfolio or sub-portfolio to update",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/views/set_none_mode": {
   "description": "Manage portfolios.",
   "post": {
    "summary": "set none mode",
    "description": "Set the projects selection mode of a portfolio to none.\u003cbr/\u003eAfter setting this mode portfolio will not have any projects assigned.\u003cbr/\u003eRequires '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": [
     {
      "name": "portfolio",
      "in": "query",
      "description": "Key of the portfolio or sub-portfolio to update",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/views/set_regexp_mode": {
   "description": "Manage portfolios.",
   "post": {
    "summary": "set regexp mode",
    "description": "Set the projects selection mode of a portfolio on regular expression.\u003cbr/\u003eRequires '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": [
     {
      "name": "branch",
      "in": "query",
      "description": "Selects a branch in all matched projects, instead of using their main branches",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "portfolio",
      "in": "query",
      "description": "Key of the portfolio or sub-portfolio to update",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "regexp",
      "in": "query",
      "description": "A valid regexp with respect to the JDK's ``java.util.regex.Pattern`` class",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/views/set_remaining_projects_mode": {
   "description": "Manage portfolios.",
   "post": {
    "summary": "set remaining projects mode",
    "description": "Set the projects selection mode of a portfolio on unassociated projects in hierarchy.\u003cbr/\u003eRequires '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": [
     {
      "name": "branch",
      "in": "query",
      "description": "Selects a branch in all matched projects, instead of using their main branches",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "portfolio",
      "in": "query",
      "description": "Key of the portfolio or sub-portfolio to update",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/views/set_tags_mode": {
   "description": "Manage portfolios.",
   "post": {
    "summary": "set tags mode",
    "description": "Set the projects selection mode of a portfolio on project tags.\u003cbr/\u003eRequires '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": [
     {
      "name": "branch",
      "in": "query",
      "description": "Selects a branch in all matched projects, instead of using their main branches",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "portfolio",
      "in": "query",
      "description": "Key of the portfolio or sub-portfolio to update",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "tags",
      "in": "query",
      "description": "Comma-separated list of tags. It's not possible to set nothing.",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/views/show": {
   "description": "Manage portfolios.",
   "get": {
    "summary": "show",
    "description": "Show the details of a portfolio, including its hierarchy and project selection mode. \u003cbr\u003e 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": [
     {
      "name": "key",
      "in": "query",
      "description": "The key of the portfolio",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/views/update": {
   "description": "Manage portfolios.",
   "post": {
    "summary": "update",
    "description": "Update a portfolio.\u003cbr/\u003eRequires '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": [
     {
      "name": "description",
      "in": "query",
      "description": "New description for the portfolio",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "key",
      "in": "query",
      "description": "Key of the portfolio to update",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "name",
      "in": "query",
      "description": "New name for the portfolio",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/webhooks/create": {
   "description": "Webhooks allow to notify external services when a project analysis is done",
   "post": {
    "summary": "create",
    "description": "Create a Webhook.\u003cbr\u003eRequires '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": [
     {
      "name": "name",
      "in": "query",
      "description": "Name displayed in the administration console of webhooks",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "project",
      "in": "query",
      "description": "The key of the project that will own the webhook",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "secret",
      "in": "query",
      "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",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "url",
      "in": "query",
      "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'",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/webhooks/delete": {
   "description": "Webhooks allow to notify external services when a project analysis is done",
   "post": {
    "summary": "delete",
    "description": "Delete a Webhook.\u003cbr\u003eRequires '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": [
     {
      "name": "webhook",
      "in": "query",
      "description": "The key of the webhook to be deleted, auto-generated value can be obtained through api/webhooks/create or api/webhooks/list",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/webhooks/deliveries": {
   "description": "Webhooks allow to notify external services when a project analysis is done",
   "get": {
    "summary": "deliveries",
    "description": "Get the recent deliveries for a specified project or Compute Engine task.\u003cbr/\u003eRequire 'Administer' permission on the related project.\u003cbr/\u003eNote 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": [
     {
      "name": "ceTaskId",
      "in": "query",
      "description": "Id of the Compute Engine task",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "componentKey",
      "in": "query",
      "description": "Key of the project",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "p",
      "in": "query",
      "description": "1-based page number",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "ps",
      "in": "query",
      "description": "Page size. Must be greater than 0 and less than 500",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "webhook",
      "in": "query",
      "description": "Key of the webhook that triggered those deliveries, auto-generated value that can be obtained through api/webhooks/create or api/webhooks/list",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/webhooks/delivery": {
   "description": "Webhooks allow to notify external services when a project analysis is done",
   "get": {
    "summary": "delivery",
    "description": "Get a webhook delivery by its id.\u003cbr/\u003eRequire 'Administer System' permission.\u003cbr/\u003eNote 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": [
     {
      "name": "deliveryId",
      "in": "query",
      "description": "Id of delivery",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/webhooks/list": {
   "description": "Webhooks allow to notify external services when a project analysis is done",
   "get": {
    "summary": "list",
    "description": "Search for global webhooks or project webhooks. Webhooks are ordered by name.\u003cbr\u003eRequires '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": [
     {
      "name": "project",
      "in": "query",
      "description": "Project key",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/webhooks/update": {
   "description": "Webhooks allow to notify external services when a project analysis is done",
   "post": {
    "summary": "update",
    "description": "Update a Webhook.\u003cbr\u003eRequires '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": [
     {
      "name": "name",
      "in": "query",
      "description": "new name of the webhook",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "secret",
      "in": "query",
      "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.",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "url",
      "in": "query",
      "description": "new url to be called by the webhook",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "webhook",
      "in": "query",
      "description": "The key of the webhook to be updated, auto-generated value can be obtained through api/webhooks/create or api/webhooks/list",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/webservices/list": {
   "description": "Get information on the web api supported on this instance.",
   "get": {
    "summary": "list",
    "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": [
     {
      "name": "include_internals",
      "in": "query",
      "description": "Include web services that are implemented for internal use only. Their forward-compatibility is not assured",
      "required": false,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  },
  "/api/webservices/response_example": {
   "description": "Get information on the web api supported on this instance.",
   "get": {
    "summary": "response example",
    "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": [
     {
      "name": "action",
      "in": "query",
      "description": "Action of the web service",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "controller",
      "in": "query",
      "description": "Controller of the web service",
      "required": true,
      "allowEmptyValue": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "2XX": {
      "description": "Successful query.",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  }
 },
 "components": {
  "schemas": {
   "UserCreateRestRequest": {
    "type": "object",
    "properties": {
     "email": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "User email"
     },
     "local": {
      "type": "boolean",
      "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.",
      "default": "true"
     },
     "login": {
      "type": "string",
      "maxLength": 100,
      "minLength": 2,
      "description": "User login"
     },
     "name": {
      "type": "string",
      "maxLength": 200,
      "description": "User name"
     },
     "password": {
      "type": "string",
      "description": "User password. Only mandatory when creating local user, otherwise it should not be set",
      "writeOnly": true
     },
     "scmAccounts": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "List of SCM accounts."
     }
    },
    "required": [
     "login",
     "name"
    ]
   },
   "UserRestResponseForAdmins": {
    "type": "object",
    "properties": {
     "id": {
      "type": "string",
      "readOnly": true
     },
     "login": {
      "type": "string"
     },
     "name": {
      "type": "string"
     },
     "email": {
      "type": "string"
     },
     "active": {
      "type": "boolean",
      "readOnly": true
     },
     "local": {
      "type": "boolean",
      "readOnly": true
     },
     "managed": {
      "type": "boolean",
      "readOnly": true
     },
     "externalLogin": {
      "type": "string"
     },
     "externalProvider": {
      "type": "string"
     },
     "externalId": {
      "type": "string"
     },
     "avatar": {
      "type": "string"
     },
     "sonarQubeLastConnectionDate": {
      "type": "string",
      "readOnly": true
     },
     "sonarLintLastConnectionDate": {
      "type": "string",
      "readOnly": true
     },
     "scmAccounts": {
      "type": "array",
      "items": {
       "type": "string"
      }
     }
    }
   },
   "EmailConfigurationCreateRestRequest": {
    "type": "object",
    "properties": {
     "host": {
      "type": "string",
      "description": "URL of your SMTP server"
     },
     "port": {
      "type": "string",
      "description": "Port of your SMTP server (usually 25, 587 or 465)"
     },
     "securityProtocol": {
      "type": "string",
      "enum": [
       "NONE",
       "SSLTLS",
       "STARTTLS"
      ],
      "description": "Security protocol used to connect to your SMTP server (SSLTLS is recommended)"
     },
     "fromAddress": {
      "type": "string",
      "description": "Address emails will come from"
     },
     "fromName": {
      "type": "string",
      "description": "Name emails will come from (usually \"SonarQube\")"
     },
     "subjectPrefix": {
      "type": "string",
      "description": "Prefix added to email so they can be easily recognized (usually \"[SonarQube]\")"
     },
     "authMethod": {
      "type": "string",
      "enum": [
       "BASIC",
       "OAUTH"
      ],
      "description": "Authentication method used to connect to the SMTP server. OAuth is only supported for Microsoft Exchange"
     },
     "username": {
      "type": "string",
      "description": "For Basic and OAuth authentication: username used to authenticate to the SMTP server"
     },
     "basicPassword": {
      "type": "string",
      "description": "For basic authentication: password used to authenticate to the SMTP server",
      "writeOnly": true
     },
     "oauthAuthenticationHost": {
      "type": "string",
      "description": "For OAuth authentication: host of the Identity Provider issuing access tokens"
     },
     "oauthClientId": {
      "type": "string",
      "description": "For OAuth authentication: Client ID provided by Microsoft Exchange when registering the application",
      "writeOnly": true
     },
     "oauthClientSecret": {
      "type": "string",
      "description": "For OAuth authentication: Client secret provided by Microsoft Exchange when registering the application",
      "writeOnly": true
     },
     "oauthTenant": {
      "type": "string",
      "description": "For OAuth authentication: Microsoft tenant"
     }
    },
    "required": [
     "authMethod",
     "fromAddress",
     "fromName",
     "host",
     "port",
     "securityProtocol",
     "subjectPrefix",
     "username"
    ]
   },
   "EmailConfigurationResource": {
    "type": "object",
    "properties": {
     "id": {
      "type": "string",
      "readOnly": true
     },
     "host": {
      "type": "string",
      "description": "URL of your SMTP server"
     },
     "port": {
      "type": "string",
      "description": "Port of your SMTP server (usually 25, 587 or 465)"
     },
     "securityProtocol": {
      "type": "string",
      "enum": [
       "NONE",
       "SSLTLS",
       "STARTTLS"
      ],
      "description": "Security protocol used to connect to your SMTP server (SSLTLS is recommended)"
     },
     "fromAddress": {
      "type": "string",
      "description": "Address emails will come from"
     },
     "fromName": {
      "type": "string",
      "description": "Name emails will come from (usually \"SonarQube\")"
     },
     "subjectPrefix": {
      "type": "string",
      "description": "Prefix added to email so they can be easily recognized (usually \"[SonarQube]\")"
     },
     "authMethod": {
      "type": "string",
      "enum": [
       "BASIC",
       "OAUTH"
      ],
      "description": "Authentication method used to connect to the SMTP server. OAuth is only supported for Microsoft Exchange"
     },
     "username": {
      "type": "string",
      "description": "For Basic and OAuth authentication: username used to authenticate to the SMTP server"
     },
     "isBasicPasswordSet": {
      "type": "boolean",
      "description": "For Basic authentication: has the password field been set?"
     },
     "oauthAuthenticationHost": {
      "type": "string",
      "description": "For OAuth authentication: host of the Identity Provider issuing access tokens"
     },
     "isOauthClientIdSet": {
      "type": "boolean",
      "description": "For OAuth authentication: has the Client ID field been set?"
     },
     "isOauthClientSecretSet": {
      "type": "boolean",
      "description": "For OAuth authentication: has the Client secret field been set?"
     },
     "oauthTenant": {
      "type": "string",
      "description": "For OAuth authentication: Microsoft tenant"
     }
    }
   },
   "AwarenessBannerClickedRequest": {
    "type": "object",
    "properties": {
     "bannerType": {
      "type": "string",
      "enum": [
       "ENABLE",
       "LEARN_MORE"
      ]
     }
    }
   },
   "AwarenessBannerClickedResponse": {
    "type": "object",
    "properties": {
     "id": {
      "type": "string",
      "readOnly": true
     }
    }
   },
   "FixSuggestionPostRequest": {
    "type": "object",
    "properties": {
     "issueId": {
      "type": "string",
      "description": "Issue key"
     }
    },
    "required": [
     "issueId"
    ]
   },
   "ChangeDto": {
    "type": "object",
    "properties": {
     "startLine": {
      "type": "integer",
      "format": "int32"
     },
     "endLine": {
      "type": "integer",
      "format": "int32"
     },
     "newCode": {
      "type": "string"
     }
    }
   },
   "FixSuggestionResponse": {
    "type": "object",
    "properties": {
     "id": {
      "type": "string",
      "format": "uuid"
     },
     "issueId": {
      "type": "string"
     },
     "explanation": {
      "type": "string"
     },
     "changes": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/ChangeDto"
      }
     }
    }
   },
   "GitlabSynchronizationRunResource": {
    "type": "object",
    "properties": {
     "id": {
      "type": "string",
      "readOnly": true
     }
    }
   },
   "PermissionMappingsPostRequest": {
    "type": "object",
    "properties": {
     "role": {
      "type": "string",
      "description": "Custom role name"
     },
     "permissions": {
      "$ref": "#/components/schemas/RestPermissions",
      "description": "Set of SonarQube permissions to apply"
     }
    },
    "required": [
     "permissions",
     "role"
    ]
   },
   "RestPermissions": {
    "type": "object",
    "properties": {
     "user": {
      "type": "boolean",
      "description": "Browse"
     },
     "codeViewer": {
      "type": "boolean",
      "description": "See Source Code"
     },
     "issueAdmin": {
      "type": "boolean",
      "description": "Administer Issues"
     },
     "securityHotspotAdmin": {
      "type": "boolean",
      "description": "Administer Security Hotspots"
     },
     "admin": {
      "type": "boolean",
      "description": "Administer"
     },
     "scan": {
      "type": "boolean",
      "description": "Execute Analysis"
     }
    },
    "required": [
     "admin",
     "codeViewer",
     "issueAdmin",
     "scan",
     "securityHotspotAdmin",
     "user"
    ]
   },
   "PermissionMappingsResource": {
    "type": "object",
    "properties": {
     "id": {
      "type": "string"
     },
     "role": {
      "type": "string"
     },
     "baseRole": {
      "type": "boolean"
     },
     "permissions": {
      "$ref": "#/components/schemas/RestPermissions"
     }
    }
   },
   "GitlabConfigurationCreateRestRequest": {
    "type": "object",
    "properties": {
     "enabled": {
      "type": "boolean",
      "description": "Enable Gitlab authentication"
     },
     "applicationId": {
      "type": "string",
      "description": "Gitlab Application id"
     },
     "url": {
      "type": "string",
      "description": "Url of Gitlab instance for authentication (for instance https://gitlab.com)"
     },
     "secret": {
      "type": "string",
      "description": "Secret of the application",
      "writeOnly": true
     },
     "synchronizeGroups": {
      "type": "boolean",
      "description": "Set whether to synchronize groups"
     },
     "allowedGroups": {
      "type": "array",
      "items": {
       "type": "string"
      }
     },
     "provisioningType": {
      "type": "string",
      "enum": [
       "JIT",
       "AUTO_PROVISIONING"
      ],
      "description": "Type of synchronization"
     },
     "provisioningToken": {
      "type": "string",
      "description": "Gitlab token for provisioning",
      "writeOnly": true
     },
     "allowUsersToSignUp": {
      "type": "boolean",
      "description": "Allow user to sign up"
     }
    },
    "required": [
     "allowedGroups",
     "applicationId",
     "enabled",
     "provisioningType",
     "secret",
     "synchronizeGroups",
     "url"
    ]
   },
   "GitlabConfigurationResource": {
    "type": "object",
    "properties": {
     "id": {
      "type": "string",
      "readOnly": true
     },
     "enabled": {
      "type": "boolean"
     },
     "applicationId": {
      "type": "string",
      "description": "Gitlab Application id"
     },
     "url": {
      "type": "string",
      "description": "Url of Gitlab instance for authentication (for instance https://gitlab.com/api/v4)"
     },
     "synchronizeGroups": {
      "type": "boolean"
     },
     "allowedGroups": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "Root Gitlab groups allowed to authenticate and provisioned"
     },
     "allowUsersToSignUp": {
      "type": "boolean"
     },
     "provisioningType": {
      "type": "string",
      "enum": [
       "JIT",
       "AUTO_PROVISIONING"
      ]
     },
     "isProvisioningTokenSet": {
      "type": "boolean",
      "description": "Whether or not the provisioningToken is defined",
      "readOnly": true
     },
     "errorMessage": {
      "type": "string",
      "description": "In case the GitLab configuration is incorrect, error message",
      "readOnly": true
     }
    }
   },
   "GithubConfigurationCreateRestRequest": {
    "type": "object",
    "properties": {
     "enabled": {
      "type": "boolean",
      "description": "Enable GitHub authentication"
     },
     "clientId": {
      "type": "string",
      "description": "Client ID provided by GitHub when registering the application.",
      "writeOnly": true
     },
     "clientSecret": {
      "type": "string",
      "description": "Client password provided by GitHub when registering the application.",
      "writeOnly": true
     },
     "applicationId": {
      "type": "string",
      "description": "The App ID is found on your GitHub App's page on GitHub at Settings \u003e Developer Settings \u003e GitHub Apps."
     },
     "privateKey": {
      "type": "string",
      "description": "Your GitHub App's private key. You can generate a .pem file from your GitHub App's page under Private keys.\nCopy and paste the whole contents of the file here.\n",
      "writeOnly": true
     },
     "synchronizeGroups": {
      "type": "boolean",
      "description": "Synchronize GitHub team with SonarQube group memberships when users log in to SonarQube.\nFor each GitHub team they belong to, users will be associated to a group of the same name if it exists in SonarQube.\n"
     },
     "apiUrl": {
      "type": "string",
      "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"
     },
     "webUrl": {
      "type": "string",
      "description": "The WEB url for a GitHub instance. https://github.com/ for Github.com, https://github.company.com/ when using GitHub Enterprise.\n"
     },
     "allowedOrganizations": {
      "type": "array",
      "items": {
       "type": "string"
      }
     },
     "provisioningType": {
      "type": "string",
      "enum": [
       "JIT",
       "AUTO_PROVISIONING"
      ],
      "description": "Type of synchronization"
     },
     "allowUsersToSignUp": {
      "type": "boolean",
      "description": "Allow user to sign up"
     },
     "projectVisibility": {
      "type": "boolean",
      "description": "Change project visibility based on GitHub repository visibility.\nIf disabled, every provisioned project will be private in SonarQube and visible only to users with explicit GitHub permissions for the corresponding repository.\nChanges take effect at the next synchronization.\n"
     },
     "userConsentRequiredAfterUpgrade": {
      "type": "boolean",
      "description": "Admin consent to synchronize permissions from GitHub"
     }
    },
    "required": [
     "allowedOrganizations",
     "apiUrl",
     "applicationId",
     "clientId",
     "clientSecret",
     "enabled",
     "privateKey",
     "provisioningType",
     "synchronizeGroups",
     "webUrl"
    ]
   },
   "GithubConfigurationResource": {
    "type": "object",
    "properties": {
     "id": {
      "type": "string",
      "readOnly": true
     },
     "enabled": {
      "type": "boolean"
     },
     "applicationId": {
      "type": "string",
      "description": "GitHub Application id"
     },
     "synchronizeGroups": {
      "type": "boolean"
     },
     "apiUrl": {
      "type": "string",
      "description": "Url of GitHub instance for API connectivity (for instance https://api.github.com)"
     },
     "webUrl": {
      "type": "string",
      "description": "Url of GitHub instance for authentication (for instance https://github.com)"
     },
     "allowedOrganizations": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "GitHub organizations allowed to authenticate and provisioned"
     },
     "provisioningType": {
      "type": "string",
      "enum": [
       "JIT",
       "AUTO_PROVISIONING"
      ]
     },
     "allowUsersToSignUp": {
      "type": "boolean"
     },
     "projectVisibility": {
      "type": "boolean"
     },
     "userConsentRequiredAfterUpgrade": {
      "type": "boolean"
     },
     "errorMessage": {
      "type": "string",
      "description": "In case the GitHub configuration is incorrect, error message",
      "readOnly": true
     }
    }
   },
   "BoundProjectCreateRestRequest": {
    "type": "object",
    "properties": {
     "projectKey": {
      "type": "string",
      "description": "Key of the project to create"
     },
     "projectName": {
      "type": "string",
      "description": "Name of the project to create"
     },
     "devOpsPlatformSettingId": {
      "type": "string",
      "description": "Identifier of DevOps platform configuration to use. Use /dop-translation/dop-settings to retrieve the settings and their ID"
     },
     "repositoryIdentifier": {
      "type": "string",
      "description": "Identifier of the DevOps platform repository to import:\n- repository slug for GitHub and Bitbucket (Cloud and Server)\n- repository id for GitLab\n- repository name for Azure DevOps\n"
     },
     "projectIdentifier": {
      "type": "string",
      "description": "Identifier of the DevOps platform project in which the repository is located.\nThis is only needed for Azure and BitBucket Server platforms\n"
     },
     "newCodeDefinitionType": {
      "type": "string",
      "description": "  Project New Code Definition Type\n  New code definitions of the following types are allowed:\n    - PREVIOUS_VERSION\n    - NUMBER_OF_DAYS\n    - REFERENCE_BRANCH - will default to the main branch.\n"
     },
     "newCodeDefinitionValue": {
      "type": "string",
      "description": "  Project New Code Definition Value\n  For each new code definition type, a different value is expected:\n  - no value, when the new code definition type is PREVIOUS_VERSION and REFERENCE_BRANCH\n  - a number between 1 and 90, when the new code definition type is NUMBER_OF_DAYS\n"
     },
     "monorepo": {
      "type": "boolean",
      "description": "True if project is part of a mono repo."
     }
    },
    "required": [
     "devOpsPlatformSettingId",
     "monorepo",
     "projectKey",
     "projectName",
     "repositoryIdentifier"
    ]
   },
   "BoundProjectCreateRestResponse": {
    "type": "object",
    "properties": {
     "projectId": {
      "type": "string",
      "description": "The identifier of the created project"
     },
     "bindingId": {
      "type": "string",
      "description": "The identifier of the binding between the created project and the DevOps platform project"
     }
    }
   },
   "Impact": {
    "type": "object",
    "properties": {
     "softwareQuality": {
      "type": "string",
      "enum": [
       "MAINTAINABILITY",
       "RELIABILITY",
       "SECURITY"
      ]
     },
     "severity": {
      "type": "string",
      "enum": [
       "INFO",
       "LOW",
       "MEDIUM",
       "HIGH",
       "BLOCKER"
      ]
     }
    }
   },
   "Parameter": {
    "type": "object",
    "properties": {
     "key": {
      "type": "string"
     },
     "htmlDescription": {
      "type": "string",
      "readOnly": true
     },
     "defaultValue": {
      "type": "string"
     },
     "type": {
      "type": "string",
      "enum": [
       "STRING",
       "TEXT",
       "BOOLEAN",
       "INTEGER",
       "FLOAT"
      ],
      "readOnly": true
     }
    }
   },
   "RuleCreateRestRequest": {
    "type": "object",
    "properties": {
     "key": {
      "type": "string",
      "maxLength": 200,
      "description": "Key of the custom rule to create, must include the repository"
     },
     "templateKey": {
      "type": "string",
      "maxLength": 200,
      "description": "Key of the rule template to be used to create the custom rule"
     },
     "name": {
      "type": "string",
      "maxLength": 200,
      "description": "Rule name"
     },
     "markdownDescription": {
      "type": "string",
      "description": "Rule description in markdown format"
     },
     "status": {
      "type": "string",
      "enum": [
       "BETA",
       "DEPRECATED",
       "READY",
       "REMOVED"
      ],
      "description": "Rule status",
      "default": "READY"
     },
     "parameters": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/Parameter"
      },
      "description": "Custom rule parameters"
     },
     "cleanCodeAttribute": {
      "type": "string",
      "enum": [
       "CONVENTIONAL",
       "FORMATTED",
       "IDENTIFIABLE",
       "CLEAR",
       "COMPLETE",
       "EFFICIENT",
       "LOGICAL",
       "DISTINCT",
       "FOCUSED",
       "MODULAR",
       "TESTED",
       "LAWFUL",
       "RESPECTFUL",
       "TRUSTWORTHY"
      ],
      "description": "Clean code attribute"
     },
     "impacts": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/Impact"
      },
      "description": "Impacts"
     },
     "severity": {
      "type": "string",
      "description": "Severity"
     },
     "type": {
      "type": "string",
      "enum": [
       "CODE_SMELL",
       "BUG",
       "VULNERABILITY",
       "SECURITY_HOTSPOT"
      ],
      "description": "Rule type"
     }
    },
    "required": [
     "impacts",
     "key",
     "markdownDescription",
     "name",
     "templateKey"
    ]
   },
   "RuleDescriptionSectionContextRestResponse": {
    "type": "object",
    "properties": {
     "key": {
      "type": "string"
     },
     "displayName": {
      "type": "string"
     }
    },
    "readOnly": true
   },
   "RuleDescriptionSectionRestResponse": {
    "type": "object",
    "properties": {
     "key": {
      "type": "string",
      "readOnly": true
     },
     "content": {
      "type": "string",
      "readOnly": true
     },
     "context": {
      "$ref": "#/components/schemas/RuleDescriptionSectionContextRestResponse",
      "readOnly": true
     }
    }
   },
   "RuleRestResponse": {
    "type": "object",
    "properties": {
     "id": {
      "type": "string"
     },
     "key": {
      "type": "string"
     },
     "repositoryKey": {
      "type": "string"
     },
     "name": {
      "type": "string"
     },
     "severity": {
      "type": "string"
     },
     "type": {
      "type": "string",
      "enum": [
       "CODE_SMELL",
       "BUG",
       "VULNERABILITY",
       "SECURITY_HOTSPOT"
      ]
     },
     "impacts": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/Impact"
      }
     },
     "cleanCodeAttribute": {
      "type": "string",
      "enum": [
       "CONVENTIONAL",
       "FORMATTED",
       "IDENTIFIABLE",
       "CLEAR",
       "COMPLETE",
       "EFFICIENT",
       "LOGICAL",
       "DISTINCT",
       "FOCUSED",
       "MODULAR",
       "TESTED",
       "LAWFUL",
       "RESPECTFUL",
       "TRUSTWORTHY"
      ]
     },
     "cleanCodeAttributeCategory": {
      "type": "string",
      "enum": [
       "ADAPTABLE",
       "CONSISTENT",
       "INTENTIONAL",
       "RESPONSIBLE"
      ]
     },
     "status": {
      "type": "string",
      "enum": [
       "BETA",
       "DEPRECATED",
       "READY",
       "REMOVED"
      ]
     },
     "external": {
      "type": "boolean"
     },
     "createdAt": {
      "type": "string"
     },
     "descriptionSections": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/RuleDescriptionSectionRestResponse"
      }
     },
     "markdownDescription": {
      "type": "string"
     },
     "gapDescription": {
      "type": "string"
     },
     "htmlNote": {
      "type": "string"
     },
     "markdownNote": {
      "type": "string"
     },
     "educationPrinciples": {
      "type": "array",
      "items": {
       "type": "string"
      }
     },
     "template": {
      "type": "boolean"
     },
     "templateId": {
      "type": "string"
     },
     "tags": {
      "type": "array",
      "items": {
       "type": "string"
      }
     },
     "systemTags": {
      "type": "array",
      "items": {
       "type": "string"
      }
     },
     "languageKey": {
      "type": "string"
     },
     "languageName": {
      "type": "string"
     },
     "parameters": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/Parameter"
      }
     },
     "remediationFunctionType": {
      "type": "string"
     },
     "remediationFunctionGapMultiplier": {
      "type": "string"
     },
     "remediationFunctionBaseEffort": {
      "type": "string"
     }
    },
    "readOnly": true
   },
   "GroupCreateRestRequest": {
    "type": "object",
    "properties": {
     "name": {
      "type": "string",
      "maxLength": 255,
      "minLength": 1,
      "description": "Name for the new group. Must be unique. The value 'anyone' is reserved and cannot be used."
     },
     "description": {
      "type": "string",
      "maxLength": 200,
      "description": "Description for the new group."
     }
    },
    "required": [
     "name"
    ]
   },
   "GroupRestResponse": {
    "type": "object",
    "properties": {
     "id": {
      "type": "string",
      "readOnly": true
     },
     "name": {
      "type": "string"
     },
     "description": {
      "type": "string"
     },
     "managed": {
      "type": "boolean",
      "readOnly": true
     },
     "default": {
      "type": "boolean",
      "readOnly": true
     }
    }
   },
   "GroupMembershipCreateRestRequest": {
    "type": "object",
    "properties": {
     "userId": {
      "type": "string",
      "description": "ID of the user to add to group."
     },
     "groupId": {
      "type": "string",
      "description": "ID of the group where a member needs to be added."
     }
    }
   },
   "GroupMembershipRestResponse": {
    "type": "object",
    "properties": {
     "id": {
      "type": "string",
      "readOnly": true
     },
     "groupId": {
      "type": "string",
      "readOnly": true
     },
     "userId": {
      "type": "string",
      "readOnly": true
     }
    }
   },
   "UpdateFieldListString": {
    "type": "object",
    "properties": {
     "value": {
      "type": "array",
      "items": {
       "type": "string"
      }
     },
     "defined": {
      "type": "boolean"
     }
    }
   },
   "UpdateFieldString": {
    "type": "object",
    "properties": {
     "value": {
      "type": "string"
     },
     "defined": {
      "type": "boolean"
     }
    }
   },
   "UserUpdateRestRequest": {
    "type": "object",
    "properties": {
     "login": {
      "$ref": "#/components/schemas/UpdateFieldString",
      "description": "User login"
     },
     "name": {
      "type": "string",
      "maxLength": 200,
      "description": "User first name and last name"
     },
     "email": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Email"
     },
     "scmAccounts": {
      "$ref": "#/components/schemas/UpdateFieldListString"
     },
     "externalProvider": {
      "type": "string",
      "description": "New identity provider. Only providers configured in your platform are supported. This could be: github, gitlab, bitbucket, saml, LDAP, LDAP_{serverKey}\n(according to your server configuration file).\nWarning: 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.\n"
     },
     "externalLogin": {
      "type": "string",
      "maxLength": 255,
      "minLength": 1,
      "description": "New external login, usually the login used in the authentication system."
     },
     "externalId": {
      "type": "string",
      "maxLength": 255,
      "minLength": 1,
      "description": "New external id in the authentication system."
     }
    }
   },
   "EmailConfigurationUpdateRestRequest": {
    "type": "object",
    "properties": {
     "host": {
      "type": "string",
      "description": "URL of your SMTP server"
     },
     "port": {
      "type": "string",
      "description": "Port of your SMTP server (usually 25, 587 or 465)"
     },
     "securityProtocol": {
      "type": "string",
      "enum": [
       "NONE",
       "SSLTLS",
       "STARTTLS"
      ],
      "description": "Security protocol used to connect to your SMTP server (SSLTLS is recommended)"
     },
     "fromAddress": {
      "type": "string",
      "description": "Address emails will come from"
     },
     "fromName": {
      "type": "string",
      "description": "Name emails will come from (usually \"SonarQube\")"
     },
     "subjectPrefix": {
      "type": "string",
      "description": "Prefix added to email so they can be easily recognized (usually \"[SonarQube]\")"
     },
     "authMethod": {
      "type": "string",
      "enum": [
       "BASIC",
       "OAUTH"
      ],
      "description": "Authentication method used to connect to the SMTP server. OAuth is only supported for Microsoft Exchange"
     },
     "username": {
      "type": "string",
      "description": "For Basic and OAuth authentication: username used to authenticate to the SMTP server"
     },
     "basicPassword": {
      "type": "string",
      "description": "For basic authentication: password used to authenticate to the SMTP server"
     },
     "oauthAuthenticationHost": {
      "type": "string",
      "description": "For OAuth authentication: host of the Identity Provider issuing access tokens"
     },
     "oauthClientId": {
      "type": "string",
      "description": "For OAuth authentication: Client ID provided by Microsoft Exchange when registering the application"
     },
     "oauthClientSecret": {
      "type": "string",
      "description": "For OAuth authentication: Client password provided by Microsoft Exchange when registering the application"
     },
     "oauthTenant": {
      "type": "string",
      "description": "For OAuth authentication: Microsoft tenant"
     }
    }
   },
   "FeatureEnablementChanges": {
    "type": "object",
    "properties": {
     "enabledProjectKeys": {
      "type": "array",
      "items": {
       "type": "string"
      }
     },
     "disabledProjectKeys": {
      "type": "array",
      "items": {
       "type": "string"
      }
     }
    }
   },
   "FeatureEnablementRequest": {
    "type": "object",
    "properties": {
     "enablement": {
      "type": "string",
      "enum": [
       "DISABLED",
       "ENABLED_FOR_ALL_PROJECTS",
       "ENABLED_FOR_SOME_PROJECTS"
      ]
     },
     "changes": {
      "$ref": "#/components/schemas/FeatureEnablementChanges"
     }
    },
    "required": [
     "enablement"
    ]
   },
   "DevOpsPermissionMappingUpdateRequest": {
    "type": "object",
    "properties": {
     "permissions": {
      "$ref": "#/components/schemas/PermissionMappingUpdate",
      "description": "Set of SonarQube permissions to apply"
     }
    }
   },
   "PermissionMappingUpdate": {
    "type": "object",
    "properties": {
     "user": {
      "type": "boolean"
     },
     "codeViewer": {
      "type": "boolean"
     },
     "issueAdmin": {
      "type": "boolean"
     },
     "securityHotspotAdmin": {
      "type": "boolean"
     },
     "admin": {
      "type": "boolean"
     },
     "scan": {
      "type": "boolean"
     }
    }
   },
   "GitlabConfigurationUpdateRestRequest": {
    "type": "object",
    "properties": {
     "enabled": {
      "type": "boolean",
      "description": "Enable Gitlab authentication"
     },
     "applicationId": {
      "type": "string",
      "description": "Gitlab Application id"
     },
     "url": {
      "type": "string",
      "description": "Url of Gitlab instance for authentication (for instance https://gitlab.com/api/v4)"
     },
     "secret": {
      "type": "string",
      "description": "Secret of the application"
     },
     "synchronizeGroups": {
      "type": "boolean",
      "description": "Set whether to synchronize groups"
     },
     "allowedGroups": {
      "$ref": "#/components/schemas/UpdateFieldListString"
     },
     "provisioningType": {
      "type": "string",
      "enum": [
       "JIT",
       "AUTO_PROVISIONING"
      ],
      "description": "Type of synchronization"
     },
     "allowUsersToSignUp": {
      "type": "boolean",
      "description": "Allow user to sign up"
     },
     "provisioningToken": {
      "type": "string",
      "maxLength": 2147483647,
      "minLength": 1,
      "description": "Gitlab token for provisioning"
     }
    }
   },
   "GithubConfigurationUpdateRestRequest": {
    "type": "object",
    "properties": {
     "enabled": {
      "type": "boolean",
      "description": "Enable GitHub authentication"
     },
     "clientId": {
      "type": "string",
      "description": "GitHub Client ID"
     },
     "clientSecret": {
      "type": "string",
      "description": "GitHub Client secret"
     },
     "applicationId": {
      "type": "string",
      "description": "GitHub Application id"
     },
     "privateKey": {
      "type": "string",
      "description": "GitHub Private key"
     },
     "synchronizeGroups": {
      "type": "boolean",
      "description": "Set whether to synchronize groups"
     },
     "apiUrl": {
      "type": "string",
      "description": "Url of GitHub instance for API connectivity (for instance https://api.github.com)"
     },
     "webUrl": {
      "type": "string",
      "description": "Url of GitHub instance for authentication (for instance https://github.com)"
     },
     "allowedOrganizations": {
      "$ref": "#/components/schemas/UpdateFieldListString"
     },
     "provisioningType": {
      "type": "string",
      "enum": [
       "JIT",
       "AUTO_PROVISIONING"
      ],
      "description": "Type of synchronization"
     },
     "allowUsersToSignUp": {
      "type": "boolean",
      "description": "Allow user to sign up"
     },
     "projectVisibility": {
      "type": "boolean",
      "description": "Sync project visibility"
     },
     "userConsentRequiredAfterUpgrade": {
      "type": "boolean",
      "description": "Admin consent to synchronize permissions from GitHub"
     }
    }
   },
   "ModeResource": {
    "type": "object",
    "properties": {
     "mode": {
      "type": "string",
      "enum": [
       "MQR",
       "STANDARD_EXPERIENCE"
      ]
     },
     "modified": {
      "type": "boolean",
      "readOnly": true
     }
    },
    "required": [
     "mode"
    ]
   },
   "GroupUpdateRestRequest": {
    "type": "object",
    "properties": {
     "name": {
      "type": "string",
      "maxLength": 255,
      "minLength": 1,
      "description": "Group name"
     },
     "description": {
      "type": "string",
      "maxLength": 200,
      "description": "Description of the group"
     }
    }
   },
   "PageRestResponse": {
    "type": "object",
    "properties": {
     "pageIndex": {
      "type": "integer",
      "format": "int32"
     },
     "pageSize": {
      "type": "integer",
      "format": "int32"
     },
     "total": {
      "type": "integer",
      "format": "int32"
     }
    }
   },
   "UsersSearchRestResponse": {
    "type": "object",
    "properties": {
     "users": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/UserRestResponseForAdmins"
      }
     },
     "page": {
      "$ref": "#/components/schemas/PageRestResponse"
     }
    }
   },
   "DatabaseMigrationsResponse": {
    "type": "object",
    "properties": {
     "status": {
      "type": "string"
     },
     "completedSteps": {
      "type": "integer",
      "format": "int32"
     },
     "totalSteps": {
      "type": "integer",
      "format": "int32"
     },
     "startedAt": {
      "type": "string"
     },
     "message": {
      "type": "string"
     },
     "expectedFinishTimestamp": {
      "type": "string"
     }
    }
   },
   "Health": {
    "type": "object",
    "properties": {
     "status": {
      "type": "string",
      "enum": [
       "GREEN",
       "YELLOW",
       "RED"
      ]
     },
     "causes": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "uniqueItems": true
     }
    }
   },
   "EmailConfigurationSearchRestResponse": {
    "type": "object",
    "properties": {
     "emailConfigurations": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/EmailConfigurationResource"
      }
     },
     "page": {
      "$ref": "#/components/schemas/PageRestResponse"
     }
    }
   },
   "ServiceInfo": {
    "type": "object",
    "properties": {
     "status": {
      "type": "string",
      "enum": [
       "CONNECTION_ERROR",
       "SERVICE_ERROR",
       "SUCCESS",
       "TIMEOUT",
       "UNAUTHORIZED"
      ]
     },
     "isEnabled": {
      "type": "boolean"
     },
     "subscriptionType": {
      "type": "string",
      "enum": [
       "EARLY_ACCESS",
       "PAID",
       "NOT_PAID"
      ]
     }
    }
   },
   "SubscriptionTypeResponse": {
    "type": "object",
    "properties": {
     "subscriptionType": {
      "type": "string",
      "enum": [
       "EARLY_ACCESS",
       "PAID",
       "NOT_PAID"
      ]
     }
    }
   },
   "FixSuggestionIssueResponse": {
    "type": "object",
    "properties": {
     "issueId": {
      "type": "string"
     },
     "aiSuggestion": {
      "type": "string",
      "enum": [
       "AVAILABLE",
       "NOT_AVAILABLE_FILE_LEVEL_ISSUE",
       "NOT_AVAILABLE_UNSUPPORTED_RULE",
       "NOT_AVAILABLE_FILE_SIZE"
      ]
     }
    }
   },
   "ProjectBinding": {
    "type": "object",
    "properties": {
     "id": {
      "type": "string"
     },
     "devOpsPlatformSettingId": {
      "type": "string"
     },
     "projectId": {
      "type": "string"
     },
     "projectKey": {
      "type": "string"
     },
     "repository": {
      "type": "string"
     },
     "slug": {
      "type": "string"
     }
    },
    "required": [
     "devOpsPlatformSettingId",
     "id",
     "projectId",
     "projectKey"
    ]
   },
   "ProjectBindingsSearchRestResponse": {
    "type": "object",
    "properties": {
     "projectBindings": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/ProjectBinding"
      }
     },
     "page": {
      "$ref": "#/components/schemas/PageRestResponse"
     }
    }
   },
   "PermissionMappingsSearchRestResponse": {
    "type": "object",
    "properties": {
     "permissionMappings": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/PermissionMappingsResource"
      }
     }
    }
   },
   "GitlabConfigurationSearchRestResponse": {
    "type": "object",
    "properties": {
     "gitlabConfigurations": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/GitlabConfigurationResource"
      }
     },
     "page": {
      "$ref": "#/components/schemas/PageRestResponse"
     }
    }
   },
   "GithubConfigurationSearchRestResponse": {
    "type": "object",
    "properties": {
     "githubConfigurations": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/GithubConfigurationResource"
      }
     },
     "page": {
      "$ref": "#/components/schemas/PageRestResponse"
     }
    }
   },
   "DopSettingsResource": {
    "type": "object",
    "properties": {
     "id": {
      "type": "string",
      "readOnly": true
     },
     "type": {
      "type": "string",
      "description": "Supported DevOps Platform are: github, gitlab, azure, bitbucketcloud, bitbucket_server"
     },
     "key": {
      "type": "string"
     },
     "url": {
      "type": "string"
     },
     "appId": {
      "type": "string"
     }
    }
   },
   "DopSettingsRestResponse": {
    "type": "object",
    "properties": {
     "dopSettings": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/DopSettingsResource"
      }
     },
     "page": {
      "$ref": "#/components/schemas/PageRestResponse"
     }
    }
   },
   "GroupsSearchRestResponse": {
    "type": "object",
    "properties": {
     "groups": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/GroupRestResponse"
      }
     },
     "page": {
      "$ref": "#/components/schemas/PageRestResponse"
     }
    }
   },
   "GroupsMembershipSearchRestResponse": {
    "type": "object",
    "properties": {
     "groupMemberships": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/GroupMembershipRestResponse"
      }
     },
     "page": {
      "$ref": "#/components/schemas/PageRestResponse"
     }
    }
   },
   "JreInfoRestResponse": {
    "type": "object",
    "properties": {
     "id": {
      "type": "string"
     },
     "filename": {
      "type": "string"
     },
     "sha256": {
      "type": "string"
     },
     "javaPath": {
      "type": "string"
     },
     "os": {
      "type": "string"
     },
     "arch": {
      "type": "string"
     }
    }
   },
   "EngineInfoRestResponse": {
    "type": "object",
    "properties": {
     "filename": {
      "type": "string"
     },
     "sha256": {
      "type": "string"
     }
    }
   },
   "DependenciesSearchRestResponse": {
    "type": "object",
    "properties": {
     "dependencies": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/DependencyResource"
      }
     },
     "page": {
      "$ref": "#/components/schemas/PageRestResponse"
     }
    }
   },
   "DependencyResource": {
    "type": "object",
    "properties": {
     "key": {
      "type": "string"
     },
     "name": {
      "type": "string"
     },
     "longName": {
      "type": "string"
     },
     "description": {
      "type": "string"
     },
     "transitive": {
      "type": "boolean"
     },
     "version": {
      "type": "string"
     }
    }
   },
   "ActiveRule": {
    "type": "object",
    "properties": {
     "ruleKey": {
      "$ref": "#/components/schemas/RuleKey"
     },
     "name": {
      "type": "string"
     },
     "severity": {
      "type": "string"
     },
     "createdAt": {
      "type": "string"
     },
     "updatedAt": {
      "type": "string"
     },
     "internalKey": {
      "type": "string"
     },
     "language": {
      "type": "string"
     },
     "templateRuleKey": {
      "type": "string"
     },
     "qProfileKey": {
      "type": "string"
     },
     "deprecatedKeys": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/RuleKey"
      }
     },
     "params": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/Param"
      }
     },
     "impacts": {
      "type": "object",
      "additionalProperties": {
       "type": "string",
       "enum": [
        "INFO",
        "LOW",
        "MEDIUM",
        "HIGH",
        "BLOCKER"
       ]
      }
     }
    }
   },
   "Param": {
    "type": "object",
    "properties": {
     "key": {
      "type": "string"
     },
     "value": {
      "type": "string"
     }
    }
   },
   "RuleKey": {
    "type": "object",
    "properties": {
     "repository": {
      "type": "string"
     },
     "rule": {
      "type": "string"
     }
    }
   }
  }
 }
}