Skip to content

Commit 670f972

Browse files
committed
fix: rename 'inspect' endpoints to 'get'
Renames the following endpoints to make our API more consistent: - `inspect-cluster` -> `get-cluster` - `inspect-host` -> `get-host` - `inspect-database-task` -> `get-database-task` PLAT-86
1 parent 9b48b29 commit 670f972

File tree

22 files changed

+737
-741
lines changed

22 files changed

+737
-741
lines changed

api/design/api.go

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ var _ = g.Service("control-plane", func() {
8282
})
8383
})
8484

85-
g.Method("inspect-cluster", func() {
85+
g.Method("get-cluster", func() {
8686
g.Description("Returns information about the cluster.")
8787
g.Result(Cluster)
8888
g.Error("cluster_not_initialized")
@@ -103,11 +103,11 @@ var _ = g.Service("control-plane", func() {
103103
})
104104
})
105105

106-
g.Method("inspect-host", func() {
106+
g.Method("get-host", func() {
107107
g.Description("Returns information about a particular host in the cluster.")
108108
g.Payload(func() {
109109
g.Attribute("host_id", g.String, func() {
110-
g.Description("ID of the host to inspect.")
110+
g.Description("ID of the host to get.")
111111
g.Example("de3b1388-1f0c-42f1-a86c-59ab72f255ec")
112112
})
113113
})
@@ -293,17 +293,17 @@ var _ = g.Service("control-plane", func() {
293293
})
294294
})
295295

296-
g.Method("inspect-database-task", func() {
297-
g.Description("Returns information about a particular task for a database.")
296+
g.Method("get-database-task", func() {
297+
g.Description("Returns information about a particular task.")
298298
g.Payload(func() {
299299
g.Attribute("database_id", g.String, func() {
300300
g.Format(g.FormatUUID)
301-
g.Description("ID of the database to inspect tasks for.")
301+
g.Description("ID of the database the task belongs to.")
302302
g.Example("02f1a7db-fca8-4521-b57a-2a375c1ced51")
303303
})
304304
g.Attribute("task_id", g.String, func() {
305305
g.Format(g.FormatUUID)
306-
g.Description("ID of the task to inspect.")
306+
g.Description("ID of the task to get.")
307307
g.Example("3c875a27-f6a6-4c1c-ba5f-6972fb1fc348")
308308
})
309309

api/gen/control_plane/client.go

Lines changed: 51 additions & 52 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

api/gen/control_plane/endpoints.go

Lines changed: 55 additions & 55 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)