{"action":"created","issue":{"url":"https://api.github.com/repos/e-government-ua/i/issues/617","labels_url":"https://api.github.com/repos/e-government-ua/i/issues/617/labels{/name}","comments_url":"https://api.github.com/repos/e-government-ua/i/issues/617/comments","events_url":"https://api.github.com/repos/e-government-ua/i/issues/617/events","html_url":"https://github.com/e-government-ua/i/issues/617","id":98400148,"number":617,"title":"Привести в порядок документацию по нашим АПИ на Вики","user":{"login":"bvv4ik","id":4208821,"avatar_url":"https://avatars.githubusercontent.com/u/4208821?v=3","gravatar_id":"","url":"https://api.github.com/users/bvv4ik","html_url":"https://github.com/bvv4ik","followers_url":"https://api.github.com/users/bvv4ik/followers","following_url":"https://api.github.com/users/bvv4ik/following{/other_user}","gists_url":"https://api.github.com/users/bvv4ik/gists{/gist_id}","starred_url":"https://api.github.com/users/bvv4ik/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/bvv4ik/subscriptions","organizations_url":"https://api.github.com/users/bvv4ik/orgs","repos_url":"https://api.github.com/users/bvv4ik/repos","events_url":"https://api.github.com/users/bvv4ik/events{/privacy}","received_events_url":"https://api.github.com/users/bvv4ik/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":{"login":"Zhinsheng","id":13655575,"avatar_url":"https://avatars.githubusercontent.com/u/13655575?v=3","gravatar_id":"","url":"https://api.github.com/users/Zhinsheng","html_url":"https://github.com/Zhinsheng","followers_url":"https://api.github.com/users/Zhinsheng/followers","following_url":"https://api.github.com/users/Zhinsheng/following{/other_user}","gists_url":"https://api.github.com/users/Zhinsheng/gists{/gist_id}","starred_url":"https://api.github.com/users/Zhinsheng/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Zhinsheng/subscriptions","organizations_url":"https://api.github.com/users/Zhinsheng/orgs","repos_url":"https://api.github.com/users/Zhinsheng/repos","events_url":"https://api.github.com/users/Zhinsheng/events{/privacy}","received_events_url":"https://api.github.com/users/Zhinsheng/received_events","type":"User","site_admin":false},"milestone":{"url":"https://api.github.com/repos/e-government-ua/i/milestones/8","html_url":"https://github.com/e-government-ua/i/milestones/Organization_Git-BugTracking-Rules","labels_url":"https://api.github.com/repos/e-government-ua/i/milestones/8/labels","id":1063355,"number":8,"title":"Organization_Git-BugTracking-Rules","description":"Организация среды разработки (репозиторий,структуриры задач,описания)","creator":{"login":"bvv4ik","id":4208821,"avatar_url":"https://avatars.githubusercontent.com/u/4208821?v=3","gravatar_id":"","url":"https://api.github.com/users/bvv4ik","html_url":"https://github.com/bvv4ik","followers_url":"https://api.github.com/users/bvv4ik/followers","following_url":"https://api.github.com/users/bvv4ik/following{/other_user}","gists_url":"https://api.github.com/users/bvv4ik/gists{/gist_id}","starred_url":"https://api.github.com/users/bvv4ik/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/bvv4ik/subscriptions","organizations_url":"https://api.github.com/users/bvv4ik/orgs","repos_url":"https://api.github.com/users/bvv4ik/repos","events_url":"https://api.github.com/users/bvv4ik/events{/privacy}","received_events_url":"https://api.github.com/users/bvv4ik/received_events","type":"User","site_admin":false},"open_issues":5,"closed_issues":13,"state":"open","created_at":"2015-04-11T19:29:57Z","updated_at":"2015-08-17T09:19:25Z","due_on":null,"closed_at":null},"comments":5,"created_at":"2015-07-31T14:15:29Z","updated_at":"2015-09-13T00:36:12Z","closed_at":null,"body":"- [ ] 1) Все образцы обьектов запросов должны быть обрамлены соответствующим образом (там есть достойные примеры)\r\n- [ ] 2) каждый пункт и подпункт сделать в одном стиле.. сейчас все в разнобой\r\n\r\n\r\n\r\nПлан приведения документации в лучший вид:\r\n1) Убрать в примере ответа //[].\r\n2) Убрать фигурные скобки с названий параметров запроса.\r\n3) Контектст отдельно, параметры запроса отдельно.\r\n4) Там гдн Get запросы по возможности подобавлять примеры.\r\n5) В первую группу отнести логин, логаут и назвать \"Аутентификация пользователя\".\r\n6) Сервиса активити в отдельную группу объединить \"Activiti\".\r\n7) Вконце описание мерчантов совсем плохи, обратить внимание\r\n8) Сделать красивую структуру json запросов и ответов (хороший пример http://server:port/wf-central/service/services/setService )\r\n9) Добавить пример запроса в HTTP Context: http://server:port/wf-central/service/services/setService - (взять из getService) \r\n\r\n\r\nСтруктура:\r\n\r\nНазвание раздела (жирным, самый крупный шрифт, все остальное будет мельче)\r\nОписание что сервис делает (выделать на общем фоне, возможно размером шрифта)\r\nТип запроса (GET, POST, PUT, DELETE) жирным\r\nКонтекст жирным\r\nПараметры хедера (если есть)\r\nПараметры запроса в виде списка (навание - расшифровка)\r\nПример запроса (слово \"Пример:\" жирным и после с новой строки сам пример, если GET запрос, то в виде ссылки)\r\nПример ответа (слово \"Ответ:\" жирным и после с новой строки сам ответ.)\r\nРазделитель сервисов в группе (серая горизонтальная полоса)\r\n\r\nВАЖНО:\r\n- правки нужно производить в ветке test а не в ветке master\r\n- Переименовать раздел:\r\n18. Работа со слотами потока\r\nв\r\n18. Работа с \"Электронным Расписанием\" (с потоками, слотами и тикетами)\r\nи поместить в нем, в т.ч.:\r\n24. Получение расписаний включений \r\n25. Добавление/изменение расписания включений \r\n26. Удаление расписания включений \r\n27. Получение расписаний исключений \r\n28. Добавление/изменение расписания исключения \r\n29. Удаление расписания исключений "},"comment":{"url":"https://api.github.com/repos/e-government-ua/i/issues/comments/139832040","html_url":"https://github.com/e-government-ua/i/issues/617#issuecomment-139832040","issue_url":"https://api.github.com/repos/e-government-ua/i/issues/617","id":139832040,"user":{"login":"bvv4ik","id":4208821,"avatar_url":"https://avatars.githubusercontent.com/u/4208821?v=3","gravatar_id":"","url":"https://api.github.com/users/bvv4ik","html_url":"https://github.com/bvv4ik","followers_url":"https://api.github.com/users/bvv4ik/followers","following_url":"https://api.github.com/users/bvv4ik/following{/other_user}","gists_url":"https://api.github.com/users/bvv4ik/gists{/gist_id}","starred_url":"https://api.github.com/users/bvv4ik/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/bvv4ik/subscriptions","organizations_url":"https://api.github.com/users/bvv4ik/orgs","repos_url":"https://api.github.com/users/bvv4ik/repos","events_url":"https://api.github.com/users/bvv4ik/events{/privacy}","received_events_url":"https://api.github.com/users/bvv4ik/received_events","type":"User","site_admin":false},"created_at":"2015-09-13T00:36:12Z","updated_at":"2015-09-13T00:36:12Z","body":"@Zhinsheng\r\nесть перспектива по этой таске или шансы не высоки?)"}}