API docs missing githubRepository entry

[hasundue]

Recently I have implemented a basic support for JSR in my dependency updater.
I'm thinking of adding a feature to show "what's changed" commit logs next, but find it tricky because the package details endpoint of the JSR API does not contain information on the original repository of source code, while the front-end has a link to a repository if available.

I respect that JSR doesn't even require a package to be hosted online or managed with git, but it might be cool to have such a field in the endpoint in some use cases.

[lucacasonato]

The package endpoint does have both repository and name: https://api.jsr.io/scopes/std/packages/fs

{
  "scope": "std",
  "name": "fs",
  "description": "Helpers for working with the file system",
  "githubRepository": {
    "id": 156498505,
+   "owner": "denoland",
+   "name": "deno_std",
    "updatedAt": "2023-12-22T11:10:57.995437Z",
    "createdAt": "2023-12-22T11:10:57.995437Z"
  },
  "runtimeCompat": {
    "browser": false,
    "deno": true,
    "node": false,
    "workerd": false
  },
  "updatedAt": "2024-02-26T07:58:50.302101Z",
  "createdAt": "2023-12-22T03:19:20.157401Z",
  "versionCount": 12,
  "score": 88,
  "latestVersion": "0.219.1",
  "whenFeatured": null
}

You can find the docs for the API here: https://jsr.io/docs/api#management-api

[hasundue]

Oh yeah it does. I just read https://jsr.redoc.ly/#operation/getPackage but didn't look at an actual response. Thanks.

[lucacasonato]

Oops - looks like a bug in the API docs 😓

[hasundue]

Glad to know that this issue was totally not in vain😁

[lucacasonato]

If anyone wants to fix this, the API defintion is in https://github.com/jsr-io/jsr/blob/main/api/src/api.yml. You can add the relevant changes to the OpenAPI document there. When you open a PR, there will be a link from "Redocly" in the status section that you can use to preview the output.

[Jayanth-Parthsarathy]

I would love to work on this. Please assign this to me @lucacasonato