Method RequestWithContext

api/client.go:221–242

RequestWithContext performs a REST request and returns the response for the caller to consume, rather than decoding it into a receiver as REST does. It exists for call sites that need access to the response itself: streaming bodies, non-JSON bodies, response headers, or the status code of a successf

(ctx context.Context, hostname string, method string, p string, body io.Reader, opts ...RequestOption)

// Responses outside the 2xx range are returned as an HTTPError and their body is closed. On success
// the response is returned unread and the caller is responsible for closing its body.
func (c Client) RequestWithContext(ctx context.Context, hostname string, method string, p string, body io.Reader, opts ...RequestOption) (*http.Response, error) {
	cfg := newRequestConfig(opts)
	clientOpts := clientOptions(hostname, c.http.Transport)
	maps.Copy(clientOpts.Headers, cfg.headers)
	if cfg.noFollowRedirects {
		clientOpts.CheckRedirect = func(req *http.Request, via []*http.Request) error {
			return http.ErrUseLastResponse
		}
	}

	restClient, err := ghAPI.NewRESTClient(clientOpts)
	if err != nil {
		return nil, err
	}

	resp, err := restClient.RequestWithContext(ctx, method, p, body)
	if err != nil {
		return nil, handleRequestError(err, cfg.endpointScopes)
	}

	return resp, nil
}

// DoRequest sends a request that the caller has already built, and returns the response for the
// caller to consume. It applies the same error handling as Request.