Commit 524a9892 authored by Levente Polyak's avatar Levente Polyak
Browse files

api/projects: add endpoints to query protected_branches

parent 8f2d5bde
......@@ -13,6 +13,8 @@
projects.
* Added the `api::groups::subgroups::GroupSubgroups` endpoint to list a
groups subgroups.
* Added the `api::projects::protected_branches::ProtectedBranches` endpoint
to list a projects protected branches.
# v0.1301.0
......
......@@ -75,6 +75,7 @@ These API endpoints have been implemented.
* `GET /projects/:project/pipelines/:pipeline/variables` `projects/pipelines/variables.rs`
* `POST /projects/:project/protected_branches` `projects/protected_branches/protect.rs`
* `DELETE /projects/:project/protected_branches/*branch` `projects/protected_branches/unprotect.rs`
* `GET /projects/:project/protected_branches` `projects/protected_branches/protected_branches.rs`
* `GET /projects/:project/repository/branches` `projects/repository/branches/branches.rs`
* `POST /projects/:project/repository/branches` `projects/repository/branches/create.rs`
* `GET /projects/:project/repository/branches/:branch` `projects/repository/branches/branch.rs`
......@@ -253,8 +254,6 @@ instead of having to search the page for missing endpoints.
* `GET /projects/:project/milestones/:milestone/merge_requests` https://gitlab.kitware.com/help/api/milestones.md#get-all-merge-requests-assigned-to-a-single-milestone
* `POST /projects/:project/milestones/:milestone/promote` https://gitlab.kitware.com/help/api/milestones.md#promote-project-milestone-to-a-group-milestone
* `POST /projects/:project/mirror/pull` https://gitlab.kitware.com/help/api/projects.md#start-the-pull-mirroring-process-for-a-project-starter
* `GET /projects/:project/protected_branches` https://gitlab.kitware.com/help/api/protected_branches.md#list-protected-branches
* `GET /projects/:project/protected_branches/:branch` https://gitlab.kitware.com/help/api/protected_branches.md#get-a-single-protected-branch-or-wildcard-protected-branch
* `PATCH /projects/:project/protected_branches/:branch` https://gitlab.kitware.com/help/api/protected_branches.md#require-code-owner-approvals-for-a-single-branch
* `POST /projects/:project/pipeline` https://gitlab.kitware.com/help/api/pipelines.md#create-a-new-pipeline
* `GET /projects/:project/push_rule` https://gitlab.kitware.com/help/api/projects.md#get-project-push-rules
......
......@@ -9,6 +9,7 @@
//! These endpoints are used for querying a project's protected branches.
mod protect;
mod protected_branches;
mod unprotect;
pub use self::protect::ProtectBranch;
......@@ -18,3 +19,6 @@ pub use self::protect::ProtectedAccessLevel;
pub use self::unprotect::UnprotectBranch;
pub use self::unprotect::UnprotectBranchBuilder;
pub use self::protected_branches::ProtectedBranches;
pub use self::protected_branches::ProtectedBranchesBuilder;
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
use derive_builder::Builder;
use crate::api::common::NameOrId;
use crate::api::endpoint_prelude::*;
/// Query protected branches of a project.
#[derive(Debug, Clone, Builder)]
#[builder(setter(strip_option))]
pub struct ProtectedBranches<'a> {
/// The project to query for protected branches.
#[builder(setter(into))]
project: NameOrId<'a>,
/// Name or part of the name of protected branches to be searched for.
///
/// The search query will be escaped automatically.
#[builder(setter(into), default)]
search: Option<Cow<'a, str>>,
}
impl<'a> ProtectedBranches<'a> {
/// Create a builder for the endpoint.
pub fn builder() -> ProtectedBranchesBuilder<'a> {
ProtectedBranchesBuilder::default()
}
}
impl<'a> Endpoint for ProtectedBranches<'a> {
fn method(&self) -> Method {
Method::GET
}
fn endpoint(&self) -> Cow<'static, str> {
format!("projects/{}/protected_branches", self.project).into()
}
fn parameters(&self) -> QueryParams {
let mut params = QueryParams::default();
params.push_opt("search", self.search.as_ref());
params
}
}
#[cfg(test)]
mod tests {
use crate::api::projects::protected_branches::ProtectedBranches;
use crate::api::{self, Query};
use crate::test::client::{ExpectedUrl, SingleTestClient};
#[test]
fn project_is_needed() {
let err = ProtectedBranches::builder().build().unwrap_err();
assert_eq!(err, "`project` must be initialized");
}
#[test]
fn project_is_sufficient() {
ProtectedBranches::builder().project(1).build().unwrap();
}
#[test]
fn endpoint() {
let endpoint = ExpectedUrl::builder()
.endpoint("projects/group%2Fproject/protected_branches")
.build()
.unwrap();
let client = SingleTestClient::new_raw(endpoint, "");
let endpoint = ProtectedBranches::builder()
.project("group/project")
.build()
.unwrap();
api::ignore(endpoint).query(&client).unwrap();
}
#[test]
fn endpoint_search() {
let endpoint = ExpectedUrl::builder()
.endpoint("projects/group%2Fproject/protected_branches")
.add_query_params(&[("search", "name")])
.build()
.unwrap();
let client = SingleTestClient::new_raw(endpoint, "");
let endpoint = ProtectedBranches::builder()
.project("group/project")
.search("name")
.build()
.unwrap();
api::ignore(endpoint).query(&client).unwrap();
}
}
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment