gomods/athens

[Proposal] Improve the catalog endpoint format

開放

#1,186 建立於 2019年4月13日

 (22 則留言) (0 個反應) (0 位負責人)Go (538 個分叉)github user discovery
enhancementgood first issue

倉庫指標

星標
 (4,766 顆星)
PR 合併指標
 (平均合併 18天 13小時) (30 天內合併 13 個 PR)

描述

Is your feature request related to a problem? Please describe.

Right now, utilities that want to use the /catalog endpoint often need to aggregate each module's versions into a list. For example, the /catalog endpoint returns this:

{
    "modules": [
        {
            "module":"github.com/arschles/assert",
            "version": "v1.0.0"
        },
        {
            "module": "github.com/arschles/assert",
            "version": "v1.1.0"
        }
    ]
}

Many programs will find it more convenient to get a response similar to this:

{
    "modules": {
        "github.com/arschles/assert": ["v1.0.0", "v1.1.0"]
    }
}

Describe the solution you'd like

I'd like us to add a V2 of the catalog API that responds this way. This could possibly be exposed as a /catalog/v2 endpoint.

Describe alternatives you've considered

Clients can always aggregate in their own code

Additional context

  • There will be non-trivial work on the storage systems to achieve this
  • There are two projects I know of that could benefit from this change:

cc/ @marwan-at-work

貢獻者指南