aboutsummaryrefslogtreecommitdiff
path: root/internal/api/api.go
diff options
context:
space:
mode:
authorEthan Lee <ethanalee@google.com>2026-03-11 21:20:21 +0000
committerGopher Robot <gobot@golang.org>2026-03-30 13:26:49 -0700
commit8514eebca6ca7b3213e879faa2a83c7e9ea6e181 (patch)
tree85db643baa162d5a828895d3655b8e1fd3f5c9af /internal/api/api.go
parent46b63f3ffddc9657bc2c45fb116dc49c0b381a34 (diff)
downloadgo-x-pkgsite-8514eebca6ca7b3213e879faa2a83c7e9ea6e181.tar.xz
internal/api: implement package imported-by endpoint
- Implement ServePackageImportedBy handler and GetImportedBy and GetImportedByCount datasource methods. Change-Id: I8c4cc65fbff7172eaf48e5426e4f3f41c82bd38e Reviewed-on: https://go-review.googlesource.com/c/pkgsite/+/754865 Reviewed-by: Jonathan Amsterdam <jba@google.com> kokoro-CI: kokoro <noreply+kokoro@google.com> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> Auto-Submit: Ethan Lee <ethanalee@google.com>
Diffstat (limited to 'internal/api/api.go')
-rw-r--r--internal/api/api.go61
1 files changed, 61 insertions, 0 deletions
diff --git a/internal/api/api.go b/internal/api/api.go
index b2be2327..8cfe2151 100644
--- a/internal/api/api.go
+++ b/internal/api/api.go
@@ -399,6 +399,67 @@ func ServePackageSymbols(w http.ResponseWriter, r *http.Request, ds internal.Dat
return serveJSON(w, http.StatusOK, resp)
}
+// ServePackageImportedBy handles requests for the v1 package imported-by endpoint.
+func ServePackageImportedBy(w http.ResponseWriter, r *http.Request, ds internal.DataSource) (err error) {
+ defer derrors.Wrap(&err, "ServePackageImportedBy")
+
+ pkgPath := strings.TrimPrefix(r.URL.Path, "/v1/imported-by/")
+ if pkgPath == "" {
+ return serveErrorJSON(w, http.StatusBadRequest, "missing package path", nil)
+ }
+
+ var params ImportedByParams
+ if err := ParseParams(r.URL.Query(), &params); err != nil {
+ return serveErrorJSON(w, http.StatusBadRequest, err.Error(), nil)
+ }
+
+ requestedVersion := params.Version
+ if requestedVersion == "" {
+ requestedVersion = version.Latest
+ }
+
+ um, candidates, err := resolveModulePath(r, ds, pkgPath, params.Module, requestedVersion)
+ if err != nil {
+ if errors.Is(err, derrors.NotFound) {
+ return serveErrorJSON(w, http.StatusNotFound, err.Error(), nil)
+ }
+ return err
+ }
+ if len(candidates) > 0 {
+ return serveErrorJSON(w, http.StatusBadRequest, "ambiguous package path", candidates)
+ }
+ modulePath := um.ModulePath
+
+ limit := params.Limit
+ if limit <= 0 {
+ limit = 100
+ }
+
+ importedBy, err := ds.GetImportedBy(r.Context(), pkgPath, modulePath, limit)
+ if err != nil {
+ if errors.Is(err, derrors.NotFound) {
+ return serveErrorJSON(w, http.StatusNotFound, err.Error(), nil)
+ }
+ return err
+ }
+
+ count, err := ds.GetImportedByCount(r.Context(), pkgPath, modulePath)
+ if err != nil {
+ return err
+ }
+
+ resp := PackageImportedBy{
+ ModulePath: modulePath,
+ Version: requestedVersion,
+ ImportedBy: PaginatedResponse[string]{
+ Items: importedBy,
+ Total: count,
+ },
+ }
+
+ return serveJSON(w, http.StatusOK, resp)
+}
+
// resolveModulePath determines the correct module path for a given package path and version.
// If the module path is not provided, it searches through potential candidate module paths
// derived from the package path. If multiple valid modules contain the package, it returns