Code Monkey home page Code Monkey logo

public-repo's Introduction

public-repo

public-repo's People

Contributors

baxterthehacker avatar

Stargazers

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

Watchers

 avatar  avatar  avatar

public-repo's Issues

Documentation doesn't match repo?

  1. According to docs, there is a release. The repo does not have one. Going to the html_url gets me an error.

  2. Several fields mentioned in the documentation are missing or incorrectly names:

    1. issue event
      1. shows a payload.label item, but there is no such item in the example.
      2. payload.assignee is actually payload.issue.assignee in the example.
    2. Push is missing the size,
  3. It would be nice if there was a simpler object available. For example, sender, author, repository, etc are always the same type of object; you can remove these entirely and just replace ReleaseEvent's example with the following:

    {
    "action": "published",
    "release": {
      "url": "https://api.github.com/repos/baxterthehacker/public-repo/releases/1261438",
      "assets_url": "https://api.github.com/repos/baxterthehacker/public-repo/releases/1261438/assets",
      "upload_url": "https://uploads.github.com/repos/baxterthehacker/public-repo/releases/1261438/assets{?name}",
      "html_url": "https://github.com/baxterthehacker/public-repo/releases/tag/0.0.1",
      "id": 1261438,
      "tag_name": "0.0.1",
      "target_commitish": "master",
      "name": null,
      "draft": false,
      "author": Object, //replaced with a generic
      "prerelease": false,
      "created_at": "2015-05-05T23:40:12Z",
      "published_at": "2015-05-05T23:40:38Z",
      "assets": [
    
      ],
      "tarball_url": "https://api.github.com/repos/baxterthehacker/public-repo/tarball/0.0.1",
      "zipball_url": "https://api.github.com/repos/baxterthehacker/public-repo/zipball/0.0.1",
      "body": null
    },
    "repository": Object, //replaced with generic
    "sender": Object //replaced with generic
    }

    I realize that the documentation is just markdown, but it would be even better if there was a json code format that allowed collapsing and expanding objects. Something like this open source JsonFormatter or like CodeMirror

  4. I would expect to see unavailable endpoints either not listed or in their own section at the bottom of the page, rather than in between endpoints that are still in use.

  5. It would be nice if there was an endpoint tester that we could use to see exactly what the response would be for specific actions. I don't currently know whether the example code or the documentation is correct when they conflict, and I don't yet have anything to test with.

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.