Method ListCodespaces

internal/codespaces/api/api.go:369–472

ListCodespaces returns a list of codespaces for the user. Pass a negative limit to request all pages from the API until all codespaces have been fetched.

(ctx context.Context, opts ListCodespacesOptions)

// ListCodespaces returns a list of codespaces for the user. Pass a negative limit to request all pages from
// the API until all codespaces have been fetched.
func (a *API) ListCodespaces(ctx context.Context, opts ListCodespacesOptions) (codespaces []*Codespace, err error) {
	var (
		perPage = 100
		limit   = opts.Limit
	)

	if limit > 0 && limit < 100 {
		perPage = limit
	}

	var (
		listURL  safeurl.SafeURL
		spanName string
	)

	if opts.RepoName != "" {
		owner, name, err := safeurl.RepoPartsFromNWO(opts.RepoName)
		if err != nil {
			return nil, err
		}
		u, err := safeurl.JoinPathWithHostPrefix(a.githubAPI, "repos", owner, name, "codespaces")
		if err != nil {
			return nil, err
		}
		u.SetQuery("per_page", strconv.Itoa(perPage))
		listURL = u
		spanName = "/repos/*/codespaces"
	} else if opts.OrgName != "" {
		// the endpoints below can only be called by the organization admins
		orgName := opts.OrgName
		if opts.UserName != "" {
			userName := opts.UserName
			u, err := safeurl.JoinPathWithHostPrefix(a.githubAPI, "orgs", orgName, "members", userName, "codespaces")
			if err != nil {
				return nil, err
			}
			u.SetQuery("per_page", strconv.Itoa(perPage))
			listURL = u
			spanName = "/orgs/*/members/*/codespaces"
		} else {
			u, err := safeurl.JoinPathWithHostPrefix(a.githubAPI, "orgs", orgName, "codespaces")
			if err != nil {
				return nil, err
			}
			u.SetQuery("per_page", strconv.Itoa(perPage))
			listURL = u
			spanName = "/orgs/*/codespaces"
		}
	} else {
		u, err := safeurl.JoinPathWithHostPrefix(a.githubAPI, "user", "codespaces")
		if err != nil {
			return nil, err
		}
		u.SetQuery("per_page", strconv.Itoa(perPage))
		listURL = u
		spanName = "/user/codespaces"
	}