JSON

The JSON structures on this page can be used when configuring ElasticSearch and also as a template for the API design. They will be simple to start with, but will change as we're able to add more information. The actual key names probably merit some discussion as well, but my vote would be to get something up and running and then talk naming once we see what we have to work with.

Module:

Our example module here is Moose::Role.

{
  "archive": "D/DR/DROLSKY/Moose-1.17.tar.gz",
  "distvname": "Moose-1.17",
  "version": "1.17",
  "name": "Moose::Role",
  "dist": "Moose",
  "pauseid": "DROLSKY"
}

Once we have our CPAN mirror web-accessible, we can also provide a download link to the source directly in the JSON. However, some discussion should maybe take place about how much module-specific data actually belongs in an object describing the distribution.

Author:

Our example is the author of Moose::Role.

{
  "email": "[email protected]",
  "name": "Dave Rolsky ",
  "pauseid": "DROLSKY",
  "gravatar_url": "http://www.gravatar.com/avatar/ac0051ccbf2115f581f5da62fb56c219"
}

CPAN Rating:

http://cpanratings.perl.org

CPAN ratings are based on distribution, rather than module. Our example is Moose:

{
  "dist": "Moose",
  "rating": "4.9",
  "review_count": 12
}