The authenticated user must have the LICENSED_USER permission to call this resource. */ readonly get: operations["findUsersInGroup"]; readonly put?: never; readonly post?: never; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/api/latest/admin/groups/more-non-members": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get members not in group * @description Retrieves a list of users that are not members of a specified group.
The authenticated user must have the LICENSED_USER permission to call this resource.
*/
readonly get: operations["findUsersNotInGroup"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/admin/groups/remove-user": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
/**
* Remove user from group
* @deprecated
* @description Deprecated since 2.10. Use /rest/users/remove-groups instead.
*
* Remove a user from a group.
*
* The authenticated user must have the ADMIN permission to call this resource.
*
* In the request entity, the context attribute is the group and the itemName is the user.
*/
readonly post: operations["removeUserFromGroup"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/admin/license": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get license details
* @description Retrieves details about the current license, as well as the current status of the system with regards to the installed license. The status includes the current number of users applied toward the license limit, as well as any status messages about the license (warnings about expiry or user counts exceeding license limits).
*
* The authenticated user must have ADMIN permission. Unauthenticated users, and non-administrators, are not permitted to access license details.
*/
readonly get: operations["get_2"];
readonly put?: never;
/**
* Update license
* @description Decodes the provided encoded license and sets it as the active license. If no license was provided, a 400 is returned. If the license cannot be decoded, or cannot be applied, a 409 is returned. Some possible reasons a license may not be applied include:
*
* - It is for a different product
* - It is already expired
*
*
* Otherwise, if the license is updated successfully, details for the new license are returned with a 200 response.
*
* Warning: It is possible to downgrade the license during update, applying a license with a lower number of permitted users. If the number of currently-licensed users exceeds the limits of the new license, pushing will be disabled until the licensed user count is brought into compliance with the new license.
*
* The authenticated user must have SYS_ADMIN permission. ADMIN users may view the current license details, but they may not update the license.
*/
readonly post: operations["updateLicense"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/admin/mail-server": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get mail configuration
* @description Retrieves the current mail configuration.
*
* The authenticated user must have the SYS_ADMIN permission to call this resource.
*/
readonly get: operations["getMailConfig"];
/**
* Update mail configuration
* @description Updates the mail configuration.
*
* The authenticated user must have the SYS_ADMIN permission to call this resource.
*/
readonly put: operations["setMailConfig"];
readonly post?: never;
/**
* Delete mail configuration
* @description Deletes the current mail configuration.
*
* The authenticated user must have the SYS_ADMIN permission to call this resource.
*/
readonly delete: operations["deleteMailConfig"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/admin/mail-server/sender-address": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get server mail address
* @description Retrieves the server email address
*/
readonly get: operations["getSenderAddress"];
/**
* Update server mail address
* @description Updates the server email address
*
* The authenticated user must have the ADMIN permission to call this resource.
*/
readonly put: operations["setSenderAddress"];
readonly post?: never;
/**
* Update mail configuration
* @description Clears the server email address.
*
* The authenticated user must have the ADMIN permission to call this resource.
*/
readonly delete: operations["clearSenderAddress"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/admin/permissions/groups": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get groups with a global permission
* @description Retrieve a page of groups that have been granted at least one global permission.
*
*
* The authenticated user must have ADMIN permission or higher to call this resource.
*/
readonly get: operations["getGroupsWithAnyPermission"];
/**
* Update global permission for group
* @description Promote or demote a group's global permission level. Available global permissions are:
*
*
* - LICENSED_USER
* - PROJECT_CREATE
* - ADMIN
* - SYS_ADMIN
*
* See the Bitbucket Data Center documentation for a detailed explanation of what each permission entails.
*
*
* The authenticated user must have:
*
*
* - ADMIN permission or higher; and
* - the permission they are attempting to grant or higher; and
* - greater or equal permissions than the current permission level of the group (a user may not demote the permission level of a group with higher permissions than them)
*
*
* to call this resource. In addition, a user may not demote a group's permission level if their own permission
* level would be reduced as a result.
*/
readonly put: operations["setPermissionForGroups"];
readonly post?: never;
/**
* Revoke all global permissions for group
* @description Revoke all global permissions for a group.
*
*
*
* The authenticated user must have:
*
*
* - ADMIN permission or higher; and
* - greater or equal permissions than the current permission level of the group (a user may not demote the permission level of a group with higher permissions than them)
*
*
* to call this resource. In addition, a user may not revoke a group's permissions if their own permission level
* would be reduced as a result.
*/
readonly delete: operations["revokePermissionsForGroup"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/admin/permissions/groups/none": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get groups with no global permission
* @description Retrieve a page of groups that have no granted global permissions.
*
*
* The authenticated user must have ADMIN permission or higher to call this resource.
*/
readonly get: operations["getGroupsWithoutAnyPermission"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/admin/permissions/users": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get users with a global permission
* @description Retrieve a page of users that have been granted at least one global permission.
*
*
* The authenticated user must have ADMIN permission or higher to call this resource.
*/
readonly get: operations["getUsersWithAnyPermission"];
/**
* Update global permission for user
* @description Promote or demote the global permission level of a user. Available global permissions are:
*
*
* - LICENSED_USER
* - PROJECT_CREATE
* - ADMIN
* - SYS_ADMIN
*
*
* See the Bitbucket Data Center documentation for a detailed explanation of what each permission entails.
*
*
* The authenticated user must have:
*
*
* - ADMIN permission or higher; and
* - the permission they are attempting to grant; and
* - greater or equal permissions than the current permission level of the user (a user may not demote the permission level of a user with higher permissions than them)
*
*
* to call this resource. In addition, a user may not demote their own permission level.
*/
readonly put: operations["setPermissionForUsers"];
readonly post?: never;
/**
* Revoke all global permissions for user
* @description Revoke all global permissions for a user.
*
*
* The authenticated user must have:
*
*
* - ADMIN permission or higher; and
* - greater or equal permissions than the current permission level of the user (a user may not demote the permission level of a user with higher permissions than them)
*
*
* to call this resource. In addition, a user may not demote their own permission level.
*/
readonly delete: operations["revokePermissionsForUser"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/admin/permissions/users/none": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get users with no global permission
* @description Retrieve a page of users that have no granted global permissions.
*
*
* The authenticated user must have ADMIN permission or higher to call this resource.
*/
readonly get: operations["getUsersWithoutAnyPermission"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/admin/pull-requests/{scmId}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get merge strategies
* @description Retrieve the merge strategies available for this instance.
*
* The user must be authenticated to call this resource.
*/
readonly get: operations["getMergeConfig"];
readonly put?: never;
/**
* Update merge strategies
* @description Update the pull request merge strategies for the context repository.
*
* The authenticated user must have ADMIN permission to call this resource.
*
* Only the strategies provided will be enabled, only one may be set to default
*
* The commit message template will not be updated if not provided, and will be deleted if the `commitMessageTemplate` attribute is empty, i.e: `commitMessageTemplate: {}`.
*
* An explicitly set pull request merge strategy configuration can be deleted by POSTing a document with an empty `mergeConfig` attribute. i.e:
* ```
* {
* "mergeConfig": {}
* }
* ```
*
* Upon completion of this request, the effective configuration will be the default configuration.
*/
readonly post: operations["setMergeConfig"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/admin/rate-limit/history": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get rate limit history
* @description Retrieves the recent rate limit history for the instance.
*
* The authenticated user must have the ADMIN permission to call this resource.
*/
readonly get: operations["getHistory"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/admin/rate-limit/settings": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get rate limit settings
* @description Retrieves the rate limit settings for the instance.
*
* The user must be authenticated to call this resource.
*/
readonly get: operations["getSettings_2"];
/**
* Set rate limit
* @description Sets the rate limit settings for the instance.
*
* The authenticated user must have ADMIN permission to call this resource.
*/
readonly put: operations["setSettings_2"];
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/admin/rate-limit/settings/users": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get rate limit settings for user
* @description Retrieves the user-specific rate limit settings for the given user.
*
* The authenticated user must have ADMIN permission to call this resource.
*/
readonly get: operations["getAllRateLimitSettings"];
readonly put?: never;
/**
* Set rate limit settings for users
* @description Sets the given rate limit settings for the given users.
*
* The authenticated user must have ADMIN permission to call this resource.
*/
readonly post: operations["set_2"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/admin/rate-limit/settings/users/{userSlug}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get user specific rate limit settings
* @description Retrieves the user-specific rate limit settings for the given user.
*
* To call this resource, the user must be authenticated and either have ADMIN permission or be the same user as the one whose settings are requested. A user with ADMIN permission cannot get the settings of a user with SYS_ADMIN permission.
*/
readonly get: operations["get_6"];
/**
* Set rate limit settings for user
* @description Sets the given rate limit settings for the given user.
*
* The authenticated user must have ADMIN permission to call this resource.
*/
readonly put: operations["set_3"];
readonly post?: never;
/**
* Delete user specific rate limit settings
* @description Deletes the user-specific rate limit settings for the given user.
*
* The authenticated user must have ADMIN permission to call this resource.
*/
readonly delete: operations["delete_8"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/admin/user-directories": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get directories
* @description Retrieve a list of active directories.
*
* The authenticated user must have the ADMIN permission to call this resource.
*/
readonly get: operations["getUserDirectories"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/admin/users": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get users
* @description Retrieve a page of users.
*
* The authenticated user must have the LICENSED_USER permission to call this resource.
*/
readonly get: operations["getUsers_1"];
/**
* Update user details
* @description Update a user's details.
*
* The authenticated user must have the ADMIN permission to call this resource.
*/
readonly put: operations["updateUserDetails"];
/**
* Create user
* @description Creates a new user from the assembled query parameters.
*
* The default group can be used to control initial permissions for new users, such as granting users the ability to login or providing read access to certain projects or repositories. If the user is not added to the default group, they may not be able to login after their account is created until explicit permissions are configured.
*
* The authenticated user must have the ADMIN permission to call this resource.
*/
readonly post: operations["createUser"];
/**
* Remove user
* @description Deletes the specified user, removing them from the system. This also removes any permissions that may have been granted to the user.
*
* A user may not delete themselves, and a user with ADMIN permissions may not delete a user with SYS_ADMINpermissions.
*
* The authenticated user must have the ADMIN permission to call this resource.
*/
readonly delete: operations["deleteUser"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/admin/users/add-group": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
/**
* Add user to group
* @deprecated
* @description Deprecated since 2.10. Use /rest/users/add-groups instead.
*
* Add a user to a group. This is very similar to groups/add-user, but with the context and itemName attributes of the supplied request entity reversed. On the face of it this may appear redundant, but it facilitates a specific UI component in the application.
*
* In the request entity, the context attribute is the user and the itemName is the group.
*
* The authenticated user must have the ADMIN permission to call this resource.
*/
readonly post: operations["addGroupToUser"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/admin/users/add-groups": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
/**
* Add user to groups
* @description Add a user to one or more groups.
*
* The authenticated user must have the ADMIN permission to call this resource.
*/
readonly post: operations["addUserToGroups"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/admin/users/captcha": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
readonly post?: never;
/**
* Clear CAPTCHA for user
* @description Clears any CAPTCHA challenge that may constrain the user with the supplied username when they authenticate. Additionally any counter or metric that contributed towards the user being issued the CAPTCHA challenge (for instance too many consecutive failed logins) will also be reset.
*
* The authenticated user must have the ADMIN permission to call this resource, and may not clear the CAPTCHA of a user with greater permissions than themselves.
*/
readonly delete: operations["clearUserCaptchaChallenge"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/admin/users/credentials": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
/**
* Set password for user
* @description Update a user's password.
*
* The authenticated user must have the ADMIN permission to call this resource, and may not update the password of a user with greater permissions than themselves.
*/
readonly put: operations["updateUserPassword"];
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/admin/users/erasure": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Check user removal
* @description Validate if a user can be erased.
*
* A username is only valid for erasure if it exists as the username of a deleted user. This endpoint will return an appropriate error response if the supplied username is invalid for erasure.
*
* This endpoint does not perform the actual user erasure, and will not modify the application in any way.
*
* The authenticated user must have the ADMIN permission to call this resource.
*/
readonly get: operations["validateErasable"];
readonly put?: never;
/**
* Erase user information
* @description Erases personally identifying user data for a deleted user.
*
* References in the application to the original username will be either removed or updated to a new non-identifying username. Refer to the support guide for details about what data is and isn't erased.
*
* User erasure can only be performed on a deleted user. If the user has not been deleted first then this endpoint will return a bad request and no erasure will be performed.
*
* Erasing user data is irreversible and may lead to a degraded user experience. This method should not be used as part of a standard user deletion and cleanup process.
*
* Plugins can participate in user erasure by defining a <user-erasure-handler> module. If one or more plugin modules fail, an error summary of the failing modules is returned.
*
* The authenticated user must have the ADMIN permission to call this resource.
*/
readonly post: operations["eraseUser"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/admin/users/more-members": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get groups for user
* @description Retrieves a list of users that are not members of a specified group.
The authenticated user must have the LICENSED_USER permission to call this resource. */ readonly get: operations["findGroupsForUser"]; readonly put?: never; readonly post?: never; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/api/latest/admin/users/more-non-members": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Find other groups for user * @description Retrieves a list of groups the specified user is not a member of.
The authenticated user must have the LICENSED_USER permission to call this resource.
*/
readonly get: operations["findOtherGroupsForUser"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/admin/users/remove-group": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
/**
* Remove user from group
* @description Remove a user from a group. This is very similar to groups/remove-user, but with the context and itemName attributes of the supplied request entity reversed. On the face of it this may appear redundant, but it facilitates a specific UI component in the application.
*
* In the request entity, the context attribute is the user and the itemName is the group.
*
* The authenticated user must have the ADMIN permission to call this resource.
*/
readonly post: operations["removeGroupFromUser"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/admin/users/rename": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
/**
* Rename user
* @description Rename a user.
*
* The authenticated user must have the ADMIN permission to call this resource.
*/
readonly post: operations["renameUser"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/application-properties": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get application properties
* @description Retrieve version information and other application properties.
*
* No authentication is required to call this resource.
*/
readonly get: operations["getApplicationProperties"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/build/capabilities": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get build capabilities
* @description Returns the build capabilities of this instance
*/
readonly get: operations["getCapabilities"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/dashboard/pull-request-suggestions": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get pull request suggestions
* @description Retrieves a page of suggestions for pull requests that the currently authenticated user may wish to raise. Such suggestions are based on ref changes occurring and so contain the ref change that prompted the suggestion plus the time the change event occurred. Changes will be returned in descending order based on the time the change that prompted the suggestion occurred.
*
* Note that although the response is a page object, the interface does not support paging, however a limit can be applied to the size of the returned page.
*/
readonly get: operations["getPullRequestSuggestions"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/dashboard/pull-requests": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get pull requests for a user
* @description Retrieve a page of pull requests where a user is involved as either a reviewer, author or a participant. The request may be filtered by pull request state, role or participant status.
*/
readonly get: operations["getPullRequests_1"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/deployment/capabilities": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get deployment capabilities
* @description Returns the Deployment capabilities of this instance
*/
readonly get: operations["getCapabilities_1"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/groups": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get group names
* @description Retrieve a page of group names.
*
* The authenticated user must have LICENSED_USER permission or higher to call this resource.
*/
readonly get: operations["getGroups"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/hook-scripts": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
/**
* Create a new hook script
* @description Create a new hook script.
*
* This endpoint requires **SYS_ADMIN** permission.
*/
readonly post: operations["createHookScript"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/hook-scripts/{scriptId}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get a hook script
* @description Retrieves a hook script by ID.
*/
readonly get: operations["getHookScript"];
/**
* Update a hook script
* @description Updates a hook script.
*
* This endpoint requires **SYS_ADMIN** permission.
*/
readonly put: operations["updateHookScript"];
readonly post?: never;
/**
* Delete a hook script.
* @description Deletes a registered hook script.
*
* This endpoint requires **SYS_ADMIN** permission.
*/
readonly delete: operations["deleteHookScript"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/hook-scripts/{scriptId}/content": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get hook script content
* @description Retrieves the hook script content.
*
* This endpoint requires **SYS_ADMIN** permission.
*/
readonly get: operations["read"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/hooks/{hookKey}/avatar": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get project avatar
* @description Retrieve the avatar for the project matching the supplied moduleKey.
*/
readonly get: operations["getAvatar"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/inbox/pull-requests": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get pull requests in inbox
* @description Returns a page of pull requests in the user's inbox.
*/
readonly get: operations["getPullRequests_2"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/inbox/pull-requests/count": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get total number of pull requests in inbox
* @description Returns the total number of pull requests in the user's inbox
*/
readonly get: operations["getPullRequestCount"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/labels": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get all labels
* @description Returns a paged response of all the labels in the system.
*
* The user needs to be authenticated to use this resource.
*/
readonly get: operations["getLabels"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/labels/{labelName}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get label
* @description Returns a label.
*
* The user needs to be authenticated to use this resource.
*/
readonly get: operations["getLabel"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/labels/{labelName}/labeled": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get labelables for label
* @description Returns a page of labelables for a given label.
*
* Only labelables that the authenticated user has view access to will be returned.
*/
readonly get: operations["getLabelables"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/logs/logger/{loggerName}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get current log level
* @description Retrieve the current log level for a given logger.
*
* The authenticated user must have ADMIN permission or higher to call this resource.
*/
readonly get: operations["getLevel"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/logs/logger/{loggerName}/{levelName}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
/**
* Set log level
* @description Set the current log level for a given logger.
*
* The authenticated user must have ADMIN permission or higher to call this resource.
*/
readonly put: operations["setLevel"];
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/logs/rootLogger": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get root log level
* @description Retrieve the current log level for the root logger.
*
* The authenticated user must have ADMIN permission or higher to call this resource.
*/
readonly get: operations["getRootLevel"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/logs/rootLogger/{levelName}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
/**
* Set root log level
* @description Set the current log level for the root logger.
*
* The authenticated user must have ADMIN permission or higher to call this resource.
*/
readonly put: operations["setRootLevel"];
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/markup/preview": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
/**
* Preview markdown render
* @description Preview generated HTML for the given markdown content.
*
* Only authenticated users may call this resource.
*/
readonly post: operations["preview"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/migration/exports": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
/**
* Start export job
* @description Starts a background job that exports the selected repositories.
*
* Only 2 concurrent exports are supported _per cluster node_. If a request ends up on a node that is already running that many export jobs, the request will be rejected and an error returned.
*
* The response includes a description of the job that has been started, and its ID can be used to query these details again, including the current progress, warnings and errors that occurred while processing the job, and to interrupt and cancel the execution of this job.
*
* The request to start an export is similar to the one for previewing an export. Additionally, it accepts an optional parameter, `exportLocation`, which can be used to specify a _relative_ path within `data/migration/export` in the shared home directory. No locations outside of that directory will be accepted for exports.
*
* There are essentially three ways to select repositories for export. Regardless of which you use, a few general rules apply:
*
* - You can supply a list of selectors. The selection will be additive.
* - Repositories that are selected more than once due to overlapping selectors will be de-duplicated and effectively exported only once.
* - For every selected repository, its full fork hierarchy will be considered selected, even if parts of that hierarchy would otherwise not be matched by the provided selectors. For example, when you explicitly select a single repository only, but that repository is a fork, then its origin will be exported (and eventually imported), too.
*
* Now, a single repository can be selected like this:
*
* ```
*
*
*
* {
* "projectKey": "PRJ",
* "slug": "my-repo"
* }
*
* ```
*
* Second, all repositories in a specific project can be selected like this:
*
* ```
*
*
*
* {
* "projectKey": "PRJ",
* "slug": *"
* }
*
* ```
*
* And third, all projects and repositories in the system would be selected like this:
*
* ```
*
*
*
* {
* "projectKey": "*",
* "slug": *"
* }
*
* ```
*
* The authenticated user must have **ADMIN** permission or higher to call this resource.
*/
readonly post: operations["startExport"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/migration/exports/{jobId}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get export job details
* @description Gets the details, including the current status and progress, of the export job identified by the given ID.
*
* The authenticated user must have **ADMIN** permission or higher to call this resource.
*/
readonly get: operations["getExportJob"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/migration/exports/{jobId}/cancel": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
/**
* Cancel export job
* @description Requests the cancellation of an export job.
*
* The request to cancel a job will be processed successfully if the job is actually still running. If it has already finished (successfully or with errors) or if it has already been canceled before, then an error will be returned.
*
* There might be a small delay between accepting the request and actually cancelling the job. In most cases, the delay will be close to instantaneously. In the unlikely case of communication issues across a cluster, it can however take a few seconds to cancel a job.
*
* A client should always actively query the job status to confirm that a job has been successfully canceled.
*
* The authenticated user must have **ADMIN** permission or higher to call this resource.
*/
readonly post: operations["cancelExportJob"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/migration/exports/{jobId}/messages": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get job messages
* @description Gets the messages generated by the job.
*
* Without any filter, all messages will be returned, but the response can optionally be filtered for the following severities. The severity parameter can be repeated to include multiple severities in one response.
*
* - INFO
* - WARN
* - ERROR
*
* The authenticated user must have **ADMIN** permission or higher to call this resource.
*/
readonly get: operations["getExportJobMessages"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/migration/exports/preview": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
/**
* Preview export
* @description Enumerates the projects and repositories that would be exported for a given export request.
*
* All affected repositories will be enumerated explicitly, and while projects are listed as individual items in responses from this endpoint, their presence does not imply that all their repositories are included.
*
* While this endpoint can be used to verify that all selectors in the request apply as intended, it should be noted that a subsequent, actual export might contain a different set of repositories, as they might have been added or deleted in the meantime.
*
* Note that the overall response from this endpoint can become very large when a lot of repositories end up in the selection. This is why the server is streaming the response while it is being generated (as opposed to creating it in memory and then sending it all at once) and it can be consumed in a streaming way, too.
*
* Also, due to the potential size of the response, projects and repositories are listed with fewer details than in other REST responses.
*
* For a more detailed description of selectors, see the endpoint documentation for starting an export.
*
* The authenticated user must have **ADMIN** permission or higher to call this resource.
*/
readonly post: operations["previewExport"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/migration/imports": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
/**
* Start import job
* @description Starts a background job that imports the specified archive.
*
* Only 1 import at a time is supported _per cluster_. If another request is made while an import is already running, the request will be rejected and an error returned.
*
* The path in the request must point to a valid archive file. The file must be located within the `data/migration/import` directory in the shared home directory.
*
* The authenticated user must have **ADMIN** permission or higher to call this resource.
*/
readonly post: operations["startImport"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/migration/imports/{jobId}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get import job status
* @description Gets the details, including the current status and progress, of the import job identified by the given ID.
*
* The authenticated user must have **ADMIN** permission or higher to call this resource.
*/
readonly get: operations["getImportJob"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/migration/imports/{jobId}/cancel": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
/**
* Cancel import job
* @description Requests the cancellation of an import job.
*
* The request to cancel a job will be processed successfully if the job is actually still running. If it has already finished (successfully or with errors) or if it has already been canceled before, then an error will be returned.
*
* Note that import jobs are not canceled as instantaneously as export jobs. Rather, once the request has been accepted, there are a number of checkpoints at which the job will actually apply it and stop. This is to keep the system in a reasonably consistent state:
*
* - After the current fork hierarchy has been imported and verified.
* - Before the next repository is imported.
* - Before the next pull request is imported.
*
* A client should always actively query the job status to confirm that a job has been successfully canceled.
*
* The authenticated user must have **ADMIN** permission or higher to call this resource.
*/
readonly post: operations["cancelImportJob"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/migration/imports/{jobId}/messages": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get import job messages
* @description Gets the messages generated by the job.
*
* Without any filter, all messages will be returned, but the response can optionally be filtered for the following severities. The severity parameter can be repeated to include multiple severities in one response.
*
* - INFO
* - WARN
* - ERROR
*
* The authenticated user must have **ADMIN** permission or higher to call this resource.
*/
readonly get: operations["getImportJobMessages"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/migration/mesh": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
/**
* Start Mesh migration job
* @description Starts a background job that migrates selected projects/repositories to Mesh.
*
* Only 1 job is supported _per cluster_.
*
* The response includes a description of the job that has been started, and its ID can be used to query these details again, including the current progress, and to interrupt and cancel the execution of this job.
*
* The request to start a migration is similar to the one for previewing a migration.
*
* There are essentially three ways to select repositories for migration. Regardless of which you use, a few general rules apply:
*
* - You can supply a list of repository IDs and project IDs. The selection will be additive. All repositories in the system are migrated if both lists are empty. - Repositories that are selected more than once due to overlapping IDs will be de-duplicated and effectively migrated only once. - For every selected repository, its full fork hierarchy will be considered selected, even if parts of that hierarchy would otherwise not be matched by the provided IDs. For example, when you explicitly select a single repository only, but that repository is a fork, then its origin will be migrated too.
*
* Now, a single repository can be selected like this:
*
* ```
*
* {
* "repositoryIds": [1]
* }
* ```
*
* Multiple repositories can be selected like this:
*
*
*
* ```
*
* {
* "repositoryIds": [1, 2]
* }
* ```
*
* Second, all repositories in a specific project can be selected like this:
*
*
*
* ```
*
* {
* "projectIds": [1]
* }
* ```
*
* And third, all projects and repositories in the system would be selected like this:
*
*
*
* ```
*
* {
* "projectIds": [],
* "repositoryIds": []
* }
* ```
*
* The authenticated user must have **SYS_ADMIN** permission to call this resource.
*/
readonly post: operations["startMeshMigration"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/migration/mesh/{jobId}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get Mesh migration job details
* @description Gets the details, including the current status and progress, of the job identified by the given ID.
*
* The authenticated user must have **SYS_ADMIN** permission to call this resource.
*/
readonly get: operations["getMeshMigrationJob"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/migration/mesh/{jobId}/cancel": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
/**
* Cancel Mesh migration job
* @description Requests the cancellation of a migration job.
*
* The request to cancel a job will be processed successfully if the job is actually still running. If it has already finished (successfully or with errors) or if it has already been canceled before, then an error will be returned.
*
* There might be a small delay between accepting the request and actually cancelling the job. In most cases, the delay will be close to instantaneously. In the unlikely case of communication issues across a cluster, it can however take a few seconds to cancel a job.
*
* A client should always actively query the job status to confirm that a job has been successfully canceled.
*
* The authenticated user must have **SYS_ADMIN** permission to call this resource.
*/
readonly post: operations["cancelMeshMigrationJob"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/migration/mesh/{jobId}/messages": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get Mesh migration job messages
* @description Gets the messages generated by the job.
*
* Without any filter, all messages will be returned, but the response can optionally be filtered for the following severities. The severity parameter can be repeated to include multiple severities in one response.
*
* - INFO
* - WARN
* - ERROR
*
*
* The authenticated user must have **SYS_ADMIN** permission to call this resource.
*/
readonly get: operations["getMeshMigrationJobMessages"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/migration/mesh/{jobId}/summary": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get Mesh migration job summary
* @description Gets the summary, including the queue status and progress, of a Mesh migration job.
*
* The authenticated user must have **SYS_ADMIN** permission to call this resource.
*/
readonly get: operations["getMeshMigrationJobSummary"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/migration/mesh/preview": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
/**
* Preview Mesh migration
* @description Enumerates the projects and repositories that would be migrated for a given request.
*
* All affected repositories will be enumerated explicitly, and while projects are listed as individual items in responses from this endpoint, their presence does not imply that all their repositories are included.
*
* While this endpoint can be used to verify that all selectors in the request apply as intended, it should be noted that a subsequent, actual export might contain a different set of repositories, as they might have been added or deleted in the meantime.
*
* Note that the overall response from this endpoint can become very large when a lot of repositories end up in the selection. This is why the server is streaming the response while it is being generated (as opposed to creating it in memory and then sending it all at once) and it can be consumed in a streaming way, too.
*
* Also, due to the potential size of the response, projects and repositories are listed with fewer details than in other REST responses.
*
* The authenticated user must have **SYS_ADMIN** permission to call this resource.
*/
readonly post: operations["previewMeshMigration"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/migration/mesh/repos": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Find repositories by Mesh migration state
* @description Searches for repositories in the system matching the specified criteria and enriches their MeshMigrationQueueState migration state if a migration is currently in progress.
*
* The currently active migration can optionally be specified by passing a migrationId, if known. If this isn't passed, an attempt is made to locate the active migration and its ID is used.
*
* If a migration is currently active, only repositories that are a part of the migration are filtered and returned. Otherwise, all repositories in the systems are filtered and returned.
*
* Filtering by state is ignored when no migration is currently in progress. In such a case, results are not enriched with their MeshMigrationQueueState migration state.
*
* The authenticated user must have **SYS_ADMIN** permission to call this resource.
*/
readonly get: operations["searchMeshMigrationRepos"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/migration/mesh/summaries": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get all Mesh migration job summaries
* @description Retrieve a page of Mesh migration job summaries. Jobs are ordered by when they were started, newest first.
*
* The authenticated user must have **SYS_ADMIN** permission to call this resource.
*/
readonly get: operations["getAllMeshMigrationSummaries"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/migration/mesh/summary": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get summary for Mesh migration job
* @description Gets the summary, including the queue status and progress, of the currently active Mesh migration job.
*
* The authenticated user must have **SYS_ADMIN** permission to call this resource.
*/
readonly get: operations["getActiveMeshMigrationSummary"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/profile/recent/repos": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get recently accessed repositories
* @description Retrieve a page of recently accessed repositories for the currently authenticated user.
*
* Repositories are ordered from most recently to least recently accessed.
Only authenticated users may call this resource.
*/
readonly get: operations["getRepositoriesRecentlyAccessed"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get projects
* @description Retrieve a page of projects.
*
* Only projects for which the authenticated user has the PROJECT_VIEW permission will be returned.
*/
readonly get: operations["getProjects"];
readonly put?: never;
/**
* Create a new project
* @description Create a new project.
*
* To include a custom avatar for the project, the project definition should contain an additional attribute with the key avatar and the value a data URI containing Base64-encoded image data. The URI should be in the following format:
data:(content type, e.g. image/png);base64,(data)If the data is not Base64-encoded, or if a character set is defined in the URI, or the URI is otherwise invalid, project creation will fail. * * The authenticated user must have PROJECT_CREATE permission to call this resource. */ readonly post: operations["createProject"]; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; readonly "/api/latest/projects/{projectKey}": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; /** * Get a project * @description Retrieve the project matching the supplied projectKey. * * The authenticated user must have PROJECT_VIEW permission for the specified project to call this resource. */ readonly get: operations["getProject"]; /** * Update project * @description Update the project matching the projectKey supplied in the resource path. * * To include a custom avatar for the updated project, the project definition should contain an additional attribute with the key
avatar and the value a data URI containing Base64-encoded image data. The URI should be in the following format:
* ``` data:(content type, e.g. image/png);base64,(data)```
*
* If the data is not Base64-encoded, or if a character set is defined in the URI, or the URI is otherwise invalid, project creation will fail.
*
* The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.
*/
readonly put: operations["updateProject"];
readonly post?: never;
/**
* Delete project
* @description Delete the project matching the supplied projectKey.
*
* The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.
*/
readonly delete: operations["deleteProject"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/avatar.png": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get avatar for project
* @description Retrieve the avatar for the project matching the supplied projectKey.
*
* The authenticated user must have PROJECT_VIEW permission for the specified project to call this resource.
*/
readonly get: operations["getProjectAvatar"];
readonly put?: never;
/**
* Update project avatar
* @description Update the avatar for the project matching the supplied projectKey.
*
* This resource accepts POST multipart form data, containing a single image in a form-field named 'avatar'.
*
* There are configurable server limits on both the dimensions (1024x1024 pixels by default) and uploaded file size (1MB by default). Several different image formats are supported, but PNG and JPEG are preferred due to the file size limit.
*
* This resource has Cross-Site Request Forgery (XSRF) protection. To allow the request to pass the XSRF check the caller needs to send an X-Atlassian-Token HTTP header with the value no-check.
*
* An example curl request to upload an image name 'avatar.png' would be: ```curl -X POST -u username:password -H "X-Atlassian-Token: no-check" http://example.com/rest/api/1.0/projects/STASH/avatar.png -F avatar=@avatar.png ```
*
* The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.
*/
readonly post: operations["uploadAvatar"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/hook-scripts": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get configured hook scripts
* @description Return a page of hook scripts configured for the specified project.
*
* This endpoint requires **PROJECT_ADMIN** permission.
*/
readonly get: operations["getConfigurations"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/hook-scripts/{scriptId}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
/**
* Create/update a hook script
* @description Creates/updates the hook script configuration for the provided hook script and project.
*
* This endpoint requires **PROJECT_ADMIN** permission.
*/
readonly put: operations["setConfiguration"];
readonly post?: never;
/**
* Remove a hook script
* @description Removes the hook script from the set of hook scripts configured to run in all repositories under the project.
*
* This endpoint requires **PROJECT_ADMIN** permission.
*/
readonly delete: operations["removeConfiguration"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/permissions": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
readonly post?: never;
/**
* Revoke project permissions
* @description Revoke all permissions for the specified project for the given groups and users.
*
* The authenticated user must have PROJECT_ADMIN permission for the specified project or a higher global permission to call this resource.
*
* In addition, a user may not revoke a group's permission if their own permission would be revoked as a result, nor may they revoke their own permission unless they have a global permission that already implies that permission.
*/
readonly delete: operations["revokePermissions"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/permissions/{permission}/all": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Check default project permission
* @description Check whether the specified permission is the default permission (granted to all users) for a project.
*
* The authenticated user must have PROJECT_ADMIN permission for the specified project or a higher global permission to call this resource.
*/
readonly get: operations["hasAllUserPermission"];
readonly put?: never;
/**
* Grant project permission
* @description Grant or revoke a project permission to all users, i.e. set the default permission.
*
*
* The authenticated user must have PROJECT_ADMIN permission for the specified project or a higher
* global permission to call this resource.
*/
readonly post: operations["modifyAllUserPermission"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/permissions/groups": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get groups with permission to project
* @description Retrieve a page of groups that have been granted at least one permission for the specified project.
*
* The authenticated user must have PROJECT_ADMIN permission for the specified project or a higher global permission to call this resource.
*/
readonly get: operations["getGroupsWithAnyPermission_1"];
/**
* Update group project permission
* @description Promote or demote a group's permission level for the specified project.
*
* The authenticated user must have PROJECT_ADMIN permission for the specified project or a higher global permission to call this resource. In addition, a user may not demote a group's permission level if theirown permission level would be reduced as a result.
*/
readonly put: operations["setPermissionForGroups_1"];
readonly post?: never;
/**
* Revoke group project permission
* @description Revoke all permissions for the specified project for a group.
*
* The authenticated user must have PROJECT_ADMIN permission for the specified project or a higher global permission to call this resource.
*
* In addition, a user may not revoke a group's permissions if it will reduce their own permission level.
*/
readonly delete: operations["revokePermissionsForGroup_1"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/permissions/groups/none": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get groups without project permission
* @description Retrieve a page of groups that have no granted permissions for the specified project.
*
* The authenticated user must have PROJECT_ADMIN permission for the specified project or a higher
*/
readonly get: operations["getGroupsWithoutAnyPermission_1"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/permissions/search": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Search project permissions
* @description Search direct and implied permissions of principals (users and groups). This endpoint returns a superset of the results returned by the /users and /groups endpoints because it allows filtering by global permissions too.
*
* The authenticated user must have PROJECT_ADMIN permission for the specified project or a higher global permission to call this resource.
*/
readonly get: operations["searchPermissions"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/permissions/users": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get users with permission to project
* @description Retrieve a page of users that have been granted at least one permission for the specified project.
*
* The authenticated user must have PROJECT_ADMIN permission for the specified project or a higher global permission to call this resource.
*/
readonly get: operations["getUsersWithAnyPermission_1"];
/**
* Update user project permission
* @description Promote or demote a user's permission level for the specified project.
*
*
* The authenticated user must have PROJECT_ADMIN permission for the specified project or a higher global permission to call this resource. In addition, a user may not reduce their own permission level unless they have a global permission that already implies that permission.
*/
readonly put: operations["setPermissionForUsers_1"];
readonly post?: never;
/**
* Revoke user project permission
* @description Revoke all permissions for the specified project for a user.
*
* The authenticated user must have PROJECT_ADMIN permission for the specified project or a higher global permission to call this resource.
*
* In addition, a user may not revoke their own project permissions if they do not have a higher global permission.
*/
readonly delete: operations["revokePermissionsForUser_1"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/permissions/users/none": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get users without project permission
* @description Retrieve a page of licensed users that have no granted permissions for the specified project.
*
* The authenticated user must have PROJECT_ADMIN permission for the specified project or a higher global permission to call this resource.
*/
readonly get: operations["getUsersWithoutPermission"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get repositories for project
* @description Retrieve repositories from the project corresponding to the supplied projectKey.
*
* The authenticated user must have PROJECT_READ permission for the specified project to call this resource.
*/
readonly get: operations["getRepositories"];
readonly put?: never;
/**
* Create repository
* @description Create a new repository. Requires an existing project in which this repository will be created. The only parameters which will be used are name and scmId.
*
* The authenticated user must have REPO_CREATE permission or higher, for the context project to call this resource.
*/
readonly post: operations["createRepository"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get repository
* @description Retrieve the repository matching the supplied projectKey and repositorySlug.
*
* The authenticated user must have REPO_READ permission for the specified repository to call this resource.
*/
readonly get: operations["getRepository"];
/**
* Update repository
* @description Update the repository matching the repositorySlug supplied in the resource path.
*
* The repository's slug is derived from its name. If the name changes the slug may also change.
*
* This resource can be used to change the repository's default branch by specifying a new default branch in the request. For example: "defaultBranch":"main"
*
* This resource can be used to move the repository to a different project by specifying a new project in the request. For example: "project":{"key":"NEW_KEY"}
*
* The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
*/
readonly put: operations["updateRepository"];
/**
* Fork repository
* @description Create a new repository forked from an existing repository.
*
* The JSON body for this POST is not required to contain any properties. Even the name may be omitted. The following properties will be used, if provided:
*
* - "name":"Fork name" - Specifies the forked repository's name
* - Defaults to the name of the origin repository if not specified
* - "defaultBranch":"main" - Specifies the forked repository's default branch
* - Defaults to the origin repository's default branch if not specified
* - "project":{"key":"TARGET_KEY"} - Specifies the forked repository's target project by key
* - Defaults to the current user's personal project if not specified
*
*
* The authenticated user must have REPO_READ permission for the specified repository and PROJECT_ADMIN on the target project to call this resource. Note that users always have PROJECT_ADMIN permission on their personal projects.
*/
readonly post: operations["forkRepository"];
/**
* Delete repository
* @description Schedule the repository matching the supplied projectKey and repositorySlug to be deleted.
*
* The authenticated user must have sufficient permissions specified by the repository delete policy to call this resource. The default permission required is REPO_ADMIN permission.
*/
readonly delete: operations["deleteRepository"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/archive": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Stream archive of repository
* @description Streams an archive of the repository's contents at the requested commit. If no `at=` commit is requested, an archive of the default branch is streamed.
*
* The filename= query parameter may be used to specify the exact filename to include in the "Content-Disposition" header. If an explicit filename is not provided, one will be automatically generated based on what is being archived. Its format depends on the at= value:
*
* - No at= commit: <slug>-<default-branch-name>@<commit>.<format>; e.g. example-master@43c2f8a0fe8.zip
* - at=sha: <slug>-<at>.<format>; e.g. example-09bcbb00100cfbb5310fb6834a1d5ce6cac253e9.tar.gz
* - at=branchOrTag: <slug>-<branchOrTag>@<commit>.<format>; e.g. example-feature@bbb225f16e1.tar
*
* - If the branch or tag is qualified (e.g. refs/heads/master, the short name (master) will be included in the filename
* - If the branch or tag's short name includes slashes (e.g. release/4.6), they will be converted to hyphens in the filename (release-4.5)
*
*
*
*
* Archives may be requested in the following formats by adding the format= query parameter:
*
* - zip: A zip file using standard compression (Default)
* - tar: An uncompressed tarball
* - tar.gz or tgz: A GZip-compressed tarball
*
*
* The contents of the archive may be filtered by using the path= query parameter to specify paths to include. path= may be specified multiple times to include multiple paths.
*
* The prefix= query parameter may be used to define a directory (or multiple directories) where the archive's contents should be placed. If the prefix does not end with /, one will be added automatically. The prefix is always treated as a directory; it is not possible to use it to prepend characters to the entries in the archive.
*
* Archives of public repositories may be streamed by any authenticated or anonymous user. Streaming archives for non-public repositories requires an authenticated user with at least REPO_READ permission.
*/
readonly get: operations["getArchive"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/attachments/{attachmentId}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get an attachment
* @description Retrieve the attachment.
*
* The authenticated user must have REPO_READ permission for the specified repository that is associated to the attachment.
*
* Range requests (see IETF RFC7233) are supported. However only a single range issupported. If multiple ranges are passed the ranges will be ignored and the entire content will be returned in the response.
*/
readonly get: operations["getAttachment"];
readonly put?: never;
readonly post?: never;
/**
* Delete an attachment
* @description Delete an attachment.
*
* The user must be authenticated and have REPO_ADMIN permission for the specified repository.
*/
readonly delete: operations["deleteAttachment"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/attachments/{attachmentId}/metadata": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get attachment metadata
* @description Retrieve the attachment metadata.
*
* The authenticated user must have REPO_READ permission for the specified repository that is associated to the attachment that has the attachment metadata.
*/
readonly get: operations["getAttachmentMetadata"];
/**
* Save attachment metadata
* @description Save attachment metadata.
*
* The authenticated user must have REPO_READ permission for the specified repository that is associated to the attachment that has the attachment metadata.
*/
readonly put: operations["saveAttachmentMetadata"];
readonly post?: never;
/**
* Delete attachment metadata
* @description Delete attachment metadata.
*
* The user must be authenticated and have REPO_ADMIN permission for the specified repository.
*/
readonly delete: operations["deleteAttachmentMetadata"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/branches": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Find branches
* @description Retrieve the branches matching the supplied filterText param.
*
* The authenticated user must have REPO_READ permission for the specified repository to call this resource.
*/
readonly get: operations["getBranches"];
readonly put?: never;
/**
* Create branch
* @description Creates a branch using the information provided in the RestCreateBranchRequest request
*
* The authenticated user must have REPO_WRITE permission for the context repository to call this resource.
*/
readonly post: operations["createBranchForRepository"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/branches/default": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get default branch
* @deprecated
* @description Retrieves the repository's default branch, if it has been created. If the repository is empty, 204 No Content will be returned. For non-empty repositories, if the configured default branch has not yet been created a 404 Not Found will be returned.
*
* This URL is deprecated. Callers should use GET /projects/{key}/repos/{slug}/default-branch instead, which allows retrieving the configured default branch even if the ref has not been created yet.
*
* The authenticated user must have REPO_READ permission for the specified repository to call this resource.
*/
readonly get: operations["getDefaultBranch_1"];
/**
* Update default branch
* @deprecated
* @description Update the default branch of a repository.
*
* This URL is deprecated. Callers should use PUT /projects/{key}/repos/{slug}/default-branch instead.
*
* The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
*/
readonly put: operations["setDefaultBranch_1"];
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/browse": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get file content at revision
* @description Retrieve a page of content for a file path at a specified revision.
*
* Responses from this endpoint vary widely depending on the query parameters. The example JSON is for a request that does not use size, type, blame or noContent.
*
* 1. size will return a response like {"size":10000}
* 2. type will return a response like {"type":"FILE"}, where possible values are "DIRECTORY", "FILE" and "SUBMODULE"
* 3. blame without noContent will include blame for the lines of content returned on the page
* 4. blame with noContent will omit file contents and only return blame for the requested lines
* 5. noContent without blame is ignored and does nothing
*
*
* The various parameters are "processed" in the above order. That means ?size=true&type=truewill return a size response, not a type one; the type parameter will be ignored.
*
* The blame and noContent query parameters are handled differently from size and type. For blame and noContent, the presence of the parameter implies "true" if no value is specified; size and and type both require an explicit=true or they're treated as "false".
*
* - ?blame is the same as ?blame=true
* - ?blame&noContent is the same as ?blame=true&noContent=true
* - ?size is the same as ?size=false
* - ?type is the same as ?type=false
*
*
* The authenticated user must have REPO_READ permission for the specified repository to call this resource.
*/
readonly get: operations["getContent"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/browse/{path}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get file content
* @description Retrieve a page of content for a file path at a specified revision.
*
* Responses from this endpoint vary widely depending on the query parameters. The example JSON is for a request that does not use size, type, blame or noContent.
*
* 1. size will return a response like {"size":10000}
* 2. type will return a response like {"type":"FILE"}, where possible values are "DIRECTORY", "FILE" and "SUBMODULE"
* 3. blame without noContent will include blame for the lines of content returned on the page
* 4. blame with noContent will omit file contents and only return blame for the requested lines
* 5. noContent without blame is ignored and does nothing
*
*
* The various parameters are "processed" in the above order. That means ?size=true&type=truewill return a size response, not a type one; the type parameter will be ignored.
*
* The blame and noContent query parameters are handled differently from size and type. For blame and noContent, the presence of the parameter implies "true" if no value is specified; size and and type both require an explicit=true or they're treated as "false".
*
* - ?blame is the same as ?blame=true
* - ?blame&noContent is the same as ?blame=true&noContent=true
* - ?size is the same as ?size=false
* - ?type is the same as ?type=false
*
*
* The authenticated user must have REPO_READ permission for the specified repository to call this resource.
*/
readonly get: operations["getContent_1"];
/**
* Edit file
* @description Update the content of path, on the given repository and branch.
*
* This resource accepts PUT multipart form data, containing the file in a form-field named content.
*
* An example curl request to update 'README.md' would be:
*
* ```curl -X PUT -u username:password -F content=@README.md -F 'message=Updated using file-edit REST API' -F branch=master -F sourceCommitId=5636641a50b http://example.com/rest/api/latest/projects/PROJECT_1/repos/repo_1/browse/README.md ```
*
* - branch: the branch on which the path should be modified or created
* - content: the full content of the file at path
* - message: the message associated with this change, to be used as the commit message. Or null if the default message should be used.
* - sourceCommitId: the commit ID of the file before it was edited, used to identify if content has changed. Or null if this is a new file
*
*
* The file can be updated or created on a new branch. In this case, the sourceBranch parameter should be provided to identify the starting point for the new branch and the branch parameter identifies the branch to create the new commit on.
*/
readonly put: operations["editFile"];
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/changes": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get changes made in commit
* @description Retrieve a page of changes made in a specified commit.
*
* Note: The implementation will apply a hard cap ({@code page.max.changes}) and it is not possible to request subsequent content when that cap is exceeded.
*
* The authenticated user must have REPO_READ permission for the specified repository to call this resource.
*/
readonly get: operations["getChanges_1"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get commits
* @description Retrieve a page of commits from a given starting commit or "between" two commits. If no explicit commit is specified, the tip of the repository's default branch is assumed. commits may be identified by branch or tag name or by ID. A path may be supplied to restrict the returned commits to only those which affect that path.
*
* The authenticated user must have REPO_READ permission for the specified repository to call this resource.
*/
readonly get: operations["getCommits"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get commit by ID
* @description Retrieve a single commit identified by its ID. In general, that ID is a SHA1. From 2.11, ref names like "refs/heads/master" are no longer accepted by this resource.
*
* The authenticated user must have REPO_READ permission for the specified repository to call this resource.
*/
readonly get: operations["getCommit"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/builds": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get a specific build status
* @description Get a specific build status.
*
*
* The authenticated user must have **REPO_READ** permission for the provided repository.The request can also be made with anonymous 2-legged OAuth.page.max.changes) and it is not possible to request subsequent content when that cap is exceeded.
*
* The authenticated user must have REPO_READ permission for the specified repository to call this resource.
*/
readonly get: operations["getChanges"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/comments": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Search for commit comments
* @description Retrieves the commit discussion comments that match the specified search criteria.
*
* It is possible to retrieve commit discussion comments that are anchored to a range of commits by providing the sinceId that the comments anchored from.
*
* The authenticated user must have REPO_READ permission for the repository that the commit is in to call this resource.
*/
readonly get: operations["getComments"];
readonly put?: never;
/**
* Add a new commit comment
* @description Add a new comment.
*
* Comments can be added in a few places by setting different attributes:
*
* General commit comment:
*
* ```{
* "text": "An insightful general comment on a commit."
* }
*
*
* Reply to a comment:
* {
* "text": "A measured reply.",
* "parent": {
* "id": 1
* }
* }
*
* General file comment:
* {
* "text": "An insightful general comment on a file.",
* "anchor": {
* "diffType": "COMMIT",
* "fromHash": "6df3858eeb9a53a911cd17e66a9174d44ffb02cd",
* "path": "path/to/file",
* "srcPath": "path/to/file",
* "toHash": "04c7c5c931b9418ca7b66f51fe934d0bd9b2ba4b"
* }
* }
*
* File line comment:
* {
* "text": "A pithy comment on a particular line within a file.",
* "anchor": {
* "diffType": "COMMIT",
* "line": 1,
* "lineType": "CONTEXT",
* "fileType": "FROM",
* "fromHash": "6df3858eeb9a53a911cd17e66a9174d44ffb02cd",
* "path": "path/to/file",
* "srcPath": "path/to/file",
* "toHash": "04c7c5c931b9418ca7b66f51fe934d0bd9b2ba4b"
* }
* }
* ```
*
* Note: general file comments are an experimental feature and may change in the near future!
*
* For file and line comments, 'path' refers to the path of the file to which the comment should be applied and 'srcPath' refers to the path the that file used to have (only required for copies and moves). Also, fromHash and toHash refer to the sinceId / untilId (respectively) used to produce the diff on which the comment was added. Finally diffType refers to the type of diff the comment was added on.
*
* For line comments, 'line' refers to the line in the diff that the comment should apply to. 'lineType' refers to the type of diff hunk, which can be:- 'ADDED' - for an added line;- 'REMOVED' - for a removed line; or- 'CONTEXT' - for a line that was unmodified but is in the vicinity of the diff.'fileType' refers to the file of the diff to which the anchor should be attached - which is of relevance when displaying the diff in a side-by-side way. Currently the supported values are:- 'FROM' - the source file of the diff- 'TO' - the destination file of the diffIf the current user is not a participant the user is added as one and updated to watch the commit.
*
* The authenticated user must have REPO_READ permission for the repository that the commit is in to call this resource.
*/
readonly post: operations["createComment"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/comments/{commentId}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get a commit comment
* @description Retrieves a commit discussion comment.
*
* The authenticated user must have REPO_READ permission for the repository that the commit is in to call this resource.
*/
readonly get: operations["getComment"];
/**
* Update a commit comment
* @description Update a comment, with the following restrictions:
*
* - only the author of the comment may update the text of the comment
* - only the author of the comment or repository admins and above may update the other fields of a comment
*
*
* Note: the supplied supplied JSON object must contain a version that must match the server's version of the comment or the update will fail. To determine the current version of the comment, the comment should be fetched from the server prior to the update. Look for the 'version' attribute in the returned JSON structure.
*
* The authenticated user must have REPO_READ permission for the repository that the commit is in to call this resource.
*/
readonly put: operations["updateComment"];
readonly post?: never;
/**
* Delete a commit comment
* @description Delete a commit comment. Anyone can delete their own comment. Only users with REPO_ADMIN and above may delete comments created by other users. Comments which have replies may not be deleted, regardless of the user's granted permissions.
*
* The authenticated user must have REPO_READ permission for the repository that the commit is in to call this resource.
*/
readonly delete: operations["deleteComment"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/deployments": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get a deployment
* @description Get the deployment matching the specified Repository, key, environmentKey and deploymentSequenceNumber.
*
* The user must have REPO_READ.
*/
readonly get: operations["get_1"];
readonly put?: never;
/**
* Create or update a deployment
* @description Create or update a deployment.
*
* The authenticated user must have REPO_READ permission for the repository.
*/
readonly post: operations["createOrUpdateDeployment"];
/**
* Delete a deployment
* @description Delete the deployment matching the specified Repository, key, environmentKey and deploymentSequenceNumber.
*
* The user must have REPO_ADMIN.
*/
readonly delete: operations["delete_1"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/diff-stats-summary/{path}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get diff stats summary between revisions
* @description Retrieve the diff stats summary for a commit.
*
* The stats summary include the total number of modified files, added lines, and deleted lines.
*
* The authenticated user must have REPO_READ permission for the specified repository to call this resource.
*/
readonly get: operations["getDiffStatsSummary"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/diff/{path}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get diff between revisions
* @description Retrieve the diff between two provided revisions.
*
* To stream a raw text representation of the diff, this endpoint can be called with the request header 'Accept: text/plain'.
*
* Note: This resource is currently not paged. The server will internally apply a hard cap to the streamed lines, and it is not possible to request subsequent pages if that cap is exceeded. In the event that the cap is reached, the diff will be cut short and one or more {@code truncated} flags will be set to true on the "segments", "hunks" and "diffs" properties, as well as the top-level object, in the returned JSON response.
*
* The authenticated user must have REPO_READ permission for the specified repository to call this resource.
*/
readonly get: operations["streamDiff"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/merge-base": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get the common ancestor between two commits
* @description Returns the best common ancestor between two commits.
*
* If more than one best common ancestor exists, only one will be returned. It is unspecified which will be returned.
*/
readonly get: operations["getMergeBase"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/pull-requests": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get repository pull requests containing commit
* @description Retrieve a page of pull requests in the current repository that contain the given commit.
*
* The user must be authenticated and have access to the specified repository to call this resource.
*/
readonly get: operations["getPullRequests"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/watch": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
/**
* Watch commit
* @description Add the authenticated user as a watcher for the specified commit.
*
* The authenticated user must have REPO_READ permission for the repository containing the commit to call this resource.
*/
readonly post: operations["watch"];
/**
* Stop watching commit
* @description Remove the authenticated user as a watcher for the specified commit.
*
* The authenticated user must have REPO_READ permission for the repository containing the commit to call this resource.
*/
readonly delete: operations["unwatch"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/compare/changes": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Compare commits
* @description Gets the file changes available in the from commit but not in the to commit.
*
*
* If either the from or to commit are not specified, they will be replaced by the default branch of their containing repository.
*/
readonly get: operations["streamChanges"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/compare/commits": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get accessible commits
* @description Gets the commits accessible from the from commit but not in the to commit.
*
* If either the from or to commit are not specified, they will be replaced by the default branch of their containing repository.
*/
readonly get: operations["streamCommits"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/compare/diff-stats-summary{path}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Retrieve the diff stats summary between commits
* @description Retrieve the diff stats summary of the changes available in the from commit but not in the to commit.
*
* If either the from or to commit are not specified, they will be replaced by the default branch of their containing repository.
*/
readonly get: operations["getDiffStatsSummary_1"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/compare/diff{path}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get diff between commits
* @description Gets a diff of the changes available in the from commit but not in the to commit.
*
* If either the from or to commit are not specified, they will be replaced by the default branch of their containing repository.
*/
readonly get: operations["streamDiff_1"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/contributing": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get repository contributing guidelines
* @description Retrieves the contributing guidelines for the repository, if they've been defined.
*
* This checks the repository for a CONTRIBUTING file, optionally with an md or txt extension, and, if found, streams it. By default, the raw content of the file is streamed. Appending ?markup to the URL will stream an HTML-rendered version instead.
*
* The authenticated user must have REPO_READ permission for the specified repository to call this resource.
*/
readonly get: operations["streamContributing"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/default-branch": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get repository default branch
* @description Retrieves the repository's configured default branch.
*
* Every repository has a configured default branch, but that branch may not actually exist in the repository. For example, a newly-created repository will have a configured default branch even though no branches have been pushed yet.
*
* The authenticated user must have REPO_READ permission for the specified repository to call this resource.
*/
readonly get: operations["getDefaultBranch_2"];
/**
* Update default branch for repository
* @description Update the default branch of a repository.
*
* The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
*/
readonly put: operations["setDefaultBranch_2"];
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/diff": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get raw diff for path
* @description Stream the raw diff between two provided revisions.
*
* The authenticated user must have REPO_READ permission for the specified repository to call this resource.
*/
readonly get: operations["streamRawDiff"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/diff/{path}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get raw diff for path
* @description Stream the raw diff between two provided revisions.
*
* The authenticated user must have REPO_READ permission for the specified repository to call this resource.
*/
readonly get: operations["streamRawDiff_1"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/files": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get files in directory
* @description Retrieve a page of files from particular directory of a repository. The search is done recursively, so all files from any sub-directory of the specified directory will be returned.
*
* The authenticated user must have REPO_READ permission for the specified repository to call this resource.
*/
readonly get: operations["streamFiles"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/files/{path}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get files in directory
* @description Retrieve a page of files from particular directory of a repository. The search is done recursively, so all files from any sub-directory of the specified directory will be returned.
*
* The authenticated user must have REPO_READ permission for the specified repository to call this resource.
*/
readonly get: operations["streamFiles_1"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/forks": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get repository forks
* @description Retrieve repositories which have been forked from this one. Unlike #getRelatedRepositories(Repository, PageRequest) related repositories, this only looks at a given repository's direct forks. If those forks have themselves been the origin of more forks, such "grandchildren" repositories will not be retrieved.
*
* Only repositories to which the authenticated user has REPO_READ permission will be included, even if other repositories have been forked from this one.
*/
readonly get: operations["getForkedRepositories"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/hook-scripts": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get hook scripts
* @description Return a page of hook scripts configured for the specified repository.
*
* This endpoint requires **REPO_ADMIN** permission.
*/
readonly get: operations["getConfigurations_1"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/hook-scripts/{scriptId}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
/**
* Create/update a hook script
* @description Creates/updates the hook script configuration for the provided hook script and repository.
*
* This endpoint requires **REPO_ADMIN** permission.
*/
readonly put: operations["setConfiguration_1"];
readonly post?: never;
/**
* Remove a hook script
* @description Removes the hook script from the set of hook scripts configured to run in the repository.
*
* This endpoint requires **REPO_ADMIN** permission.
*/
readonly delete: operations["removeConfiguration_1"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/labels": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get repository labels
* @description Get all labels applied to the given repository.
*
* The authenticated user must have REPO_READ permission for the specified repository.
*/
readonly get: operations["getAllLabelsForRepository"];
readonly put?: never;
/**
* Add repository label
* @description Applies a label to the repository.
*
* The authenticated user must have REPO_ADMIN permission for the specified repository.
*/
readonly post: operations["addLabel"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/labels/{labelName}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
readonly post?: never;
/**
* Remove repository label
* @description Remove label that is applied to the given repository.
*
* The authenticated user must have REPO_ADMIN permission for the specified repository.
*/
readonly delete: operations["removeLabel"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/last-modified": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Stream files
* @description Streams files from the repository's root with the last commit to modify each file. Commit modifications are traversed starting from the at commit or, if not specified, from the tip of the default branch.
*
* Unless the repository is public, the authenticated user must have REPO_READ access to call this resource.
*/
readonly get: operations["stream"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/last-modified/{path}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Stream files with last modified commit in path
* @description Streams files in the requested path with the last commit to modify each file. Commit modifications are traversed starting from the at commit or, if not specified, from the tip of the default branch.
*
* Unless the repository is public, the authenticated user must have REPO_READ access to call this resource.
*/
readonly get: operations["stream_1"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/license": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get repository license
* @description Retrieves the license for the repository, if it's been defined.
*
* This checks the repository for a LICENSE
file, optionally with an md
or txt
extension, and, if found, streams it. By default, the raw content of the file is streamed. Appending ?markup
to the URL will stream an HTML-rendered version instead.
*
* The authenticated user must have REPO_READ permission for the specified repository to call this resource.
*/
readonly get: operations["streamLicense"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/participants": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Search pull request participants
* @description Retrieve a page of participant users for all the pull requests to or from the specified repository.
*
* Optionally clients can specify following filters.
*/
readonly get: operations["search"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/patch": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get patch content at revision
* @description Retrieve the patch content for a repository at a specified revision.
*
* Cache headers are added to the response (only if full commit hashes are used, not in the case of short hashes).
*
* The authenticated user must have REPO_READ permission for the specified repository to call this resource.
*/
readonly get: operations["streamPatch"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/permissions": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
readonly post?: never;
/**
* Revoke all repository permissions for users and groups
* @description Revoke all permissions for the specified repository for the given groups and users.
*
* The authenticated user must have PROJECT_ADMIN permission for the specified repository or a higher global permission to call this resource.
*
* In addition, a user may not revoke a group's permission if their own permission would be revoked as a result, nor may they revoke their own permission unless they have a global permission that already implies that permission.
*/
readonly delete: operations["revokePermissions_1"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/permissions/groups": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get groups with permission to repository
* @description Retrieve a page of groups that have been granted at least one permission for the specified repository.
*
* The authenticated user must have REPO_ADMIN permission for the specified repository or a higher project or global permission to call this resource.
*/
readonly get: operations["getGroupsWithAnyPermission_2"];
/**
* Update group repository permission
* @description Promote or demote a group's permission level for the specified repository. Available repository permissions are:
*
* - REPO_READ
* - REPO_WRITE
* - REPO_ADMIN
*
*
* See the Bitbucket Data Center documentation for a detailed explanation of what each permission entails.
*
* The authenticated user must have REPO_ADMIN permission for the specified repository or a higher project or global permission to call this resource. In addition, a user may not demote a group's permission level if their own permission level would be reduced as a result.
*/
readonly put: operations["setPermissionForGroup"];
readonly post?: never;
/**
* Revoke group repository permission
* @description Revoke all permissions for the specified repository for a group.
*
* The authenticated user must have REPO_ADMIN permission for the specified repository or a higher project or global permission to call this resource.
*
* In addition, a user may not revoke a group's permissions if it will reduce their own permission level.
*/
readonly delete: operations["revokePermissionsForGroup_2"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/permissions/groups/none": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get groups without repository permission
* @description Retrieve a page of groups that have no granted permissions for the specified repository.
*
* The authenticated user must have REPO_ADMIN permission for the specified repository or a higher project or global permission to call this resource.
*/
readonly get: operations["getGroupsWithoutAnyPermission_2"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/permissions/search": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Search repository permissions
* @description Search direct and implied permissions of users and groups. This endpoint returns a superset of the results returned by the /users and /groups endpoints because it allows filtering by project and global permissions too.
*
* The authenticated user must have REPO_ADMIN permission for the specified repository or a higher project/global permission to call this resource.
*/
readonly get: operations["searchPermissions_1"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/permissions/users": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get users with permission to repository
* @description Retrieve a page of users that have been granted at least one permission for the specified repository.
*
* The authenticated user must have REPO_ADMIN permission for the specified repository or a higher project or global permission to call this resource.
*/
readonly get: operations["getUsersWithAnyPermission_2"];
/**
* Update user repository permission
* @description Promote or demote a user's permission level for the specified repository. Available repository permissions are:
*
* - REPO_READ- REPO_WRITE- REPO_ADMINSee the Bitbucket Data Center documentation for a detailed explanation of what each permission entails.
*
* The authenticated user must have REPO_ADMIN permission for the specified repository or a higher project or global permission to call this resource. In addition, a user may not reduce their own permission level unless they have a project or global permission that already implies that permission.
*/
readonly put: operations["setPermissionForUser"];
readonly post?: never;
/**
* Revoke user repository permission
* @description Revoke all permissions for the specified repository for a user.
*
* The authenticated user must have REPO_ADMIN permission for the specified repository or a higher project or global permission to call this resource.
*
* In addition, a user may not revoke their own repository permissions if they do not have a higher project or global permission.
*/
readonly delete: operations["revokePermissionsForUser_2"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/permissions/users/none": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get users without repository permission
* @description Retrieve a page of licensed users that have no granted permissions for the specified repository.
*
* The authenticated user must have REPO_ADMIN permission for the specified repository or a higher project or global permission to call this resource.
*/
readonly get: operations["getUsersWithoutPermission_1"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get pull requests for repository
* @description Retrieve a page of pull requests to or from the specified repository.
*
* The authenticated user must have REPO_READ permission for the specified repository to call this resource. Optionally clients can specify PR participant filters. Each filter has a mandatory username.N parameter, and the optional role.N and approved.N parameters.
*
* - username.N - the "root" of a single participant filter, where "N" is a natural number starting from 1. This allows clients to specify multiple participant filters, by providing consecutive filters as username.1, username.2 etc. Note that the filters numbering has to start with 1 and be continuous for all filters to be processed. The total allowed number of participant filters is 10 and all filters exceeding that limit will be dropped.
* - role.N(optional) the role associated with username.N. This must be one of AUTHOR, REVIEWER, or PARTICIPANT
* - approved.N (optional) the approved status associated with username.N. That is whether username.N has approved the PR. Either true, or false
*
*/
readonly get: operations["getPage"];
readonly put?: never;
/**
* Create pull request
* @description Create a new pull request from a source branch or tag to a target branch. The source and target may be in the same repository, or different ones. (Note that different repositories must belong to the same Repository#getHierarchyId() hierarchy.)
*
* The fromRef may be a branch or a tag. The toRef is required to be a branch. Tags are not allowed as targets because tags are intended to be immutable and should not be changed after they are created.
*
* The authenticated user must have REPO_READ permission for the fromRef and toRef repositories to call this resource.
*/
readonly post: operations["create"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get pull request
* @description Retrieve a pull request.
*
* The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
*/
readonly get: operations["get_3"];
/**
* Update pull request metadata
* @description Update the title, description, reviewers, destination branch or draft status of an existing pull request.
*
* **Note:** the reviewers list may be updated using this resource. However the author and participants list may not.
*
* The authenticated user must either:
*
* - be the author of the pull request and have the REPO_READ permission for the repository that this pull request targets; or
* - have the REPO_WRITE permission for the repository that this pull request targets
*
*
* to call this resource.
*/
readonly put: operations["update"];
readonly post?: never;
/**
* Delete pull request
* @description Deletes a pull request.
*
* To call this resource, users must be authenticated and have permission to view the pull request. Additionally, they must:
*
* - be the pull request author, if the system is configured to allow authors to delete their own pull requests (this is the default) OR
* - have repository administrator permission for the repository the pull request is targeting
*
*
* A body containing the version of the pull request must be provided with this request.
*
* `{ "version": 1 }`
*/
readonly delete: operations["delete_3"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}.diff": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Stream raw pull request diff
* @description Streams the raw diff for a pull request.
*
* The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
*/
readonly get: operations["streamRawDiff_2"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}.patch": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Stream pull request as patch
* @description Streams a patch representing a pull request.
*
* The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
*/
readonly get: operations["streamPatch_1"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/activities": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get pull request activity
* @description Retrieve a page of activity associated with a pull request.
*
* Activity items include comments, approvals, rescopes (i.e. adding and removing of commits), merges and more.
*
* Different types of activity items may be introduced in newer versions of Stash or by user installed plugins, so clients should be flexible enough to handle unexpected entity shapes in the returned page.
*
* The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
*/
readonly get: operations["getActivities"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/approve": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
/**
* Approve pull request
* @deprecated
* @description Approve a pull request as the current user. Implicitly adds the user as a participant if they are not already.
*
* The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
*
* Deprecated since 4.2. Use /rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants/{userSlug} instead
*/
readonly post: operations["approve"];
/**
* Unapprove pull request
* @deprecated
* @description Remove approval from a pull request as the current user. This does not remove the user as a participant.
*
* The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
*
* Deprecated since 4.2. Use /rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants/{userSlug} instead
*/
readonly delete: operations["withdrawApproval"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/auto-merge": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get auto-merge request for pull request
* @description Returns an auto-merge request for the pull request, if requested.
*
* The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
*/
readonly get: operations["getAutoMergeRequest"];
readonly put?: never;
/**
* Auto-merge pull request
* @description Requests the system to try merging the pull request if auto-merge was requested on it.
*
* The authenticated user must have REPO_WRITE permission for the repository that this pull request targets to call this resource.
*/
readonly post: operations["tryAutoMerge"];
/**
* Cancel auto-merge for pull request
* @description Cancels a request to auto-merge the pull request, if the pull request was not merged yet.
*
* The authenticated user must have REPO_WRITE permission for the repository that this pull request targets to call this resource.
*/
readonly delete: operations["cancelAutoMerge"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/blocker-comments": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Search pull request comments
* @description Gets comments matching the given set of field values for the specified pull request. (Note this does not perform any kind of searching for comments by their text).
*
* The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
*/
readonly get: operations["getComments_1"];
readonly put?: never;
/**
* Add new blocker comment
* @description Add a new blocker comment.
*
* Comments can be added in a few places by setting different attributes:
*
* General pull request blocker comment:
* ```
*
* {
* "text": "A task on a pull request."
* }
* ```
*
* Blocker reply to a comment:
*
* ```
*
* {
* "text": "This reply is a task.",
* "parent": {
* "id": 1
* }
* }
* ```
*
* General blocker file comment:
*
* ```
*
* {
* "text": "A blocker comment on a file.",
* "anchor": {
* "diffType": "RANGE",
* "fromHash": "6df3858eeb9a53a911cd17e66a9174d44ffb02cd",
* "path": "path/to/file",
* "srcPath": "path/to/file",
* "toHash": "04c7c5c931b9418ca7b66f51fe934d0bd9b2ba4b"
* }
* }
* ```
*
* Blocker file line comment:
*
* ```
*
* {
* "text": "A task on a particular line within a file.",
* "anchor": {
* "diffType": "COMMIT",
* "line": 1,
* "lineType": "CONTEXT",
* "fileType": "FROM",
* "fromHash": "6df3858eeb9a53a911cd17e66a9174d44ffb02cd",
* "path": "path/to/file",
* "srcPath": "path/to/file",
* "toHash": "04c7c5c931b9418ca7b66f51fe934d0bd9b2ba4b"
* }
* }
* ```
*
* For file and line comments, 'path' refers to the path of the file to which the comment should be applied and 'srcPath' refers to the path the that file used to have (only required for copies and moves). Also, fromHash and toHash refer to the sinceId / untilId (respectively) used to produce the diff on which the comment was added. Finally diffType refers to the type of diff the comment was added on. For backwards compatibility purposes if no diffType is provided and no fromHash/toHash pair is provided the diffType will be resolved to 'EFFECTIVE'. In any other cases the diffType is REQUIRED.
*
* For line comments, 'line' refers to the line in the diff that the comment should apply to. 'lineType' refers to the type of diff hunk, which can be:
*
* - 'ADDED' - for an added line;
* - 'REMOVED' - for a removed line; or
* - 'CONTEXT' - for a line that was unmodified but is in the vicinity of the diff.
*
*
* 'fileType' refers to the file of the diff to which the anchor should be attached - which is of relevance when displaying the diff in a side-by-side way. Currently the supported values are:
*
* - 'FROM' - the source file of the diff
* - 'TO' - the destination file of the diff
*
*
* If the current user is not a participant the user is added as a watcher of the pull request.
*
* The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
*/
readonly post: operations["createComment_1"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/blocker-comments/{commentId}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get pull request comment
* @description Retrieves a pull request comment.
*
* The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
*/
readonly get: operations["getComment_1"];
/**
* Update pull request comment
* @description Update a comment, with the following restrictions:
*
* - only the author of the comment may update the text of the comment
* - only the author of the comment, the author of the pull request or repository admins and above may update the other fields of a comment
*
*
* Convert a comment to a task or vice versa.
*
* Comments can be converted to tasks by setting the 'severity' attribute to 'BLOCKER':
* ```
*
* {
* "severity": "BLOCKER"
* }
*
* ```
*
* Tasks can be converted to comments by setting the 'severity' attribute to 'NORMAL': ```
*
* {
* "severity": "NORMAL"
* }
*
* ```
*
* Resolve a blocker comment.
*
* Blocker comments can be resolved by setting the 'state' attribute to 'RESOLVED': ```
*
* {
* "state": "RESOLVED"
* }
* ```
*
* Note: the supplied JSON object must contain a version that must match the server's version of the comment or the update will fail. To determine the current version of the comment, the comment should be fetched from the server prior to the update. Look for the 'version' attribute in the returned JSON structure.
*
* The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
*/
readonly put: operations["updateComment_1"];
readonly post?: never;
/**
* Delete pull request comment
* @description Delete a pull request comment. Anyone can delete their own comment. Only users with REPO_ADMIN and above may delete comments created by other users.
*
* The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
*/
readonly delete: operations["deleteComment_1"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/changes": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Gets pull request changes
* @description Gets changes for the specified PullRequest.
*
* If the changeScope query parameter is set to 'UNREVIEWED', the application will attempt to stream unreviewed changes based on the lastReviewedCommit of the current user, which are the changes between the lastReviewedCommit and the latest commit of the source branch. The current user is considered to not have any unreviewed changes for the pull request when the lastReviewedCommit is either null (everything is unreviewed, so all changes are streamed), equal to the latest commit of the source branch (everything is reviewed), or no longer on the source branch (the source branch has been rebased). In these cases, the application will fall back to streaming all changes (the default), which is the effective diff for the pull request. The type of changes streamed can be determined by the changeScope parameter included in the properties map of the response.
*
* Note: This resource is currently not paged. The server will return at most one page. The server will truncate the number of changes to either the request's page limit or an internal maximum, whichever is smaller. The start parameter of the page request is also ignored.
*
* The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
*/
readonly get: operations["streamChanges_1"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get pull request comments for path
* @description Gets comments for the specified pull request and path.
*
* The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
*/
readonly get: operations["getComments_2"];
readonly put?: never;
/**
* Add pull request comment
* @description Add a new comment.
*
* Comments can be added in a few places by setting different attributes: General pull request comment:
* {
* "text": "An insightful general comment on a pull request."
* }
* Reply to a comment: {
* "text": "A measured reply.",
* "parent": {
* "id": 1
* }
* }
* General file comment: {
* "text": "An insightful general comment on a file.",
* "anchor": {
* "diffType": "RANGE",
* "fromHash": "6df3858eeb9a53a911cd17e66a9174d44ffb02cd",
* "path": "path/to/file",
* "srcPath": "path/to/file",
* "toHash": "04c7c5c931b9418ca7b66f51fe934d0bd9b2ba4b"
* }
* }
* File line comment: {
* "text": "A pithy comment on a particular line within a file.",
* "anchor": {
* "diffType": "COMMIT",
* "line": 1,
* "lineType": "CONTEXT",
* "fileType": "FROM",
* "fromHash": "6df3858eeb9a53a911cd17e66a9174d44ffb02cd",
* "path": "path/to/file",
* "srcPath": "path/to/file",
* "toHash": "04c7c5c931b9418ca7b66f51fe934d0bd9b2ba4b"
* }
* }
*
*
* Add a new task.
*
* Tasks are just comments with the attribute 'severity' set to 'BLOCKER':
*
* General pull request task: {
* "text": "A task on a pull request.",
* "severity": "BLOCKER"
* }
*
*
* Add a pending comment.
*
* Pending comments are just comments with the attribute 'state' set to 'PENDING':
*
* Pending comment: {
* "text": "This is a pending comment",
* "state": "PENDING"
* }
*
*
* For file and line comments, 'path' refers to the path of the file to which the comment should be applied and 'srcPath' refers to the path the that file used to have (only required for copies and moves). Also, fromHash and toHash refer to the sinceId / untilId (respectively) used to produce the diff on which the comment was added. Finally diffType refers to the type of diff the comment was added on. For backwards compatibility purposes if no diffType is provided and no fromHash/toHash pair is provided the diffType will be resolved to 'EFFECTIVE'. In any other cases the diffType is REQUIRED.
*
* For line comments, 'line' refers to the line in the diff that the comment should apply to. 'lineType' refers to the type of diff hunk, which can be:
*
* - 'ADDED' - for an added line;
* - 'REMOVED' - for a removed line; or
* - 'CONTEXT' - for a line that was unmodified but is in the vicinity of the diff.
* 'fileType' refers to the file of the diff to which the anchor should be attached - which is of relevance when displaying the diff in a side-by-side way. Currently the supported values are:
*
* - 'FROM' - the source file of the diff
* - 'TO' - the destination file of the diff
* If the current user is not a participant the user is added as a watcher of the pull request.
*
* The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
*/
readonly post: operations["createComment_2"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments/{commentId}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get a pull request comment
* @description Retrieves a pull request comment.
*
* The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
*/
readonly get: operations["getComment_2"];
/**
* Update pull request comment
* @description Update a comment, with the following restrictions:
*
* - only the author of the comment may update the text of the comment
* - only the author of the comment, the author of the pull request or repository admins and above may update the other fields of a comment
*
*
* Convert a comment to a task or vice versa.
*
* Comments can be converted to tasks by setting the 'severity' attribute to 'BLOCKER':
* {
* "severity": "BLOCKER"
* }
*
*
* Tasks can be converted to comments by setting the 'severity' attribute to 'NORMAL': {
* "severity": "NORMAL"
* }
*
*
* Resolve a task.
*
* Tasks can be resolved by setting the 'state' attribute to 'RESOLVED': {
* "state": "RESOLVED"
* }
*
*
* Note: the supplied JSON object must contain a version that must match the server's version of the comment or the update will fail. To determine the current version of the comment, the comment should be fetched from the server prior to the update. Look for the 'version' attribute in the returned JSON structure.
*
* The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
*/
readonly put: operations["updateComment_2"];
readonly post?: never;
/**
* Delete a pull request comment
* @description Delete a pull request comment. Anyone can delete their own comment. Only users with REPO_ADMIN and above may delete comments created by other users.
*
* The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
*/
readonly delete: operations["deleteComment_2"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments/{commentId}/apply-suggestion": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
/**
* Apply pull request suggestion
* @description Apply a suggestion contained within a comment.
*/
readonly post: operations["applySuggestion"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/commit-message-suggestion": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get commit message suggestion
* @description Retrieve a suggested commit message for the given Pull Request.
*/
readonly get: operations["getCommitMessageSuggestion"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/commits": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get pull request commits
* @description Retrieve commits for the specified pull request.
*
* The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
*/
readonly get: operations["getCommits_1"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/decline": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
/**
* Decline pull request
* @description Decline a pull request.
*
* The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
*/
readonly post: operations["decline"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/diff-stats-summary/{path}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get diff stats summary for pull request
* @description Retrieve the diff stats summary for the given Pull Request.
*
* The stats summary include the total number of modified files, added lines, and deleted lines.
*
* Note: The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
*/
readonly get: operations["getDiffStatsSummary_2"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/diff/{path}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Stream a diff within a pull request
* @description Streams a diff within a pull request.
*
* If the specified file has been copied, moved or renamed, the srcPath must also be specified to produce the correct diff.
*
* To stream a raw text representation of the diff, this endpoint can be called with the request header 'Accept: text/plain'.
*
* Note: This RESTful endpoint is currently not paged. The server will internally apply a hard cap to the streamed lines, and it is not possible to request subsequent pages if that cap is exceeded.
*
* The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
*/
readonly get: operations["streamDiff_2"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/merge": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Test if pull request can be merged
* @description Test whether a pull request can be merged.
*
* A pull request may not be merged if:
*
* - there are conflicts that need to be manually resolved before merging; and/or
* - one or more merge checks have vetoed the merge.
*
*
* The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
*/
readonly get: operations["canMerge"];
readonly put?: never;
/**
* Merge pull request
* @description Merge the specified pull request immediately or set the pull request to auto-merge when all the merge checks pass by setting autoMerge field in the request body.
*
* The authenticated user must have REPO_WRITE permission for the repository that this pull request targets to call this resource.
*/
readonly post: operations["merge"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/merge-base": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get the common ancestor between the latest commits of the source and target branches of the pull request
* @description Returns the best common ancestor between the latest commits of the source and target branches of the pull request.
*
* If more than one best common ancestor exists, only one will be returned. It is unspecified which will be returned.
*/
readonly get: operations["getMergeBase_1"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get pull request participants
* @description Retrieves a page of the participants for a given pull request.
*
* The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
*/
readonly get: operations["listParticipants"];
readonly put?: never;
/**
* Assign pull request participant role
* @description Assigns a participant to an explicit role in pull request. Currently only the REVIEWER role may be assigned.
*
* If the user is not yet a participant in the pull request, they are made one and assigned the supplied role.
*
* If the user is already a participant in the pull request, their previous role is replaced with the supplied role unless they are already assigned the AUTHOR role which cannot be changed and will result in a Bad Request (400) response code.
*
* The authenticated user must have REPO_WRITE permission for the repository that this pull request targets to call this resource.
*/
readonly post: operations["assignParticipantRole"];
/**
* Unassign pull request participant
* @deprecated
* @description Unassigns a participant from the REVIEWER role they may have been given in a pull request.
*
* If the participant has no explicit role this method has no effect.
*
* Afterwards, the user will still remain a participant in the pull request but their role will be reduced to PARTICIPANT. This is because once made a participant of a pull request, a user will forever remain a participant. Only their role may be altered.
*
* The authenticated user must have REPO_WRITE permission for the repository that this pull request targets to call this resource.
*
* Deprecated since 4.2. Use /rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants/{userSlug} instead.
*/
readonly delete: operations["unassignParticipantRole_1"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants/{userSlug}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
/**
* Change pull request status
* @description Change the current user's status for a pull request. Implicitly adds the user as a participant if they are not already. If the current user is the author, this method will fail.
*
* The possible values for {@code status} are UNAPPROVED, NEEDS_WORK (which is referred to as "Requested changes" in the frontend from 8.10 onward), or APPROVED.
*
* If the new {@code status} is NEEDS_WORK or APPROVED then the {@code lastReviewedCommit} for the participant will be updated to the latest commit of the source branch of the pull request.
*
* The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
*/
readonly put: operations["updateStatus"];
readonly post?: never;
/**
* Unassign pull request participant
* @description Unassigns a participant from the REVIEWER role they may have been given in a pull request.
*
* If the participant has no explicit role this method has no effect.
*
* Afterwards, the user will still remain a participant in the pull request but their role will be reduced to PARTICIPANT. This is because once made a participant of a pull request, a user will forever remain a participant. Only their role may be altered.
*
* The authenticated user must have REPO_WRITE permission for the repository that this pull request targets to call this resource.
*/
readonly delete: operations["unassignParticipantRole"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/reopen": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
/**
* Re-open pull request
* @description Re-open a declined pull request.
*
* The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
*/
readonly post: operations["reopen"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/review": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get pull request comment thread
* @description Get the CommentThread threads which have Comment comments that have a CommentState#PENDING pending state and are part of the pull request review for the authenticated user.
*/
readonly get: operations["getReview"];
/**
* Complete pull request review
* @description Complete a review on a pull request.
*/
readonly put: operations["finishReview"];
readonly post?: never;
/**
* Discard pull request review
* @description Discard a pull request review for the authenticated user.
*
* The authenticated user must have REPO_READ permission for the repository to call this resource.
*/
readonly delete: operations["discardReview"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/watch": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
/**
* Watch pull request
* @description Add the authenticated user as a watcher for the specified pull request.
*
* The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
*/
readonly post: operations["watch_1"];
/**
* Stop watching pull request
* @description Remove the authenticated user as a watcher for the specified pull request.
*
* The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
*/
readonly delete: operations["unwatch_1"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/raw/{path}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get raw content of a file at revision
* @description Retrieve the raw content for a file path at a specified revision.
*
* The authenticated user must have REPO_READ permission for the specified repository to call this resource.
*/
readonly get: operations["streamRaw"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/readme": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get repository readme
* @description Retrieves the README for the repository, if it's been defined.
*
* This checks the repository for a README
file, optionally with an md
or txt
extension, and, if found, streams it. By default, the raw content of the file is streamed. Appending ?markup
to the URL will stream an HTML-rendered version instead. Note that, when streaming HTML, relative URLs in the README will not work if applied relative to this URL.
*
* The authenticated user must have REPO_READ permission for the specified repository to call this resource.
*/
readonly get: operations["streamReadme"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/recreate": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
/**
* Retry repository creation
* @description If a create or fork operation fails, calling this method will clean up the broken repository and try again. The repository must be in an INITIALISATION_FAILED state.
*
* The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.
*/
readonly post: operations["retryCreateRepository"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/ref-change-activities": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get ref change activity
* @description Retrieve a page of repository ref change activity.
*
* The authenticated user must have REPO_ADMIN permission to call this resource.
*/
readonly get: operations["getRefChangeActivity"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/ref-change-activities/branches": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get branches with ref change activities for repository
* @description Retrieve a page of branches with ref change activities for a specific repository.
*
* The authenticated user must have REPO_ADMIN permission to call this resource.
*/
readonly get: operations["findBranches"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/related": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get related repository
* @description Retrieve repositories which are related to this one. Related repositories are from the same Repository#getHierarchyId() hierarchy as this repository.
*
* Only repositories to which the authenticated user has REPO_READ permission will be included, even if more repositories are part of this repository's hierarchy.
*/
readonly get: operations["getRelatedRepositories"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/allowlist": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Find repository secret scanning allowlist rules
* @description Find repository secret scanning allowlist rules by filtering.
*
* Repository **Admin** is required
*/
readonly get: operations["search_2"];
readonly put?: never;
/**
* Create repository secret scanning allowlist rule
* @description Create a new repository secret scanning allowlist rule. Repository allowlist rules are used when scanning the given repository.
*
* Repository **Admin** is required
*/
readonly post: operations["createAllowlistRule_1"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/allowlist/{id}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get a repository secret scanning allowlist rule
* @description Get a repository secret scanning allowlist rule by ID.
*
* Repository **Admin** is required
*/
readonly get: operations["getAllowlistRule_1"];
/**
* Edit an existing repository secret scanning allowlist rule
* @description Edit a repository secret scanning allowlist rule.
*
* Repository **Admin** is required
*/
readonly put: operations["editAllowlistRule_1"];
readonly post?: never;
/**
* Delete a repository secret scanning allowlist rule
* @description Delete a repository secret scanning allowlist rule with the provided ID.
*
* Repository **Admin** is required
*/
readonly delete: operations["deleteAllowlistRule_1"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/exempt": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get whether a repository is exempt
* @description Check whether a repository is exempt from secret scanning
*/
readonly get: operations["isRepoExempt"];
/**
* Exempt a repo from secret scanning
* @deprecated
* @description Exempt a repository from being scanned for secrets
*
* Deprecated since 8.6. Exemptions are now managed by scope.
* Use POST /rest/api/1.0/secret-scanning/exempt for global scope
* Use POST /rest/api/1.0/projects/{projectKey}/secret-scanning/exempt for the project scope
*/
readonly put: operations["addExemptRepo"];
readonly post?: never;
/**
* Delete an exempt repository
* @description Remove a repository from being exempt from secret scanning
*/
readonly delete: operations["deleteExemptRepo"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/rules": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Find repository secret scanning rules
* @description Find repository secret scanning rules by filtering.
*
* Repository **Admin** is required
*/
readonly get: operations["search_3"];
readonly put?: never;
/**
* Create repository secret scanning rule
* @description Create a new repository secret scanning rule. Repository rules are used when scanning the given repository.
*
* Repository **Admin** is required
*/
readonly post: operations["createRule_1"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/rules/{id}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get a repository secret scanning rule
* @description Get a repository secret scanning rule by ID.
*
* Repository **Admin** is required
*/
readonly get: operations["getRule_1"];
/**
* Edit an existing repository secret scanning rule
* @description Edit a repository secret scanning rule.
*
* Repository **Admin** is required
*/
readonly put: operations["editRule_1"];
readonly post?: never;
/**
* Delete a repository secret scanning rule
* @description Delete a repository secret scanning rule with the provided ID.
*
* Repository **Admin** is required
*/
readonly delete: operations["deleteRule_1"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/auto-decline": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get auto decline settings
* @description Retrieves the auto decline settings for the supplied repository. Project settings will be returned if no explicit settings have been set for the repository. In the case that there are no project settings, the default settings will be returned.
*
* The authenticated user must have REPO_READ permission for this repository to call the resource.
*/
readonly get: operations["getAutoDeclineSettings_1"];
/**
* Create auto decline settings
* @description Creates or updates the auto decline settings for the supplied repository.
*
* The authenticated user must have REPO_ADMIN permission for this repository to call the resource
*/
readonly put: operations["setAutoDeclineSettings_1"];
readonly post?: never;
/**
* Delete auto decline settings
* @description Delete auto decline settings for the supplied repository.
*
* The authenticated user must have REPO_ADMIN permission for this repository to call the resource.
*/
readonly delete: operations["deleteAutoDeclineSettings_1"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/auto-merge": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get pull request auto-merge settings
* @description Retrieves the pull request auto-merge settings for the supplied repository. Project settings will be returned if no explicit settings have been set for the repository. In the case that there are no project settings, the default settings will be returned. If the repository's project has restricted its auto-merge settings, then the settings of the project will be returned.
*
* The authenticated user must have REPO_READ permission for this repository to call the resource.
*/
readonly get: operations["get_5"];
/**
* Create or update the pull request auto-merge settings
* @description Creates or updates the pull request auto-merge settings for the supplied repository.
*
* The authenticated user must have REPO_ADMIN permission for this repository to call the resource.
*/
readonly put: operations["set_1"];
readonly post?: never;
/**
* Delete pull request auto-merge settings
* @description Deletes pull request auto-merge settings for the supplied repository.
*
* The authenticated user must have REPO_ADMIN permission for this repository to call the resource.
*/
readonly delete: operations["delete_5"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/hooks": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get repository hooks
* @description Retrieve a page of repository hooks for this repository.
*
* The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
*/
readonly get: operations["getRepositoryHooks_1"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/hooks/{hookKey}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get repository hook
* @description Retrieve a repository hook for this repository.
*
* The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
*/
readonly get: operations["getRepositoryHook_1"];
readonly put?: never;
readonly post?: never;
/**
* Delete repository hook
* @description Delete repository hook configuration for the supplied hookKey and repositorySlug
*
* The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
*/
readonly delete: operations["deleteRepositoryHook"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/hooks/{hookKey}/enabled": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
/**
* Enable repository hook
* @description Enable a repository hook for this repository and optionally apply new configuration.
*
* The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
*
* A JSON document may be provided to use as the settings for the hook. These structure and validity of the document is decided by the plugin providing the hook.
*/
readonly put: operations["enableHook_1"];
readonly post?: never;
/**
* Disable repository hook
* @description Disable a repository hook for this repository.
*
* The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
*/
readonly delete: operations["disableHook_1"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/hooks/{hookKey}/settings": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get repository hook settings
* @description Retrieve the settings for a repository hook for this repository.
*
* The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
*/
readonly get: operations["getSettings_1"];
/**
* Update repository hook settings
* @description Modify the settings for a repository hook for this repository.
*
* The service will reject any settings which are too large, the current limit is 32KB once serialized.
*
* The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
*
* A JSON document can be provided to use as the settings for the hook. These structure and validity of the document is decided by the plugin providing the hook.
*/
readonly put: operations["setSettings_1"];
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/pull-requests": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get pull request settings
* @description Retrieve the pull request settings for the context repository.
*
* The authenticated user must have REPO_READ permission for the context repository to call this resource.
*
* This resource will call all RestFragments that are registered with the key bitbucket.repository.settings.pullRequests. If any fragment fails validations by returning a non-empty Map of errors, then no fragments will execute.
*
* The property keys for the settings that are bundled with the application are
*
* - mergeConfig - the merge strategy configuration for pull requests
* - requiredApprovers - (Deprecated, please use com.atlassian.bitbucket.server.bundled-hooks.requiredApproversMergeHook instead) the number of approvals required on a pull request for it to be mergeable, or 0 if the merge check is disabled
* - com.atlassian.bitbucket.server.bundled-hooks.requiredApproversMergeHook - the merge check configuration for required approvers
* - requiredAllApprovers - whether or not all approvers must approve a pull request for it to be mergeable
* - requiredAllTasksComplete - whether or not all tasks on a pull request need to be completed for it to be mergeable
* - requiredSuccessfulBuilds - (Deprecated, please use com.atlassian.bitbucket.server.bitbucket-build.requiredBuildsMergeCheck instead) the number of successful builds on a pull request for it to be mergeable, or 0 if the merge check is disabled
* - com.atlassian.bitbucket.server.bitbucket-build.requiredBuildsMergeCheck - the merge check configuration for required builds
*
*
*
*/
readonly get: operations["getPullRequestSettings_1"];
readonly put?: never;
/**
* Update pull request settings
* @description Update the pull request settings for the context repository.
*
* The authenticated user must have REPO_ADMIN permission for the context repository to call this resource.
*
* This resource will call all RestFragments that are registered with the key bitbucket.repository.settings.pullRequests. If any fragment fails validations by returning a non-empty Map of errors, then no fragments will execute.
*
* Only the settings that should be updated need to be included in the request.
*
* The property keys for the settings that are bundled with the application are
*
* - mergeConfig - the merge strategy configuration for pull requests
* - requiredApprovers - (Deprecated, please use com.atlassian.bitbucket.server.bundled-hooks.requiredApproversMergeHook instead) the number of approvals required on a pull request for it to be mergeable, or 0 to disable the merge check
* - com.atlassian.bitbucket.server.bundled-hooks.requiredApproversMergeHook - a json map containing the keys 'enabled' (a boolean to enable or disable this merge check) and 'count' (an integer to set the number of required approvals)
* - requiredAllApprovers - whether or not all approvers must approve a pull request for it to be mergeable
* - requiredAllTasksComplete - whether or not all tasks on a pull request need to be completed for it to be mergeable
* - requiredSuccessfulBuilds - (Deprecated, please use com.atlassian.bitbucket.server.bitbucket-build.requiredBuildsMergeCheck instead) the number of successful builds on a pull request for it to be mergeable, or 0 to disable the merge check
* - com.atlassian.bitbucket.server.bitbucket-build.requiredBuildsMergeCheck - a json map containing the keys 'enabled' (a boolean to enable or disable this merge check) and 'count' (an integer to set the number of required builds)
*
*
* Merge strategy configuration deletion:
*
* An explicitly set pull request merge strategy configuration can be deleted by POSTing a document with an empty "mergeConfig" attribute. i.e:
*
*
* ```{
* "mergeConfig": {
* }
* }
* ```
*
* Upon completion of this request, the effective configuration will be:
*
* - The configuration set for this repository's SCM type as set at the project level, if present, otherwise
* - the configuration set for this repository's SCM type as set at the instance level, if present, otherwise
* - the default configuration for this repository's SCM type
*
*
*
*/
readonly post: operations["updatePullRequestSettings_1"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/reviewer-groups": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get all reviewer groups
* @description Retrieve a page of reviewer groups of a given scope.
*
* The authenticated user must have REPO_READ permission for the specified repository to call this resource.
*/
readonly get: operations["getReviewerGroups_1"];
readonly put?: never;
/**
* Create reviewer group
* @description Create a reviewer group.
*
* The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
*/
readonly post: operations["create_2"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/reviewer-groups/{id}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get reviewer group
* @description Retrieve a reviewer group.
*
* The authenticated user must have REPO_READ permission for the specified repository to call this resource.
*/
readonly get: operations["getReviewerGroup_1"];
/**
* Update reviewer group attributes
* @description Update the attributes of a reviewer group.
*
* The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
*/
readonly put: operations["update_2"];
readonly post?: never;
/**
* Delete reviewer group
* @description Deletes a reviewer group.
*
* The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
*/
readonly delete: operations["delete_7"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/reviewer-groups/{id}/users": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get reviewer group users
* @description Retrieve a list of the users of a reviewer group.
*
* This does not return all the users of the group, only the users who are licensed and have REPO_READ permission for the specified repository.
*
* The authenticated user must have REPO_READ permission for the specified repository to call this resource.
*/
readonly get: operations["getUsers"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/tags": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Find tag
* @description Retrieve the tags matching the supplied filterText param.
*
* The authenticated user must have REPO_READ permission for the context repository to call this resource.
*/
readonly get: operations["getTags"];
readonly put?: never;
/**
* Create tag
* @description Creates a tag using the information provided in the RestCreateTagRequest request
*
* The authenticated user must have REPO_WRITE permission for the context repository to call this resource.
*/
readonly post: operations["createTagForRepository"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/tags/{name}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get tag
* @description Retrieve a tag in the specified repository.
*
* The authenticated user must have REPO_READ permission for the context repository to call this resource.
*/
readonly get: operations["getTag"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/watch": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
/**
* Watch repository
* @description Add the authenticated user as a watcher for the specified repository.
*
* The authenticated user must have REPO_READ permission for the repository to call this resource.
*/
readonly post: operations["watch_2"];
/**
* Stop watching repository
* @description Remove the authenticated user as a watcher for the specified repository.
*
* The authenticated user must have REPO_READ permission for the repository to call this resource.
*/
readonly delete: operations["unwatch_2"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/webhooks": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Find webhooks
* @description Find webhooks in this repository.
*
* The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
*/
readonly get: operations["findWebhooks_1"];
readonly put?: never;
/**
* Create webhook
* @description Create a webhook for the repository specified via the URL.
*
* The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
*/
readonly post: operations["createWebhook_1"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/webhooks/{webhookId}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get webhook
* @description Get a webhook by ID.
*
* The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
*/
readonly get: operations["getWebhook_1"];
/**
* Update webhook
* @description Update an existing webhook.
*
* The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
*/
readonly put: operations["updateWebhook_1"];
readonly post?: never;
/**
* Delete webhook
* @description Delete a webhook for the repository specified via the URL.
*
* The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
*/
readonly delete: operations["deleteWebhook_1"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/webhooks/{webhookId}/latest": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get last webhook invocation details
* @description Get the latest invocations for a specific webhook.
*
* The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
*/
readonly get: operations["getLatestInvocation_1"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/webhooks/{webhookId}/statistics": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get webhook statistics
* @description Get the statistics for a specific webhook.
*
* The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
*/
readonly get: operations["getStatistics_1"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/webhooks/{webhookId}/statistics/summary": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get webhook statistics summary
* @description Get the statistics summary for a specific webhook.
*
* The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
*/
readonly get: operations["getStatisticsSummary_1"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/webhooks/search": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Search webhooks
* @description Search webhooks in this repository and parent project. This endpoint returns a superset of the results returned by the /webhooks endpoint because it allows filtering by project scope too, not just repository webhooks.
*
* The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
*/
readonly get: operations["searchWebhooks"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/repos/{repositorySlug}/webhooks/test": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
/**
* Test webhook
* @description Test connectivity to a specific endpoint.
*
* The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
*/
readonly post: operations["testWebhook_1"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/secret-scanning/allowlist": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Find project secret scanning allowlist rules
* @description Find project secret scanning allowlist rules by filtering.
*
* Project **Admin** is required
*/
readonly get: operations["searchAllowlistRule"];
readonly put?: never;
/**
* Create project secret scanning allowlist rule
* @description Create a new project level secret scanning allowlist rule. Project allowlist rules are used when scanning all non exempt repositories in the provided project.
*
* Project **Admin** is required
*/
readonly post: operations["createAllowlistRule"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/secret-scanning/allowlist/{id}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get a project secret scanning allowlist rule
* @description Get a project secret scanning allowlist rule by ID.
*
* Project **Admin** is required
*/
readonly get: operations["getAllowlistRule"];
/**
* Edit an existing project secret scanning allowlist rule
* @description Edit a project secret scanning allowlist rule.
*
* Project **Admin** is required
*/
readonly put: operations["editAllowlistRule"];
readonly post?: never;
/**
* Delete a project secret scanning allowlist rule
* @description Delete a project secret scanning allowlist rule with the provided ID.
*
* Project **Admin** is required
*/
readonly delete: operations["deleteAllowlistRule"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/secret-scanning/exempt": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Find repos exempt from secret scanning for a project
* @description Find repositories exempt from secret scanning in a project
*/
readonly get: operations["findExemptReposByProject"];
readonly put?: never;
/**
* Bulk exempt repos from secret scanning
* @description Bulk exempt a list of repositories from being scanned for secrets. User must be have **PROJECT ADMIN** permissions.
*/
readonly post: operations["bulkAddExemptRepositories_1"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/secret-scanning/rules": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Find project secret scanning rules
* @description Find project secret scanning rules by filtering.
*
* Project **Admin** is required
*/
readonly get: operations["search_1"];
readonly put?: never;
/**
* Create project secret scanning rule
* @description Create a new project level secret scanning rule. Project rules are used when scanning all non exempt repositories in the provided project.
*
* Project **Admin** is required
*/
readonly post: operations["createRule"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/secret-scanning/rules/{id}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get a project secret scanning rule
* @description Get a project secret scanning rule by ID.
*
* Project **Admin** is required
*/
readonly get: operations["getRule"];
/**
* Edit an existing project secret scanning rule
* @description Edit a project secret scanning rule.
*
* Project **Admin** is required
*/
readonly put: operations["editRule"];
readonly post?: never;
/**
* Delete a project secret scanning rule
* @description Delete a project secret scanning rule with the provided ID.
*
* Project **Admin** is required
*/
readonly delete: operations["deleteRule"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/settings-restriction": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get enforcing project setting
* @description Get a specified project settings restriction for the given namespace, feature key and component key.
* Note that not providing the component key will **not** return restrictions for the namespace and feature key with a component key set.
*
* The authenticated user must have **PROJECT_VIEW** permission for the target project to retrieve a settings restriction.
*/
readonly get: operations["get_7"];
readonly put?: never;
/**
* Enforce project restriction
* @description Create a new project settings restriction for the given project.
*
* The authenticated user must have **PROJECT_ADMIN** permission for the target project to create a settings restriction.
*/
readonly post: operations["create_3"];
/**
* Stop enforcing project restriction
* @description Delete a specified project settings restriction.
*
* If a restriction does not exist for the specified project, namespace, featureKey, and componentKey, the request will be ignored and a 204 response will be returned.
*
* The authenticated user must have **PROJECT_ADMIN** permission for the target project to delete a settings restriction.
*/
readonly delete: operations["delete_9"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/settings-restriction/all": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get all enforcing project settings
* @description Get all project settings restrictions for the given namespace and feature key, including those with a component key set.
*
* The authenticated user must have **PROJECT_VIEW** permission for the target project to retrieve a settings restrictions.
*/
readonly get: operations["getAll"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/settings/auto-decline": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get auto decline settings
* @description Retrieves the auto decline settings for the supplied project. Default settings are returned if no explicit settings have been set for the project.
*/
readonly get: operations["getAutoDeclineSettings"];
/**
* Create/Update auto decline settings
* @description Creates or updates the auto decline settings for the supplied project.
*
* The authenticated user must have PROJECT_ADMIN permission for this project to call the resource.
*/
readonly put: operations["setAutoDeclineSettings"];
readonly post?: never;
/**
* Delete auto decline settings
* @description Delete auto decline settings for the supplied project.
*
* The authenticated user must have PROJECT_ADMIN permission for this project to call the resource.
*/
readonly delete: operations["deleteAutoDeclineSettings"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/settings/auto-merge": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get pull request auto-merge settings
* @description Retrieves the pull request auto-merge settings for the supplied project. Default settings will be returned if no explicit settings have been set for the project
*
* The authenticated user must have PROJECT_VIEW permission for this project to call the resource.
*/
readonly get: operations["get_4"];
/**
* Create or update the pull request auto-merge settings
* @description Creates or updates the pull request auto-merge settings for the supplied project, and applies the restriction action specified in the request.
*
* The authenticated user must have PROJECT_ADMIN permission for this project to call the resource.
*/
readonly put: operations["set"];
readonly post?: never;
/**
* Delete pull request auto-merge settings
* @description Deletes pull request auto-merge settings for the supplied project.
*
* The authenticated user must have PROJECT_ADMIN permission for this project to call the resource.
*/
readonly delete: operations["delete_4"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/settings/hooks": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get repository hooks
* @description Retrieve a page of repository hooks for this project.
*
* The authenticated user must have PROJECT_READ permission for the specified project to call this resource.
*/
readonly get: operations["getRepositoryHooks"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/settings/hooks/{hookKey}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get a repository hook
* @description Retrieve a repository hook for this project.
*
* The authenticated user must have PROJECT_READ permission for the specified project to call this resource.
*/
readonly get: operations["getRepositoryHook"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/settings/hooks/{hookKey}/enabled": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
/**
* Enable repository hook
* @description Enable a repository hook for this project and optionally apply new configuration.
*
* The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.
*
* A JSON document may be provided to use as the settings for the hook. These structure and validity of the document is decided by the plugin providing the hook.
*/
readonly put: operations["enableHook"];
readonly post?: never;
/**
* Disable repository hook
* @description Disable a repository hook for this project.
*
* The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.
*/
readonly delete: operations["disableHook"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/settings/hooks/{hookKey}/settings": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get repository hook settings
* @description Retrieve the settings for a repository hook for this project.
*
* The authenticated user must have PROJECT_READ permission for the specified project to call this resource.
*/
readonly get: operations["getSettings"];
/**
* Update repository hook settings
* @description Modify the settings for a repository hook for this project.
*
* The service will reject any settings which are too large, the current limit is 32KB once serialized.
*
* The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.
*
* A JSON document can be provided to use as the settings for the hook. These structure and validity of the document is decided by the plugin providing the hook.
*/
readonly put: operations["setSettings"];
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/settings/pull-requests/{scmId}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get merge strategy
* @description Retrieve the merge strategy configuration for this project and SCM.
*
* The authenticated user must have PROJECT_READ permission for the context repository to call this resource.
*/
readonly get: operations["getPullRequestSettings"];
readonly put?: never;
/**
* Update merge strategy
* @description Update the pull request merge strategy configuration for this project and SCM.
*
* The authenticated user must have PROJECT_ADMIN permission for the context repository to call this resource.
*
* Only the strategies provided will be enabled, the default must be set and included in the set of strategies.
*
* An explicitly set pull request merge strategy configuration can be deleted by POSTing a document with an empty "mergeConfig" attribute. i.e:
* {
* "mergeConfig": {}
* }
*
*
* Upon completion of this request, the effective configuration will be the configuration explicitly set for the SCM, or if no such explicit configuration is set then the default configuration will be used.
*/
readonly post: operations["updatePullRequestSettings"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/settings/reviewer-groups": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get all reviewer groups
* @description Retrieve a page of reviewer groups of a given scope.
*
* The authenticated user must have PROJECT_READ permission for the specified project to call this resource.
*/
readonly get: operations["getReviewerGroups"];
readonly put?: never;
/**
* Create reviewer group
* @description Create a reviewer group.
*
* The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.
*/
readonly post: operations["create_1"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/settings/reviewer-groups/{id}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get reviewer group
* @description Retrieve a reviewer group.
*
* The authenticated user must have PROJECT_READ permission for the specified project to call this resource.
*/
readonly get: operations["getReviewerGroup"];
/**
* Update reviewer group attributes
* @description Update the attributes of a reviewer group.
*
* The authenticated user must have PROJECT_READ permission for the specified project to call this resource.
*/
readonly put: operations["update_1"];
readonly post?: never;
/**
* Delete reviewer group
* @description Deletes a reviewer group.
*
* The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.
*/
readonly delete: operations["delete_6"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/webhooks": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Find webhooks
* @description Find webhooks in this project.
*
* The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.
*/
readonly get: operations["findWebhooks"];
readonly put?: never;
/**
* Create webhook
* @description Create a webhook for the project specified via the URL.
*
* The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.
*/
readonly post: operations["createWebhook"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/webhooks/{webhookId}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get webhook
* @description Get a webhook by ID.
*
* The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.
*/
readonly get: operations["getWebhook"];
/**
* Update webhook
* @description Update an existing webhook.
*
* The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.
*/
readonly put: operations["updateWebhook"];
readonly post?: never;
/**
* Delete webhook
* @description Delete a webhook for the project specified via the URL.
*
* The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.
*/
readonly delete: operations["deleteWebhook"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/webhooks/{webhookId}/latest": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get last webhook invocation details
* @description Get the latest invocations for a specific webhook.
*
* The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.
*/
readonly get: operations["getLatestInvocation"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/webhooks/{webhookId}/statistics": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get webhook statistics
* @description Get the statistics for a specific webhook.
*
* The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.
*/
readonly get: operations["getStatistics"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/webhooks/{webhookId}/statistics/summary": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get webhook statistics summary
* @description Get the statistics summary for a specific webhook.
*
* The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.
*/
readonly get: operations["getStatisticsSummary"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/projects/{projectKey}/webhooks/test": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
/**
* Test webhook
* @description Test connectivity to a specific endpoint.
*
* The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.
*/
readonly post: operations["testWebhook"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/repos": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Search for repositories
* @description Retrieve a page of repositories based on query parameters that control the search. See the documentation of the parameters for more details.
*
* This resource is anonymously accessible.
*
* Note on permissions. In absence of the permission query parameter the implicit 'read' permission is assumed. Please note that this permission is lower than the REPO_READ permission rather than being equal to it. The implicit 'read' permission for a given repository is assigned to any user that has any of the higher permissions, such as REPO_READ, as well as to anonymous users if the repository is marked as public. The important implication of the above is that an anonymous request to this resource with a permission level REPO_READ is guaranteed to receive an empty list of repositories as a result. For anonymous requests it is therefore recommended to not specify the permission parameter at all.
*/
readonly get: operations["getRepositories_1"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/secret-scanning/exempt": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Find all repos exempt from secret scan
* @description Find all repositories exempt from secret scanning
*/
readonly get: operations["findExemptReposByScope"];
readonly put?: never;
/**
* Bulk exempt repos from secret scanning
* @description Bulk exempt a list of repositories from being scanned for secrets. User must be have global **ADMIN** permissions.
*/
readonly post: operations["bulkAddExemptRepositories"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/secret-scanning/rules": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Find global secret scanning rules
* @description Find global secret scanning rules by filtering.
*/
readonly get: operations["search_4"];
readonly put?: never;
/**
* Create global secret scanning rule
* @description Create a new global secret scanning rule. Global rules are used when scanning all non exempt repositories.
*/
readonly post: operations["createRule_2"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/secret-scanning/rules/{id}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get a global secret scanning rule
* @description Get a global secret scanning rule by ID.
*/
readonly get: operations["getRule_2"];
/**
* Edit a global secret scanning rule.
* @description Edit an existing global secret scanning rule
*/
readonly put: operations["editRule_2"];
readonly post?: never;
/**
* Delete a global secret scanning rule
* @description Delete a global secret scanning rule with the provided ID
*/
readonly delete: operations["deleteRule_2"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/signing/x509-certificates": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get all X.509 certificates
* @description Get all X.509 certificates that have been added to the system.
*
* The authenticated user must have the ADMIN permission to call this resource.
*/
readonly get: operations["getAllCertificates"];
readonly put?: never;
/**
* Create an X.509 certificate
* @description Create an X.509 certificate. This will add the given X.509 certificate to the system. Existing entries will not be overridden if an X.509 certificate already exists. Once added, an X.509 certificate cannot be updated.
*
* The authenticated user must have the ADMIN permission to call this resource.
*/
readonly post: operations["createCertificate"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/signing/x509-certificates/{id}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
readonly post?: never;
/**
* Delete an X.509 certificate
* @description Delete an X.509 certificate specified by the given ID.
*
* The authenticated user must have the ADMIN permission to call this resource.
*/
readonly delete: operations["deleteCertificate"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/signing/x509-certificates/crl/{id}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
/**
* Update X.509 CRL entries
* @description Update the certificate revocation list (CRL) entries for an issuer X.509 certificate in the system, identified by id. This will add any new revoked X.509 certificates that were issued by the given issuer X.509 certificate.
*
* This endpoint will schedule a request to asynchronously perform the task. Please allow time for the task to complete as it will vary depending on how many CRLs there are to retrieve and process.
*
* Note: CRL updates are scheduled to run every 24 hours. You may wish to trigger a refresh manually using this endpoint, otherwise, entries will be updated daily.
*
* The authenticated user must have the ADMIN permission to call this resource.
*/
readonly put: operations["updateCertificateRevocationListEntries"];
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/system-signing/configuration": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get system signing configuration
* @description Gets the configuration details for system signing Git objects.
*/
readonly get: operations["getSystemSigningConfiguration"];
readonly put?: never;
/**
* Update system signing configuration
* @description Updates the configuration for system signing Git objects.
*/
readonly post: operations["updateSystemSigningConfiguration"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/users": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get all users
* @description Retrieve a page of users, optionally run through provided filters.
*
*
* Only authenticated users may call this resource.
* ### Permission Filters
*
*
* The following three sub-sections list parameters supported for permission filters (where [root] is
* the root permission filter name, e.g. permission, permission.1 etc.) depending on the
* permission resource. The system determines which filter to apply (Global, Project or Repository permission)
* based on the `[root]` permission value. E.g. ADMIN is a global permission,
* PROJECT_ADMIN is a project permission and REPO_ADMIN is a repository permission. Note
* that the parameters for a given resource will be looked up in the order as they are listed below, that is e.g.
* for a project resource, if both projectId and projectKey are provided, the system will
* use projectId for the lookup.
* Global permissions
*
*
* The permission value under [root] is the only required and recognized parameter, as global
* permissions do not apply to a specific resource.
*
*
* Example valid filter: permission=ADMIN.
* Project permissions
*
*
* - [root]- specifies the project permission
* - [root].projectId - specifies the project ID to lookup the project by
* - [root].projectKey - specifies the project key to lookup the project by
*
*
* Example valid filter: permission.1=PROJECT_ADMIN&permission.1.projectKey=TEST_PROJECT.
* #### Repository permissions
*
*
* - [root]- specifies the repository permission
* - [root].projectId - specifies the repository ID to lookup the repository by
* - [root].projectKey and [root].repositorySlug- specifies the project key and repository slug to lookup the repository by; both values need to be provided for this look up to be triggered
*
*
* Example valid filter: permission.2=REPO_ADMIN&permission.2.projectKey=TEST_PROJECT&permission.2.repositorySlug=test_repo.
*/
readonly get: operations["getUsers_2"];
/**
* Update user details
* @description Update the currently authenticated user's details. The update will always be applied to the currently authenticated user.
*/
readonly put: operations["updateUserDetails_1"];
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/users/{userSlug}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get user
* @description Retrieve the user matching the supplied userSlug.
*/
readonly get: operations["getUser"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/users/{userSlug}/avatar.png": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
/**
* Update user avatar
* @description Update the avatar for the user with the supplied slug.
*
*
* This resource accepts POST multipart form data, containing a single image in a form-field named 'avatar'.
*
*
* There are configurable server limits on both the dimensions (1024x1024 pixels by default) and uploaded
* file size (1MB by default). Several different image formats are supported, but PNG and
* JPEG are preferred due to the file size limit.
*
*
* This resource has Cross-Site Request Forgery (XSRF) protection. To allow the request to
* pass the XSRF check the caller needs to send an X-Atlassian-Token HTTP header with the
* value no-check.
*
*
* An example curl request to upload an image name 'avatar.png' would be:
* ```
* curl -X POST -u username:password -H "X-Atlassian-Token: no-check" http://example.com/rest/api/latest/users/jdoe/avatar.png -F avatar=@avatar.png
* ```
*
*
* Users are always allowed to update their own avatar. To update someone else's avatar the authenticated user must
* have global ADMIN permission, or global SYS_ADMIN permission to update a
* SYS_ADMIN user's avatar.
*/
readonly post: operations["uploadAvatar_1"];
/**
* Delete user avatar
* @description Delete the avatar associated to a user.
*
*
* Users are always allowed to delete their own avatar. To delete someone else's avatar the authenticated user must
* have global ADMIN permission, or global SYS_ADMIN permission to update a
* SYS_ADMIN user's avatar.
*/
readonly delete: operations["deleteAvatar"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/users/{userSlug}/settings": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get user settings
* @description Retrieve a map of user setting key values for a specific user identified by the user slug.
*/
readonly get: operations["getUserSettings"];
readonly put?: never;
/**
* Update user settings
* @description Update the entries of a map of user setting key/values for a specific user identified by the user slug.
*/
readonly post: operations["updateSettings"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/api/latest/users/credentials": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
/**
* Set password
* @description Update the currently authenticated user's password.
*/
readonly put: operations["updateUserPassword_1"];
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/audit/latest/notification-settings/retention-config-review": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
readonly post?: never;
/**
* Dismiss retention config notification
* @description Dismisses the retention config review notification displayed by the audit plugin for the user that's currently logged in.
*/
readonly delete: operations["dismissRetentionConfigReviewNotification"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/branch-permissions/latest/projects/{projectKey}/repos/{repositorySlug}/restrictions": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Search for ref restrictions
* @description Search for restrictions using the supplied parameters.
*
* The authenticated user must have REPO_ADMIN permission or higher to call this resource. Only authenticated users may call this resource.
*/
readonly get: operations["getRestrictions_1"];
readonly put?: never;
/**
* Create multiple ref restrictions
* @description Allows creating multiple restrictions at once.
*/
readonly post: operations["createRestrictions_1"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/branch-permissions/latest/projects/{projectKey}/repos/{repositorySlug}/restrictions/{id}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get a ref restriction
* @description Returns a restriction as specified by a restriction id.
*
* The authenticated user must have REPO_ADMIN permission or higher to call this resource. Only authenticated users may call this resource.
*/
readonly get: operations["getRestriction_1"];
readonly put?: never;
readonly post?: never;
/**
* Delete a ref restriction
* @description Deletes a restriction as specified by a restriction id.
*
* The authenticated user must have REPO_ADMIN permission or higher to call this resource. Only authenticated users may call this resource.
*/
readonly delete: operations["deleteRestriction_1"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/branch-permissions/latest/projects/{projectKey}/restrictions": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Search for ref restrictions
* @description Search for restrictions using the supplied parameters.
*
* The authenticated user must have PROJECT_ADMIN permission or higher to call this resource. Only authenticated users may call this resource.
*/
readonly get: operations["getRestrictions"];
readonly put?: never;
/**
* Create multiple ref restrictions
* @description Allows creating multiple restrictions at once.
*/
readonly post: operations["createRestrictions"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/branch-permissions/latest/projects/{projectKey}/restrictions/{id}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get a ref restriction
* @description Returns a restriction as specified by a restriction id.
*
* The authenticated user must have PROJECT_ADMIN permission or higher to call this resource. Only authenticated users may call this resource.
*/
readonly get: operations["getRestriction"];
readonly put?: never;
readonly post?: never;
/**
* Delete a ref restriction
* @description Deletes a restriction as specified by a restriction id.
*
* The authenticated user must have PROJECT_ADMIN permission or higher to call this resource. Only authenticated users may call this resource.
*/
readonly delete: operations["deleteRestriction"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/branch-utils/latest/projects/{projectKey}/repos/{repositorySlug}/branches": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
/**
* Create branch
* @description Creates a branch in the specified repository.
*
*
* The authenticated user must have an effective REPO_WRITE permission to call this resource. If
* branch permissions are set up in the repository, the authenticated user must also have access to the branch name
* that is to be created.
*/
readonly post: operations["createBranch"];
/**
* Delete branch
* @description Deletes a branch in the specified repository.
*
*
* If the branch does not exist, this operation will not raise an error. In other words after calling this resource
* and receiving a 204 response the branch provided in the request is guaranteed to not exist in the specified
* repository any more, regardless of its existence beforehand.
*
*
* The optional 'endPoint' parameter of the request may contain a commit ID that the provided ref name is
* expected to point to. Should the ref point to a different commit ID, a 400 response will be returned with
* appropriate error details.
*
*
* The authenticated user must have an effective REPO_WRITE permission to call this resource. If
* branch permissions are set up in the repository, the authenticated user must also have access to the branch name
* that is to be deleted.
*/
readonly delete: operations["deleteBranch"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/branch-utils/latest/projects/{projectKey}/repos/{repositorySlug}/branches/info/{commitId}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get branch
* @description Gets the branch information associated with a single commit from a given repository.
*/
readonly get: operations["findByCommit"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/build-status/latest/commits/{commitId}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get build statuses for commit
* @deprecated
* @description Gets build statuses associated with a commit.
*
* Deprecated in 7.14, please use the repository based builds resource instead.
*/
readonly get: operations["getBuildStatus"];
readonly put?: never;
/**
* Create build status for commit
* @deprecated
* @description Associates a build status with a commit.The state, the key and the url fields are mandatory. The name anddescription fields are optional.All fields (mandatory or optional) are limited to 255 characters, except for the url,which is limited to 450 characters.Supported values for the state are SUCCESSFUL, FAILEDand INPROGRESS.The authenticated user must have LICENSED permission or higher to call this resource.
*
* Deprecated in 7.14, please use the repository based builds resource instead.
*/
readonly post: operations["addBuildStatus"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/build-status/latest/commits/stats": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
/**
* Get build status statistics for multiple commits
* @description Produces a list of the build statistics for multiple commits. Commits without any builds associated with them will not be returned.
For example if the commit e00cf62997a027bbf785614a93e2e55bb331d268 does not have any build statuses associated with it, it will not be present in the response.
*/
readonly post: operations["getMultipleBuildStatusStats"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/build-status/latest/commits/stats/{commitId}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get build status statistics for commit
* @description Gets statistics regarding the builds associated with a commit
*/
readonly get: operations["getBuildStatusStats"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/comment-likes/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/comments/{commentId}/reactions/{emoticon}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
/**
* React to a comment
* @description Add an emoticon reaction to a comment
*/
readonly put: operations["react"];
readonly post?: never;
/**
* Remove a reaction from comment
* @description Remove an emoticon reaction from a comment
*/
readonly delete: operations["unReact"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/comment-likes/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments/{commentId}/reactions/{emoticon}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
/**
* React to a PR comment
* @description Add an emoticon reaction to a pull request comment
*/
readonly put: operations["react_1"];
readonly post?: never;
/**
* Remove a reaction from a PR comment
* @description Remove an emoticon reaction from a pull request comment
*/
readonly delete: operations["unReact_1"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/default-reviewers/latest/projects/{projectKey}/condition": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
/**
* Create default reviewer
* @description Create a default reviewer pull request condition for the given project.
*/
readonly post: operations["createPullRequestCondition"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/default-reviewers/latest/projects/{projectKey}/condition/{id}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
/**
* Update the default reviewer
* @description Update the default reviewer pull request condition for the given ID.
*/
readonly put: operations["updatePullRequestCondition"];
readonly post?: never;
/**
* Remove default reviewer
* @description Delete the default reviewer pull request condition associated with the given ID.
*/
readonly delete: operations["deletePullRequestCondition"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/default-reviewers/latest/projects/{projectKey}/conditions": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get default reviewers
* @description Return a page of default reviewer pull request conditions that have been configured for this project.
*/
readonly get: operations["getPullRequestConditions"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/default-reviewers/latest/projects/{projectKey}/repos/{repositorySlug}/condition": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
/**
* Create default reviewers condition
* @description Create a default reviewer pull request condition for the given repository.
*/
readonly post: operations["createPullRequestCondition_1"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/default-reviewers/latest/projects/{projectKey}/repos/{repositorySlug}/condition/{id}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
/**
* Update a default reviewer condition
* @description Update the default reviewer pull request condition for the given ID.
*/
readonly put: operations["updatePullRequestCondition_1"];
readonly post?: never;
/**
* Delete a default reviewer condition
* @description Delete the default reviewer pull request condition associated with the given ID.
*/
readonly delete: operations["deletePullRequestCondition_1"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/default-reviewers/latest/projects/{projectKey}/repos/{repositorySlug}/conditions": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get configured default reviewers
* @description Return a page of default reviewer pull request conditions that have been configured for this repository.
*/
readonly get: operations["getPullRequestConditions_1"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/default-reviewers/latest/projects/{projectKey}/repos/{repositorySlug}/reviewers": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get required reviewers for PR creation
* @description Return a set of users who are required reviewers for pull requests created from the given source repository and ref to the given target ref in this repository.
*/
readonly get: operations["getReviewers"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/default-tasks/latest/projects/{projectKey}/repos/{repositorySlug}/tasks": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get a page of default tasks
* @description Retrieves the default tasks for the supplied repository.
*
* The authenticated user must have **REPO_VIEW** permission for this repository to call the resource.
*/
readonly get: operations["getDefaultTasks_1"];
readonly put?: never;
/**
* Add a default task
* @description Creates a default task for the supplied repository.
*
* The authenticated user must have **REPO_ADMIN** permission for this repository to call the resource.
*/
readonly post: operations["addDefaultTask_1"];
/**
* Deletes all default tasks for the repository
* @description Delete all the default tasks for the supplied repository
*
* The authenticated user must have **REPO_ADMIN** permission for this repository to call the resource.
*/
readonly delete: operations["deleteAllDefaultTasks_1"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/default-tasks/latest/projects/{projectKey}/repos/{repositorySlug}/tasks/{taskId}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
/**
* Update a default task
* @description Updates a default task for the supplied repository.
*
* The authenticated user must have **REPO_ADMIN** permission for this repository to call the resource.
*/
readonly put: operations["updateDefaultTask_1"];
readonly post?: never;
/**
* Delete a specific default task
* @description Delete a specific default task for a repository.
*
* The authenticated user must have **REPO_ADMIN** permission for this repository to call the resource.
*/
readonly delete: operations["deleteDefaultTask_1"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/default-tasks/latest/projects/{projectKey}/tasks": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get a page of default tasks
* @description Retrieves the default tasks for the supplied project.
*
* The authenticated user must have **PROJECT_VIEW** permission for this project to call the resource.
*/
readonly get: operations["getDefaultTasks"];
readonly put?: never;
/**
* Add a default task
* @description Creates a default task for the project.
*
* The authenticated user must have **PROJECT_ADMIN** permission for this project to call the resource.
*/
readonly post: operations["addDefaultTask"];
/**
* Deletes all default tasks for the project
* @description Delete all the default tasks for the supplied project
*
* The authenticated user must have **PROJECT_ADMIN** permission for this project to call the resource.
*/
readonly delete: operations["deleteAllDefaultTasks"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/default-tasks/latest/projects/{projectKey}/tasks/{taskId}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
/**
* Update a default task
* @description Updates a default task for the supplied project.
*
* The authenticated user must have **PROJECT_ADMIN** permission for this project to call the resource.
*/
readonly put: operations["updateDefaultTask"];
readonly post?: never;
/**
* Delete a specific default task
* @description Delete a specific default task for a project.
*
* The authenticated user must have **PROJECT_ADMIN** permission for this project to call the resource.
*/
readonly delete: operations["deleteDefaultTask"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/git/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/rebase": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Check PR rebase precondition
* @description Checks preconditions to determine whether the pull request can be rebased.
*
* Some of the preconditions are:
*
* - The pull request is between Git repositories
* - The pull request is currently open
* - The pull request's {@link PullRequest#getFromRef "from" ref} is a branch
* - In other words, the qualified ID for the "from" ref must start with refs/heads/
* - Tags, and other non-standard refs, cannot be rebased
* - The current user has an e-mail address
* - Pull requests cannot be rebased anonymously
* - `git rebase` records the current user as the committer for the rebased commits, which requires a name and e-mail address
* - The current user has write access to the {@link PullRequest#getFromRef "from" ref}'s repository
* - Note that in order to view a pull request a user is only required to have read access to the {@link PullRequest#getToRef toRef}'s repository, so just because a user can see a pull request does not mean they can request a rebase
*
*
* This list is not exhaustive, and the exact set of preconditions applied can be extended by third-party add-ons.
*
* The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
*/
readonly get: operations["canRebase"];
readonly put?: never;
/**
* Rebase pull request
* @description Rebases the specified pull request, rewriting the incoming commits to start from the tip commit of the pull request's target branch. This operation alters the pull request's source branch and cannot be undone.
*
* The authenticated user must have REPO_READ permission for the repository that this pull request targets and REPO_WRITE permission for the pull request's source repository to call this resource.
*/
readonly post: operations["rebase"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/git/latest/projects/{projectKey}/repos/{repositorySlug}/tags": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
/**
* Create tag
* @description Creates a tag in the specified repository.
*
* The authenticated user must have an effective REPO_WRITE permission to call this resource.
*
* 'LIGHTWEIGHT' and 'ANNOTATED' are the two type of tags that can be created. The 'startPoint' can either be a ref or a 'commit'.
*/
readonly post: operations["createTag"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/git/latest/projects/{projectKey}/repos/{repositorySlug}/tags/{name}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
readonly post?: never;
/**
* Delete tag
* @description Deletes a tag in the specified repository.
*
* The authenticated user must have an effective REPO_WRITE permission to call this resource.
*/
readonly delete: operations["deleteTag"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/gpg/latest/keys": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get all GPG keys
* @description Find all the keys for the currently authenticated user. Optionally, users with ADMIN and higher permissions may choose to specify the user parameter to retrieve GPG keys for another user.
*
* Only authenticated users may call this endpoint.
*/
readonly get: operations["getKeysForUser"];
readonly put?: never;
/**
* Create a GPG key
* @description Add a GPG key to the authenticated user's account. Optionally, users with ADMIN and higher permissions may choose to specify the user parameter to add a GPG key for another user.
*
* Only authenticated users may call this endpoint.
*/
readonly post: operations["addKey"];
/**
* Delete all GPG keys for user
* @description Delete all GPG keys for a supplied user.
*/
readonly delete: operations["deleteForUser"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/gpg/latest/keys/{fingerprintOrId}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
readonly post?: never;
/**
* Delete a GPG key
* @description Delete the GPG key with the specified ID or Key Fingerprint.
*/
readonly delete: operations["deleteKey"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/insights/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/annotations": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get Code Insights annotations for a commit
* @description Get annotations for the given commit ID, filtered by any query parameters given.
*/
readonly get: operations["getAnnotations_1"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/insights/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/reports": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get all Code Insights reports for a commit
* @description Retrieve all reports for the given commit.
*/
readonly get: operations["getReports"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/insights/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/reports/{key}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get a Code Insights report
* @description Retrieve the specified report.
*/
readonly get: operations["getACodeInsightsReport"];
/**
* Create a Code Insights report
* @description Create a new insight report, or replace the existing one if a report already exists for the given repository, commit, and report key. A request to replace an existing report will be rejected if the authenticated user was not the creator of the specified report.
*
* The report key should be a unique string chosen by the reporter and should be unique enough not to potentially clash with report keys from other reporters. We recommend using reverse DNS namespacing or a similar standard to ensure that collision is avoided.Report parameters
| Parameter | Description | Required? | Restrictions | Type |
|---|---|---|---|---|
| title | A short string representing the name of the report | Yes | Max length: 450 characters (but we recommend that it is shorter so that the display is nicer) | String |
| details | A string to describe the purpose of the report. This string may contain escaped newlines and if it does it will display the content accordingly. | No | Max length: 2000 characters | String |
| result | Indicates whether the report is in a passed or failed state | No | One of: PASS, FAIL | String |
| data | An array of data fields (described below) to display information on the report | No | Maximum 6 data fields | Array |
| reporter | A string to describe the tool or company who created the report | No | Max length: 450 characters | String |
| link | A URL linking to the results of the report in an external tool. | No | Must be a valid http or https URL | String |
| logoUrl | A URL to the report logo. If none is provided, the default insights logo will be used. | No | Must be a valid http or https URL | String |
| Parameter | Description | Type |
|---|---|---|
| title | A string describing what this data field represents | String |
| type | The type of data contained in the value field. If not provided, then the value will be detected as a boolean, number or string. One of: BOOLEAN, DATE, DURATION, LINK, NUMBER, PERCENTAGE, TEXT | String |
| value | A value based on the type provided. Either a raw value (string, number or boolean) or a map. See below. |
| Type Field | Value Field Type | Value Field Display |
|---|---|---|
| None/Omitted | Number, String or Boolean (not an array or object) | Plain text |
| BOOLEAN | Boolean | The value will be read as a JSON boolean and displayed as 'Yes' or 'No'. |
| DATE | Number | The value will be read as a JSON number in the form of a Unix timestamp (milliseconds) and will be displayed as a relative date if the date is less than one week ago, otherwise it will be displayed as an absolute date. |
| DURATION | Number | The value will be read as a JSON number in milliseconds and will be displayed in a human readable duration format. |
| LINK | Object: {"linktext": "Link text here", "href": "https://link.to.annotation/in/external/tool"} | The value will be read as a JSON object containing the fields "linktext" and "href" and will be displayed as a clickable link on the report. |
| NUMBER | Number | The value will be read as a JSON number and large numbers will be displayed in a human readable format (e.g. 14.3k). |
| PERCENTAGE | Number (between 0 and 100) | The value will be read as a JSON number between 0 and 100 and will be displayed with a percentage sign. |
| TEXT | String | The value will be read as a JSON string and will be displayed as-is |
keyId on the repository identified in the URL.
*/
readonly get: operations["getForRepository"];
readonly put?: never;
readonly post?: never;
/**
* Revoke repository SSH key
* @description Remove an existing access key for the repository identified in the URL. If the same SSH key is used as an access key for multiple projects or repositories, only the access to the repository identified in the URL will be revoked.
*/
readonly delete: operations["revokeForRepository"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/keys/latest/projects/{projectKey}/repos/{repositorySlug}/ssh/{keyId}/permission/{permission}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
/**
* Update repository SSH key permission
* @description Updates the permission granted to the specified SSH key to the repository identified in the URL.
*/
readonly put: operations["updatePermission_1"];
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/keys/latest/projects/{projectKey}/ssh": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get SSH key
* @description Retrieves the access keys for the project identified in the URL.
*/
readonly get: operations["getSshKeysForProject"];
readonly put?: never;
/**
* Add project SSH key
* @description Register a new SSH key and grants access to the project identified in the URL.
*/
readonly post: operations["addForProject"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/keys/latest/projects/{projectKey}/ssh/{keyId}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get project SSH key
* @description Retrieves the access key for the SSH key with id keyId on the project identified in the URL.
*/
readonly get: operations["getForProject"];
readonly put?: never;
readonly post?: never;
/**
* Revoke project SSH key
* @description Remove an existing access key for the project identified in the URL. If the same SSH key is used as an access key for multiple projects or repositories, only the access to the project identified in the URL will be revoked.
*/
readonly delete: operations["revokeForProject"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/keys/latest/projects/{projectKey}/ssh/{keyId}/permission/{permission}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
/**
* Update project SSH key permission
* @description Updates the permission granted to the specified SSH key to the project identified in the URL.
*/
readonly put: operations["updatePermission"];
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/keys/latest/ssh/{keyId}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
readonly post?: never;
/**
* Revoke project SSH key
* @description Remove an existing access key for the projects and repositories in the submitted entity. If the same SSH key is used as an access key for multiple projects or repositories not supplied, only the access to the projects or repositories identified will be revoked.
*/
readonly delete: operations["revokeMany"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/keys/latest/ssh/{keyId}/projects": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get project SSH keys
* @description Retrieves all project-related access keys for the SSH key with id keyId. If the current user is not an admin any of the projects the key provides access to, none are returned.
*/
readonly get: operations["getForProjects"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/keys/latest/ssh/{keyId}/repos": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get repository SSH key
* @description Retrieves all repository-related access keys for the SSH key with id keyId. If the current user is not an admin of any of the projects the key provides access to, none are returned.
*/
readonly get: operations["getForRepositories"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/mirroring/latest/account/settings/preferred-mirror": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get preferred mirror
* @description Retrieves the current user's preferred mirror server
*/
readonly get: operations["getPreferredMirrorId"];
readonly put?: never;
/**
* Set preferred mirror
* @description Sets the mirror specified by a mirror ID as the current user's preferred mirror
*/
readonly post: operations["setPreferredMirrorId"];
/**
* Remove preferred mirror
* @description Removes the current user's preferred mirror
*/
readonly delete: operations["deletePreferredMirrorId"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/mirroring/latest/analyticsSettings": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get analytics settings from upstream
* @description Gets the analytics settings from the mirroring upstream
*/
readonly get: operations["analyticsSettings"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/mirroring/latest/authenticate": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
/**
* Authenticate on behalf of a user
* @description Authenticates on behalf of a user. Used by mirrors to check the credentials supplied to them by users. If successful a user and their effective permissions are returned as follows -
*
* * For SSH credentials - all the effective user permissions are returned.
* * For all other credentials - the highest global permission is returned along with highest repository permission if repository ID is also provided in the request.
*
* Currently only username/password, bearer token and SSH credentials are supported.
*/
readonly post: operations["authenticate"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/mirroring/latest/farmNodes": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get farm nodes
* @description Retrieves the list of farm nodes in this cluster
*/
readonly get: operations["getFarmNodes"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/mirroring/latest/mirrorRepos/{externalRepositoryId}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get clone URLs
* @description Retrieves all available clone urls for the specified repository.
*/
readonly get: operations["getMirroredRepository"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/mirroring/latest/mirrorServers": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get all mirrors
* @description Returns a list of mirrors
*/
readonly get: operations["listMirrors"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/mirroring/latest/mirrorServers/{mirrorId}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get mirror by ID
* @description Returns the mirror specified by a mirror ID
*/
readonly get: operations["getMirror"];
/**
* Upgrade mirror server
* @description Upgrades the mirror server in question with the provided details.This endpoint can only be called by the mirror instance or system administrators {"discovering":false,"syncedRepos":0,"totalRepos":0} {"discovering":true,"syncedRepos":3,"totalRepos":100} {"discovering":false,"syncedRepos":242,"totalRepos":1071}
*/
readonly get: operations["getSynchronizationProgress"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/mirroring/latest/projects/{projectId}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get project
* @description Returns the requested project using its primary key ID.plugin.mirroring.repository.diagnostics.sync.tolerance. The detection of out of sync repositories is dependent on the timing of a scheduled job which is controlled by a configuration property plugin.mirroring.synchronization.interval which means in worst case it can take upto plugin.mirroring.repository.diagnostics.sync.tolerance + plugin.mirroring.synchronization.interval time to detect an out-of-sync repository.To use this API, a configuration property plugin.mirroring.repository.diagnostics.sync.enabled has to be set to true as this feature is disabled by default.
*/
readonly get: operations["getOutOfSyncRepositories"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/mirroring/latest/supportInfo/projects/{projectKey}/repos/{repositorySlug}/repo-lock-owner": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get the repository lock owner for the syncing process
* @description Retrieves the information about the process owning the sync lock for this repository. The process owning the lock could be running on any of the nodes in the mirror farm
*/
readonly get: operations["getRepositoryLockOwner"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/mirroring/latest/supportInfo/projects/{projectKey}/repos/{repositorySlug}/repoSyncStatus": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Gets information about the mirrored repository
* @description Retrieves information about an external repository mirrored by the mirror server. Particularly the local ID & external ID of the repository
*/
readonly get: operations["getRepoSyncStatus_1"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/mirroring/latest/supportInfo/refChangesQueue": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get items in ref changes queue
* @description Retrieves a list of up to plugin.mirroring.farm.max.ref.change.queue.dump.size items currently in the ref changes queue. The ref changes queue is an internal component of every mirror farm, and is shared between all nodes. When the contents of an upstream repository changes, an item is added to this queue so that the mirror farm nodes know to synchronize. The mirror farm constantly polls and removes items from this queue for processing, so it is empty most of the time.
*/
readonly get: operations["getRefChangesQueue"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/mirroring/latest/supportInfo/refChangesQueue/count": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get total number of items in ref changes queue
* @description Retrieves the total number of items currently in the ref changes queue
*/
readonly get: operations["getRefChangesQueueCount"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/mirroring/latest/supportInfo/repo-lock-owners": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get all the repository lock owners for the syncing process
* @description Retrieves the information about all the processes from the all the nodes in the mirror farm owning sync lock for any repository
*/
readonly get: operations["getRepositoryLockOwners"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/mirroring/latest/supportInfo/repoSyncStatus": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get sync status of repositories
* @description Retrieves a page of sync statuses of the repositories on this mirror node
*/
readonly get: operations["getRepoSyncStatus"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/mirroring/latest/syncSettings": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get upstream settings
* @description Retrieves upstream settings
*/
readonly get: operations["getMirrorSettings"];
/**
* Update upstream settings
* @description Sets the settings for the specified upstream
*/
readonly put: operations["setMirrorSettings"];
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/mirroring/latest/syncSettings/mode": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get mirror mode
* @description Gets the current mirror mode
*/
readonly get: operations["getMirrorMode"];
/**
* Update mirror mode
* @description Sets the mirror mode for the specified upstream
*/
readonly put: operations["setMirrorMode"];
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/mirroring/latest/syncSettings/projects": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get mirrored project IDs
* @description Returns the IDs of the projects that the mirror is configured to mirror
*/
readonly get: operations["getMirroredProjects"];
readonly put?: never;
/**
* Add multiple projects to be mirrored
* @description Configures the mirror to mirror the provided projects
*/
readonly post: operations["startMirroringProjects"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/mirroring/latest/syncSettings/projects/{projectId}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
/**
* Add project to be mirrored
* @description Configures the mirror to mirror the provided project
*/
readonly post: operations["startMirroringProject"];
/**
* Stop mirroring project
* @description Configures the mirror to no longer mirror the provided project
*/
readonly delete: operations["stopMirroringProject"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/mirroring/latest/upstreamServer": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get upstream server
* @description Retrieves upstream server details.
*/
readonly get: operations["getUpstreamServer"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/mirroring/latest/zdu/end": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
/**
* End ZDU upgrade on mirror farm
* @description Finalizes the ZDU upgrade on the mirror farm denying heterogeneous cluster formation
*/
readonly post: operations["endRollingUpgrade"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/mirroring/latest/zdu/start": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
/**
* Start ZDU upgrade on mirror farm
* @description Enables upgrading of individual nodes within the cluster, allowing a heterogeneous cluster formation
*/
readonly post: operations["startRollingUpgrade"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/policies/latest/admin/repos/archive": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get repository archive policy
* @description Retrieves the repository archive policy for the instance.
*
* The user must be authenticated to access this resource.
*/
readonly get: operations["getRepositoryArchivePolicy"];
/**
* Update repository archive policy
* @description Sets the repository archive policy for the instance.
*
* The authenticated user must have SYS_ADMIN permission.
*/
readonly put: operations["setRepositoryArchivePolicy"];
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/policies/latest/admin/repos/delete": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get repository delete policy
* @description Retrieves the repository delete policy for the instance.
*
* The user must be authenticated to access this resource.
*/
readonly get: operations["getRepositoryDeletePolicy"];
/**
* Update the repository delete policy
* @description Sets the repository delete policy for the instance.
*
* The authenticated user must have SYS_ADMIN permission.
*/
readonly put: operations["setRepositoryDeletePolicy"];
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/required-builds/latest/projects/{projectKey}/repos/{repositorySlug}/condition": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
/**
* Create a required builds merge check
* @description Create a required build merge check for the given repository.
*
* The authenticated user must have **REPO_ADMIN** permission for the target repository to register a required build merge check.
*
* The contents of the required build merge check request are:
*
* These fields are **required**:
*
* - **buildParentKeys**: A non-empty list of build parent keys that require green builds for this merge check to pass
* - **refMatcher.id**: The value to match refs against in the target branch
* - **refMatcher.type.id**: The type of ref matcher, one of: "ANY_REF", "BRANCH", "PATTERN", "MODEL_CATEGORY" or "MODEL_BRANCH"
*
*
* These fields are optional:
*
* - **exemptRefMatcher.id** The value to exempt refs in the source branch from this check
* - **exemptRefMatcher.type.id**: The type of exempt ref matcher, one of: "ANY_REF", "BRANCH", "PATTERN", "MODEL_CATEGORY" or "MODEL_BRANCH"
*
*
*
*/
readonly post: operations["createRequiredBuildsMergeCheck"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/required-builds/latest/projects/{projectKey}/repos/{repositorySlug}/condition/{id}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
/**
* Update a required builds merge check
* @description Update the required builds merge check for the given ID.
*
* The authenticated user must have **REPO_ADMIN** permission for the target repository to update a required build merge check.
*
* The contents of the required build merge check request are:
*
* These fields are **required**:
*
* - **buildParentKeys**: A non-empty list of build parent keys that require green builds for this merge check to pass
* - **refMatcher.id**: The value to match refs against in the target branch
* - **refMatcher.type.id**: The type of ref matcher, one of: "ANY_REF", "BRANCH", "PATTERN", "MODEL_CATEGORY" or "MODEL_BRANCH"
*
*
* These fields are optional:
*
* - **exemptRefMatcher.id** The value to exempt refs in the source branch from this check
* - **exemptRefMatcher.type.id**: The type of exempt ref matcher, one of: "ANY_REF", "BRANCH", "PATTERN", "MODEL_CATEGORY" or "MODEL_BRANCH"
*
*
*
*/
readonly put: operations["updateRequiredBuildsMergeCheck"];
readonly post?: never;
/**
* Delete a required builds merge check
* @description Deletes a required build existing merge check, given it's ID.
*
* The authenticated user must have **REPO_ADMIN** permission for the target repository to delete a required build merge check.
*/
readonly delete: operations["deleteRequiredBuildsMergeCheck"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/required-builds/latest/projects/{projectKey}/repos/{repositorySlug}/conditions": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get required builds merge checks
* @description Returns a page of required build merge checks that have been configured for this repository.
*
* The authenticated user must have **REPO_READ** permission for the target repository to request a page of required build merge checks.
*/
readonly get: operations["getPageOfRequiredBuildsMergeChecks"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/ssh/latest/keys": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get SSH keys for user
* @description Retrieve a page of SSH keys.
*/
readonly get: operations["getSshKeys"];
readonly put?: never;
/**
* Add SSH key for user
* @description Add a new SSH key to a supplied user.
*/
readonly post: operations["addSshKey"];
/**
* Delete all user SSH key
* @description Delete all SSH keys for a supplied user.
*/
readonly delete: operations["deleteSshKeys"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/ssh/latest/keys/{keyId}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get SSH key for user by keyId
* @description Retrieve an SSH key by keyId
*
* The authenticated user must have ADMIN permission or higher to call this resource.
*/
readonly get: operations["getSshKey"];
readonly put?: never;
readonly post?: never;
/**
* Remove SSH key
* @description Delete an SSH key.
*
* The authenticated user must have ADMIN permission or higher to call this resource.
*/
readonly delete: operations["deleteSshKey"];
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/ssh/latest/settings": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get SSH settings
* @description Gets the SSH settings from the upstream.
*/
readonly get: operations["sshSettings"];
readonly put?: never;
readonly post?: never;
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/sync/latest/projects/{projectKey}/repos/{repositorySlug}": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
/**
* Get synchronization status
* @description Retrieves the synchronization status for the specified repository. In addition to listing refs which cannot be synchronized, if any, the status also provides the timestamp for the most recent synchronization and indicates whether synchronization is available and enabled. If "?at" is specified in the URL, the synchronization status for the specified ref is returned, rather than the complete repository status.
*
* The authenticated user must have REPO_READ permission for the repository, or it must be public if the request is anonymous. Additionally, after synchronization is enabled for a repository, meaning synchronization was available at that time, permission changes and other actions can cause it to become unavailable. Even when synchronization is enabled, if it is no longer available for the repository it will not be performed.
*/
readonly get: operations["getStatus"];
readonly put?: never;
/**
* Disable synchronization
* @description Enables or disables synchronization for the specified repository. When synchronization is enabled, branches within the repository are immediately synchronized and the status is updated with the outcome. That initial synchronization is performed before the REST request returns, allowing it to return the updated status.
*
* The authenticated user must have REPO_ADMIN permission for the specified repository. Anonymous users cannot manage synchronization, even on public repositories. Additionally, synchronization must be available for the specified repository. Synchronization is only available if:
*
* - The repository is a fork, since its origin is used as upstream
* - The owning user still has access to the fork's origin, if the repository is a personalfork
*/
readonly post: operations["setEnabled"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
readonly "/sync/latest/projects/{projectKey}/repos/{repositorySlug}/synchronize": {
readonly parameters: {
readonly query?: never;
readonly header?: never;
readonly path?: never;
readonly cookie?: never;
};
readonly get?: never;
readonly put?: never;
/**
* Manual synchronization
* @description Allows developers to apply a manual operation to bring a ref back in sync with upstream when it becomes out of sync due to conflicting changes. The following actions are supported:
*
* - MERGE: Merges in commits from the upstream ref. After applying this action, the synchronized ref will be AHEAD (as it still includes commits that do not exist upstream.
* - This action is only supported for DIVERGED refs
* - If a "commitMessage" is provided in the context, it will be used on the merge commit. Otherwise a default message is used.
* - DISCARD: Throws away local changes in favour of those made upstream. This is a destructive operation where commits in the local repository are lost.
* - No context entries are supported for this action
* - If the upstream ref has been deleted, the local ref is deleted as well
* - Otherwise, the local ref is updated to reference the same commit as upstream, even if the update is not fast-forward (similar to a forced push)
*
*
* The authenticated user must have REPO_WRITE permission for the specified repository. Anonymous users cannot synchronize refs, even on public repositories. Additionally, synchronization must be enabled and available for the specified repository.
*/
readonly post: operations["synchronize"];
readonly delete?: never;
readonly options?: never;
readonly head?: never;
readonly patch?: never;
readonly trace?: never;
};
}
export type webhooks = Recordpath should be modified or created. */
readonly branch?: string;
/** @description The full content of the file at path. */
readonly content?: string;
/** @description The message associated with this change, to be used as the commit message. Or null if the default message should be used. */
readonly message?: string;
/** @description The starting point for branch. If provided and different from branch, branch will be created as a new branch, branching off from sourceBranch. */
readonly sourceBranch?: string;
/** @description The commit ID of the file before it was edited, used to identify if content has changed. Or null if this is a new file */
readonly sourceCommitId?: string;
};
readonly ExamplePostMultipartFormData: {
/** @description The hook script contents. */
readonly content?: string;
/** @description A description of the hook script (useful when querying registered hook scripts). */
readonly description?: string;
/** @description The name of the hook script (useful when querying registered hook scripts). */
readonly name?: string;
/** @description The type of hook script; supported values are "PRE" for pre-receive hooks and "POST" for post-receive hooks. */
readonly type?: string;
};
readonly ExamplePreviewMigration: {
readonly repositories?: readonly components["schemas"]["RestRepository"][];
};
readonly ExamplePutMultipartFormData: {
/** @description The hook script contents. */
readonly content?: string;
/** @description A description of the hook script (useful when querying registered hook scripts). */
readonly description?: string;
/** @description The name of the hook script (useful when querying registered hook scripts). */
readonly name?: string;
};
readonly ExampleRequirements: {
/** @example 3 */
readonly count?: string;
/** @example true */
readonly enabled?: boolean;
};
readonly ExampleSettings: {
/** @example true */
readonly booleanValue?: boolean;
/**
* Format: double
* @example 1.1
*/
readonly doubleValue?: number;
/**
* Format: int32
* @example 1
*/
readonly integerValue?: number;
/**
* Format: int64
* @example -2147483648
*/
readonly longValue?: number;
/** @example This is an arbitrary string */
readonly stringValue?: string;
};
readonly ExampleSettingsMap: {
/** @example true */
readonly "boolean key"?: boolean;
/** @example 10 */
readonly "long key"?: number;
/** @example string value */
readonly "string key"?: string;
};
readonly ExampleSocketAddress: {
/** @example node.example.com */
readonly address?: string;
/**
* Format: int32
* @example 8230
*/
readonly port?: number;
};
readonly ExampleStatus: {
/**
* Format: int32
* @example 2
*/
readonly currentNumberOfUsers?: number;
/** @example Hello World!
*/
readonly html?: string;
};
readonly RestMeshConnectivityReport: {
readonly reports?: readonly components["schemas"]["RestNodeConnectivityReport"][];
};
readonly RestMeshMigrationQueueStateCounts: unknown;
readonly RestMeshMigrationRequest: {
readonly all?: boolean;
readonly maxBytesPerSecond?: {
/** Format: int64 */
readonly asLong?: number;
readonly present?: boolean;
};
readonly projectIds?: readonly number[];
readonly repositoryIds?: readonly number[];
};
readonly RestMeshMigrationSummary: {
/**
* Format: int64
* @example 1331038800000
*/
readonly endTime?: number;
/** Format: int64 */
readonly jobId?: number;
/** Format: int64 */
readonly maxBandwidth?: number;
/**
* Format: int32
* @example 53
*/
readonly progress?: number;
readonly queue?: Record