12
12
class Policies extends AbstractApi
13
13
{
14
14
/**
15
- * List deployment branch policies
15
+ * List deployment branch policies.
16
16
*
17
17
* @link https://docs.github.com/en/rest/deployments/branch-policies?apiVersion=2022-11-28#list-deployment-branch-policies
18
18
*
19
- * @param string $username the username of the user who owns the repository
20
- * @param string $repository the name of the repository
19
+ * @param string $username the username of the user who owns the repository
20
+ * @param string $repository the name of the repository
21
21
* @param string $environment the name of the environment.
22
- * @param array $params query parameters to filter deployments by (see link)
22
+ * @param array $params query parameters to filter deployments by (see link)
23
23
*
24
24
* @return array the deployments requested
25
25
*/
@@ -29,14 +29,14 @@ public function all(string $username, string $repository, string $environment, a
29
29
}
30
30
31
31
/**
32
- * Get a deployment branch policy
32
+ * Get a deployment branch policy.
33
33
*
34
34
* @link https://docs.github.com/en/rest/deployments/branch-policies?apiVersion=2022-11-28#get-a-deployment-branch-policy
35
35
*
36
- * @param string $username the username of the user who owns the repository
37
- * @param string $repository the name of the repository
36
+ * @param string $username the username of the user who owns the repository
37
+ * @param string $repository the name of the repository
38
38
* @param string $environment the name of the environment.
39
- * @param int $id The unique identifier of the branch policy.
39
+ * @param int $id the unique identifier of the branch policy.
40
40
*
41
41
* @return array
42
42
*/
@@ -50,8 +50,8 @@ public function show(string $username, string $repository, string $environment,
50
50
*
51
51
* @link https://docs.github.com/en/rest/deployments/branch-policies?apiVersion=2022-11-28#create-a-deployment-branch-policy
52
52
*
53
- * @param string $username the username of the user who owns the repository
54
- * @param string $repository the name of the repository
53
+ * @param string $username the username of the user who owns the repository
54
+ * @param string $repository the name of the repository
55
55
* @param string $environment the name of the environment.
56
56
*
57
57
* @return array information about the deployment branch policy
@@ -66,10 +66,10 @@ public function create(string $username, string $repository, string $environment
66
66
*
67
67
* @link https://docs.github.com/en/rest/deployments/branch-policies?apiVersion=2022-11-28#update-a-deployment-branch-policy
68
68
*
69
- * @param string $username the username of the user who owns the repository
70
- * @param string $repository the name of the repository
69
+ * @param string $username the username of the user who owns the repository
70
+ * @param string $repository the name of the repository
71
71
* @param string $environment the name of the environment.
72
- * @param int $id The unique identifier of the branch policy.
72
+ * @param int $id the unique identifier of the branch policy.
73
73
*
74
74
* @return array information about the deployment branch policy
75
75
*/
@@ -79,14 +79,14 @@ public function update(string $username, string $repository, string $environment
79
79
}
80
80
81
81
/**
82
- * Delete a deployment branch policy
82
+ * Delete a deployment branch policy.
83
83
*
84
84
* @link https://docs.github.com/en/rest/deployments/branch-policies?apiVersion=2022-11-28#delete-a-deployment-branch-policy
85
85
*
86
- * @param string $username the username of the user who owns the repository
87
- * @param string $repository the name of the repository
86
+ * @param string $username the username of the user who owns the repository
87
+ * @param string $repository the name of the repository
88
88
* @param string $environment the name of the environment.
89
- * @param int $id The unique identifier of the branch policy.
89
+ * @param int $id the unique identifier of the branch policy.
90
90
*
91
91
* @return mixed null on success, array on error with 'message'
92
92
*/
0 commit comments