Giter Club home page Giter Club logo

specifications's Introduction

specifications's People

Contributors

duksis avatar ericmj avatar ferd avatar idyll avatar lostkobrakai avatar lpil avatar mobileoverlord avatar voltone avatar wojtekmach avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

specifications's Issues

CDN endpiont?

The readme says, "To host a repository only the CDN endpoint has to be implemented." I don't see anything called the CDN endpoint in the documentation.

Document Repo /docs/:package-:version.tar.gz endpoint

This would be an optional endpoint that a repository might implement. It would be used by e.g. mix hex.docs fetch foo 1.0.0 --repo acme to download the docs tarball. (Note, we don't yet have --repo on mix hex.docs.)

Another option would be for mix hex.docs fetch --repo to instead use the HTTP API /packages/:name/releases/:version/docs endpoint for custom repos but that doesn't seem ideal either.

Undocumented properties

Hi. I spotted that there are some properties in the Hex API responses that aren't in the documentation:

  • latest_stable_version (string)
  • latest_version (string)
  • configs (object)
  • retirements (object)

appear in the API responses but not in the corresponding docs

JSON package meta-data is not specified

The JSON data (application/vnd.hex+json) delivered by

is not documented.

While most of the fields delivered can be guessed, some are not obvious. Some examples:

  • (package url vs. html_url vs doc_html_url
  • (package) meta -> elixir
  • (release) meta -> app
  • (release) meta -> elixir (also: what does null mean here)
  • (release) inserted_at vs.updated_at
  • (release) url vs. html_url (seems to be the same in many cases)

Beside a description of the fields, it would be nice to have a specification one can rely on.

(FYI: I'm building a importer from hex.pm packages into guix, for which I need to query this data.)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.