New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
x/pkgsite: API for pkg.go.dev #36785
Comments
@rhcarvalho - it would be helpful to get a sense of what your current use cases are for api.godoc.org, and feature requests are for an API for pkg.go.dev. It sounds like getting the importers for a package is one of them. With pkg.go.dev being module aware, what specific information about importers would be useful to surface via an API? For example:
Additionally, what other information would be useful to you to surface via an API? /cc @tbpg who has also mentioned wanting an API for pkg.go.dev |
Without much thought, having an API to answer the more specific question "what are the importers of a specific version of a package" would make plausible to derive the answer to the other items in your list. At the moment I consume the godoc.org API and scrape data from pkg.go.dev to answer the question "who uses my package". As far as I can tell the data in the "Imported By" go.dev tab is unrelated to the version of the package I'm currently browsing. Here are the other endpoints in the GoDoc API: https://github.com/golang/gddo/blob/7365cb292b8bfd13dfe514a18b207b9cc70e6ceb/gddo-server/main.go#L901-L904
So if we need a more specific request, here it is: api.go.dev MVP
|
Another endpoint idea (standalone or as part of a set of info returned for a module): available versions of a given module. |
What information beyond |
There are some cases where
None. That works. :) |
I'd be wary of encouraging tool authors to query pkg.go.dev/a proxy directly. Because it could well introduce skew compared to the answers from |
In my use-case I don't want to execute |
In #37952 I raised the question of whether module/package license file information could be surfaced in the output of @ianthehat instead suggested exposing the information via a pkg.go.dev API, leveraging the fact that the content and presentation on pkg.go.dev has already jumped through the relevant legal hoops. This comment is therefore to explicitly request that we include license file information in the API. Thank you! |
Currently to get the publish times for all versions, you have to make N+1 requests: one for
Anyone know if there are plans to fix this? |
No immediate plans. We currently gather that information from import statements in the code, so there is no version information attached. The So we understand it's an approximation and we want to fix it, but it's going to take some time. |
@julieqiu my use for an API would be to:
|
@julieqiu oh and please do not retire http://api.godoc.org/packages unless there is an alternative! |
As a downstream package maintainer for Fedora, I'm also interested in an API. We have our own tool, Anitya, to track package releases, but it was not designed to track GIT commits. And many Go packages still don't publish version. So any information about latest published commit, with info like date of the commit, new dependencies, would be very helpful. I would gather data from the API in Python and compare it to the latest version we have for a given package. I'm also interested in getting the License info, so we could find recursively all the licenses used in a static binary. |
But is |
@restuwahyu13 |
Stopping by to ask that any first version of an API provide some means to glean the source code / repo location of a package that uses a vanity path/url/name. |
I have similar use cases as others, so I resorted to scraping the UI as well ( |
The Has this endpoint been migrated? |
This commit fixes our Go import badges on sourcegraph.com, which have been broken since api.godoc.org was brought down. There's a [tracking issue](golang/go#36785) to re-introduce an API for pkg.go.dev, but it's not implemented yet. Instead, we implement a best-effort alternative that relies on searching `go.mod` files for the given repo name on sourcegraph.com. Sometimes packages will have different canonical names than their repositories, and we don't handle that case. There are [many open-source projects that have a broken badge](https://sourcegraph.com/search?q=context:global+sourcegraph.com+-/badge.svg&patternType=regexp). After this lands, they will recover.
This commit fixes our Go import badges on sourcegraph.com, which have been broken since api.godoc.org was brought down. There's a [tracking issue](golang/go#36785) to re-introduce an API for pkg.go.dev, but it's not implemented yet. Instead, we implement a best-effort alternative that relies on searching `go.mod` files for the given repo name on sourcegraph.com. Sometimes packages will have different canonical names than their repositories, and we don't handle that case. There are [many open-source projects that have a broken badge](https://sourcegraph.com/search?q=context:global+sourcegraph.com+-/badge.svg&patternType=regexp). After this lands, they will recover. Co-authored-by: Erik Seliger <erikseliger@me.com> Co-authored-by: Keegan Carruthers-Smith <keegan@sourcegraph.com>
Seems like most api.godoc.org endpoints are erroring, currently? e.g. https://api.godoc.org/packages, https://api.godoc.org/imports/github.com/goburrow/cache, etc. I'm particularly interested in the |
This is starting to be really problematic. @jba could someone kindly look into this? This is really looking bad |
@julieqiu do you know what happened? |
Will get on this today. |
@jba you rock... that's very kind of you! |
Note that only alternative today would be to resort to extensive pseudo-random screen scraping of https://pkg.go.dev/search laced in with some extensive recursive hitting of https://index.golang.org/index to get a complete package picture. It can work if this is what is recommended, but it would feel a bit like it is 1999 all over again. ;) |
This commit fixes our Go import badges on sourcegraph.com, which have been broken since api.godoc.org was brought down. There's a [tracking issue](golang/go#36785) to re-introduce an API for pkg.go.dev, but it's not implemented yet. Instead, we implement a best-effort alternative that relies on searching `go.mod` files for the given repo name on sourcegraph.com. Sometimes packages will have different canonical names than their repositories, and we don't handle that case. There are [many open-source projects that have a broken badge](https://sourcegraph.com/search?q=context:global+sourcegraph.com+-/badge.svg&patternType=regexp). After this lands, they will recover. Co-authored-by: Erik Seliger <erikseliger@me.com> Co-authored-by: Keegan Carruthers-Smith <keegan@sourcegraph.com>
api.godoc.org should be back up. |
This comment has been hidden.
This comment has been hidden.
This comment has been hidden.
This comment has been hidden.
This commit fixes our Go import badges on sourcegraph.com, which have been broken since api.godoc.org was brought down. There's a [tracking issue](golang/go#36785) to re-introduce an API for pkg.go.dev, but it's not implemented yet. Instead, we implement a best-effort alternative that relies on searching `go.mod` files for the given repo name on sourcegraph.com. Sometimes packages will have different canonical names than their repositories, and we don't handle that case. There are [many open-source projects that have a broken badge](https://sourcegraph.com/search?q=context:global+sourcegraph.com+-/badge.svg&patternType=regexp). After this lands, they will recover. Co-authored-by: Erik Seliger <erikseliger@me.com> Co-authored-by: Keegan Carruthers-Smith <keegan@sourcegraph.com>
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
please keep this issue on topic and refer questions to |
Rather than hiding what I'd consider a lot of really useful comments by folks (because I landed here for many of the same reasons they did, and there is extremely little available with regard to go package APIs) it would be infinitely more useful to explain to folks how to use the wiki for questions - or specify that tangential and related questions here are not welcome, and folks should seek the answers on the wiki. As it is now, that curt reply seems to imply that we should post questions on the wiki itself, which I doubt is what you're actually after. The go team has been kicking this can for years, so users are naturally going to have a lot of questions. This reply #36785 (comment) specifically asks users what features they're after in an API - thus the issue is fair game for feature-related questions. Go packages are the very last major ecosystem package registry to lack a comprehensive API and that which doesn't make its data readily available. Because of this, people are naturally going to have a myriad of questions about trying to access that data. I'd humbly ask @seankhliao to be a bit more gracious in your moderation of this issue. |
|
Prior to pkg.go.dev, godoc.org has had a JSON API that can be used to, among other things, discover importers of a given package.
Example: https://api.godoc.org/importers/golang.org/x/net/html
Given that pkg.go.dev does a much better job at tracking importers thanks to Go Modules and the Module Proxy, it would be nice if the community could get access to a public API similar to that of godoc.org.
The text was updated successfully, but these errors were encountered: