search

mirage / ocaml-github

GitHub APIv3 OCaml bindings
ISC License
100 stars 61 forks source link

Add support for the Issue Timeline API #186

Closed yallop closed 7 years ago

yallop commented 7 years ago

This PR adds support for the experimental Issue Timeline API, which exposes a variety of events not available in standard issue event streams, including repository cross-references.

Experiments reveal that many of the fields, including id, are not returned in every case, and so the new types mark most of the fields as optional (17c9e5f).

The timeline API uses a distinct media-type (application/vnd.github.mockingbird-preview), and so the get function now accepts an additional optional argument (42fd1dc).

yallop commented 7 years ago

Thanks for the reviews! I've addressed the comments in f38dfa5.

I haven't exposed media_type for methods other than GET for the moment, since there's no immediate need, and it can be added later without breaking things. Other than that I've made all the suggested changes.

yallop commented 7 years ago

The Fedora build failure appears to be due to an unrelated problem with dose3.

avsm commented 7 years ago

Fedora pod2html error should hopefully be addressed by https://github.com/ocaml/opam-repository/pull/8687

yallop commented 7 years ago

Thanks, @avsm; that does seem to have fixed it.