{"action":"created","issue":{"url":"https://api.github.com/repos/speedruncom/api/issues/31","repository_url":"https://api.github.com/repos/speedruncom/api","labels_url":"https://api.github.com/repos/speedruncom/api/issues/31/labels{/name}","comments_url":"https://api.github.com/repos/speedruncom/api/issues/31/comments","events_url":"https://api.github.com/repos/speedruncom/api/issues/31/events","html_url":"https://github.com/speedruncom/api/issues/31","id":157408132,"number":31,"title":"[UX] Creation of a documentation for this splendid API","user":{"login":"DarckCrystale","id":13867472,"avatar_url":"https://avatars.githubusercontent.com/u/13867472?v=3","gravatar_id":"","url":"https://api.github.com/users/DarckCrystale","html_url":"https://github.com/DarckCrystale","followers_url":"https://api.github.com/users/DarckCrystale/followers","following_url":"https://api.github.com/users/DarckCrystale/following{/other_user}","gists_url":"https://api.github.com/users/DarckCrystale/gists{/gist_id}","starred_url":"https://api.github.com/users/DarckCrystale/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/DarckCrystale/subscriptions","organizations_url":"https://api.github.com/users/DarckCrystale/orgs","repos_url":"https://api.github.com/users/DarckCrystale/repos","events_url":"https://api.github.com/users/DarckCrystale/events{/privacy}","received_events_url":"https://api.github.com/users/DarckCrystale/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":1,"created_at":"2016-05-29T21:50:06Z","updated_at":"2016-05-31T12:27:00Z","closed_at":null,"body":"# Description:\r\nIt would be nice to have some documentation explaining with details how to use the API.\r\n\r\n# Example:\r\nTo see the list of all runs:\r\nhttp://www.speedrun.com/api/v1/runs/\r\n**Will return:**\r\n```json\r\n{\r\n    \"data\": [{\r\n            \"id\": \"1wzpqgyq\",\r\n            \"weblink\": \"http://www.speedrun.com/run/1wzpqgyq\",\r\n            \"game\": \"nj1ne1p4\",\r\n            \"level\": null,\r\n            \"category\": \"prklq2n9\",\r\n            \"videos\": {\r\n                \"links\": [{\r\n                        \"uri\": \"https://www.youtube.com/watch?v=KKjPMD0aHaY\"\r\n                    }]\r\n            },\r\n            \"comment\": \"bad RNG on frigate otherwise pretty solid\",\r\n            \"status\": {\r\n                \"status\": \"verified\",\r\n                \"examiner\": null,\r\n                \"verify-date\": null\r\n            },\r\n            \"players\": [{\r\n                    \"rel\": \"user\",\r\n                    \"id\": \"v48grxpr\",\r\n                    \"uri\": \"http://www.speedrun.com/api/v1/users/v48grxpr\"\r\n                }],\r\n            \"date\": \"2013-06-10\",\r\n            \"submitted\": null,\r\n            \"times\": {\r\n                \"primary\": \"PT21M52S\",\r\n                \"primary_t\": 1312,\r\n                \"realtime\": \"PT21M52S\",\r\n                \"realtime_t\": 1312,\r\n                \"realtime_noloads\": null,\r\n                \"realtime_noloads_t\": 0,\r\n                \"ingame\": null,\r\n                \"ingame_t\": 0\r\n            },\r\n            \"system\": {\r\n                \"platform\": \"ow31ev96\",\r\n                \"emulated\": false,\r\n                \"region\": \"pr184lqn\"\r\n            },\r\n            \"splits\": null,\r\n            \"values\": {},\r\n            \"links\": [{\r\n                    \"rel\": \"self\",\r\n                    \"uri\": \"http://www.speedrun.com/api/v1/runs/1wzpqgyq\"\r\n                }, {\r\n                    \"rel\": \"game\",\r\n                    \"uri\": \"http://www.speedrun.com/api/v1/games/nj1ne1p4\"\r\n                }, {\r\n                    \"rel\": \"category\",\r\n                    \"uri\": \"http://www.speedrun.com/api/v1/categories/prklq2n9\"\r\n                }, {\r\n                    \"rel\": \"platform\",\r\n                    \"uri\": \"http://www.speedrun.com/api/v1/platforms/ow31ev96\"\r\n                }, {\r\n                    \"rel\": \"region\",\r\n                    \"uri\": \"http://www.speedrun.com/api/v1/regions/pr184lqn\"\r\n                }]\r\n        }, {\r\n            ...\r\n        }],\r\n    \"pagination\": {\r\n        \"offset\": 0,\r\n        \"max\": 20,\r\n        \"size\": 20,\r\n        \"links\": [{\r\n                \"rel\": \"next\",\r\n                \"uri\": \"http://www.speedrun.com/api/v1/runs?offset=20\"\r\n            }]\r\n    }\r\n}\r\n```\r\n\r\nFor each function and valid url.\r\nIt could be placed in a doc.md, like the readme and the information about connection.\r\n\r\nThx!"},"comment":{"url":"https://api.github.com/repos/speedruncom/api/issues/comments/222673389","html_url":"https://github.com/speedruncom/api/issues/31#issuecomment-222673389","issue_url":"https://api.github.com/repos/speedruncom/api/issues/31","id":222673389,"user":{"login":"DarckCrystale","id":13867472,"avatar_url":"https://avatars.githubusercontent.com/u/13867472?v=3","gravatar_id":"","url":"https://api.github.com/users/DarckCrystale","html_url":"https://github.com/DarckCrystale","followers_url":"https://api.github.com/users/DarckCrystale/followers","following_url":"https://api.github.com/users/DarckCrystale/following{/other_user}","gists_url":"https://api.github.com/users/DarckCrystale/gists{/gist_id}","starred_url":"https://api.github.com/users/DarckCrystale/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/DarckCrystale/subscriptions","organizations_url":"https://api.github.com/users/DarckCrystale/orgs","repos_url":"https://api.github.com/users/DarckCrystale/repos","events_url":"https://api.github.com/users/DarckCrystale/events{/privacy}","received_events_url":"https://api.github.com/users/DarckCrystale/received_events","type":"User","site_admin":false},"created_at":"2016-05-31T12:27:00Z","updated_at":"2016-05-31T12:27:00Z","body":"I'm sorry, I did not see it! Thanks :3\r\nMaybe you could add in the Readme.md at https://github.com/speedruncom/api#versions a note to specify that the link point also to the documentation?"}}
{"actor":{"display_login":"DarckCrystale"}}