library/com.gabrielfeo.develocity.api/ProjectsApi

ProjectsApi

@JvmSuppressWildcards
interface ProjectsApi

Functions

Link copied to clipboard
@PUT(value = "api/projects/{projectId}")
abstract suspend fun createOrUpdateProject(@Path(value = "projectId") projectId: String, @Body project: Project): Project

PUT api/projects/{projectId} Create or update an access control project. <mark>Beta:</mark> Create or update a project configured for project-level access control in Develocity. When updating, any optional fields that are omitted from the request, but were previously set on the project, will be unset/removed. An existing project's identifier cannot be updated. If the update contains a id that does not match the current id, then the operation will fail with a Bad Request response. Responses:

Link copied to clipboard
@PUT(value = "api/project-groups/{projectGroupId}")
abstract suspend fun createOrUpdateProjectGroup(@Path(value = "projectGroupId") projectGroupId: String, @Body projectGroup: ProjectGroup): ProjectGroup

PUT api/project-groups/{projectGroupId} Create or update an access control project group. <mark>Beta:</mark> Create or update a project group configured for project-level access control in Develocity. When updating, any optional fields that are omitted from the request, but were previously set on the project group, will be unset/removed. An existing project group's identifier cannot be updated. If the update contains a id that does not match the current id, then the operation will fail with a Bad Request response. Responses:

Link copied to clipboard
@DELETE(value = "api/project-groups/{projectGroupId}")
abstract suspend fun deleteProjectGroup(@Path(value = "projectGroupId") projectGroupId: String)

DELETE api/project-groups/{projectGroupId} Delete an access control project group. <mark>Beta:</mark> Delete a project group configured for project-level access control in Develocity. Responses:

Link copied to clipboard
@GET(value = "api/projects/{projectId}")
abstract suspend fun getProject(@Path(value = "projectId") projectId: String): Project

GET api/projects/{projectId} Get an access control project. <mark>Beta:</mark> Gets a specific project configured for project-level access control. Responses:

Link copied to clipboard
@GET(value = "api/project-groups/{projectGroupId}")
abstract suspend fun getProjectGroup(@Path(value = "projectGroupId") projectGroupId: String): ProjectGroup

GET api/project-groups/{projectGroupId} Get an access control project group. <mark>Beta:</mark> Gets a specific project group configured for project-level access control. Responses:

Link copied to clipboard
@GET(value = "api/project-groups")
abstract suspend fun listProjectGroups(@Query(value = "pageNumber") pageNumber: Int? = 0, @Query(value = "pageSize") pageSize: Int? = null): ProjectGroupsPage

GET api/project-groups Lists access control project groups. <mark>Beta:</mark> Returns a list of all project groups configured for project-level access control. If there are a lot of project groups, then all pages will need to be retrieved in order to retrieve the full list of project groups. The default number of project groups per page is 100. Responses:

Link copied to clipboard
@GET(value = "api/projects")
abstract suspend fun listProjects(@Query(value = "pageNumber") pageNumber: Int? = 0, @Query(value = "pageSize") pageSize: Int? = null): ProjectsPage

GET api/projects Lists access control projects. <mark>Beta:</mark> Returns a paged list of projects configured for project-level access control. If there are a lot of projects, then all pages will need to be retrieved in order to retrieve the full list of projects. The default number of projects per page is 1,000. Responses: