Skip to content

Commit 02caff7

Browse files
committed
Tweaks for consistency…
1 parent bb83f1c commit 02caff7

File tree

3 files changed

+14
-14
lines changed

3 files changed

+14
-14
lines changed

Diff for: cluster_agents.go

+8-8
Original file line numberDiff line numberDiff line change
@@ -75,17 +75,17 @@ func (a AgentToken) String() string {
7575
return Stringify(a)
7676
}
7777

78-
// ListProjectAgentsOptions represents the available ListProjectAgents() options.
78+
// ListAgentsOptions represents the available ListAgents() options.
7979
//
8080
// GitLab API docs:
8181
// https://docs.gitlab.com/ee/api/cluster_agents.html#list-the-agents-for-a-project
82-
type ListProjectAgentsOptions ListOptions
82+
type ListAgentsOptions ListOptions
8383

84-
// ListProjectAgents returns a list of agents registered for the project.
84+
// ListAgents returns a list of agents registered for the project.
8585
//
8686
// GitLab API docs:
8787
// https://docs.gitlab.com/ee/api/cluster_agents.html#list-the-agents-for-a-project
88-
func (s *ClusterAgentsService) ListProjectAgents(pid interface{}, opt *ListProjectAgentsOptions, options ...RequestOptionFunc) ([]*Agent, *Response, error) {
88+
func (s *ClusterAgentsService) ListAgents(pid interface{}, opt *ListAgentsOptions, options ...RequestOptionFunc) ([]*Agent, *Response, error) {
8989
project, err := parseID(pid)
9090
if err != nil {
9191
return nil, nil, err
@@ -131,20 +131,20 @@ func (s *ClusterAgentsService) GetAgent(pid interface{}, id int, options ...Requ
131131
return a, resp, err
132132
}
133133

134-
// RegisterProjectAgentOptions represents the available RegisterProjectAgent()
134+
// RegisterAgentOptions represents the available RegisterAgent()
135135
// options.
136136
//
137137
// GitLab API docs:
138138
// https://docs.gitlab.com/ee/api/cluster_agents.html#register-an-agent-with-a-project
139-
type RegisterProjectAgentOptions struct {
139+
type RegisterAgentOptions struct {
140140
Name *string `url:"name,omitempty" json:"name,omitempty"`
141141
}
142142

143-
// RegisterProjectAgent registers an agent to the project.
143+
// RegisterAgent registers an agent to the project.
144144
//
145145
// GitLab API docs:
146146
// https://docs.gitlab.com/ee/api/cluster_agents.html#register-an-agent-with-a-project
147-
func (s *ClusterAgentsService) RegisterProjectAgent(pid interface{}, opt *RegisterProjectAgentOptions, options ...RequestOptionFunc) (*Agent, *Response, error) {
147+
func (s *ClusterAgentsService) RegisterAgent(pid interface{}, opt *RegisterAgentOptions, options ...RequestOptionFunc) (*Agent, *Response, error) {
148148
project, err := parseID(pid)
149149
if err != nil {
150150
return nil, nil, err

Diff for: cluster_agents_test.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,8 @@ func ListClusterAgents(t *testing.T) {
6666
`)
6767
})
6868

69-
opt := &ListProjectAgentsOptions{}
70-
clusterAgents, _, err := client.ClusterAgents.ListProjectAgents(20, opt)
69+
opt := &ListAgentsOptions{}
70+
clusterAgents, _, err := client.ClusterAgents.ListAgents(20, opt)
7171
if err != nil {
7272
t.Errorf("ClusterAgents.ListClusterAgents returned error: %v", err)
7373
}
@@ -185,8 +185,8 @@ func RegisterClusterAgent(t *testing.T) {
185185
`)
186186
})
187187

188-
opt := &RegisterProjectAgentOptions{Name: String("agent-1")}
189-
clusterAgent, _, err := client.ClusterAgents.RegisterProjectAgent(20, opt)
188+
opt := &RegisterAgentOptions{Name: String("agent-1")}
189+
clusterAgent, _, err := client.ClusterAgents.RegisterAgent(20, opt)
190190
if err != nil {
191191
t.Errorf("ClusterAgents.RegisterClusterAgent returned error: %v", err)
192192
}

Diff for: examples/cluster_agents.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ func clusterAgentsExample() {
3232
projectID := 33
3333

3434
// Register Cluster Agent
35-
clusterAgent, _, err := git.ClusterAgents.RegisterProjectAgent(projectID, &gitlab.RegisterProjectAgentOptions{
35+
clusterAgent, _, err := git.ClusterAgents.RegisterAgent(projectID, &gitlab.RegisterAgentOptions{
3636
Name: gitlab.String("agent-2"),
3737
})
3838
if err != nil {
@@ -42,7 +42,7 @@ func clusterAgentsExample() {
4242
fmt.Printf("Cluster Agent: %+v\n", clusterAgent)
4343

4444
// List Cluster Agents
45-
clusterAgents, _, err := git.ClusterAgents.ListProjectAgents(projectID, nil)
45+
clusterAgents, _, err := git.ClusterAgents.ListAgents(projectID, nil)
4646
if err != nil {
4747
panic(err)
4848
}

0 commit comments

Comments
 (0)