1- // TODO(adonovan): rename to package codespaces, and codespaces.Client.
21package api
32
43// For descriptions of service interfaces, see:
@@ -7,6 +6,24 @@ package api
76// - https://github.com/github/github/blob/master/app/api/codespaces.rb (for vscs_internal)
87// TODO(adonovan): replace the last link with a public doc URL when available.
98
9+ // TODO(adonovan): a possible reorganization would be to split this
10+ // file into three internal packages, one per backend service, and to
11+ // rename api.API to github.Client:
12+ //
13+ // - github.GetUser(github.Client)
14+ // - github.GetRepository(Client)
15+ // - github.ReadFile(Client, nwo, branch, path) // was GetCodespaceRepositoryContents
16+ // - codespaces.Create(Client, user, repo, sku, branch, location)
17+ // - codespaces.Delete(Client, user, token, name)
18+ // - codespaces.Get(Client, token, owner, name)
19+ // - codespaces.GetMachineTypes(Client, user, repo, branch, location)
20+ // - codespaces.GetToken(Client, login, name)
21+ // - codespaces.List(Client, user)
22+ // - codespaces.Start(Client, token, codespace)
23+ // - visualstudio.GetRegionLocation(http.Client) // no dependency on github
24+ //
25+ // This would make the meaning of each operation clearer.
26+
1027import (
1128 "bytes"
1229 "context"
0 commit comments