diff options
author | Keen-github <Keen@ngs.ru> | 2011-09-13 12:32:54 +0700 |
---|---|---|
committer | Keen-github <Keen@ngs.ru> | 2011-09-13 12:32:54 +0700 |
commit | 7a7c269c0e23747ea222536b576e68198a9bef2d (patch) | |
tree | 728194fedc30a7de521c47689f260069eafa4ee1 | |
parent | add mailling list (diff) | |
download | api-description-7a7c269c0e23747ea222536b576e68198a9bef2d.tar.gz |
Second version for pull request
-rw-r--r-- | apps/redmine.json | 360 |
1 files changed, 360 insertions, 0 deletions
diff --git a/apps/redmine.json b/apps/redmine.json new file mode 100644 index 0000000..5e745a4 --- /dev/null +++ b/apps/redmine.json @@ -0,0 +1,360 @@ +{ + "name" : "Redmine API", + "authority" : "GITHUB:Keen-github", + "formats" : [ + "json", + "xml" + ], + "version" : "0.1", + + "methods" :{ + "list_issues" : { + "path" : "/issues.:format", + "required_params" : [ + "format" + ], + "optional_params" : [ + "offset", + "limit", + "page", + "project_id", + "tracker_id", + "status_id", + "cf_XXX" + ], + "method" : "GET", + "authentication" : true + }, + + "get_issue" : { + "path" : "/issues/:id.:format", + "required_params" : [ + "id", + "format" + ], + "method" : "GET", + "authentication" : true + }, + + "create_issue" : { + "path" : "/issues.:format", + "required_params" : [ + "format" + ], + "method" : "POST", + "required_payload": true, + "authentication" : true + }, + + "update_issue" : { + "path" : "/issues/:id.:format", + "required_params" : [ + "id", + "format" + ], + "method" : "PUT", + "required_payload": true, + "authentication" : true + }, + + "delete_issue" : { + "path" : "/issues/:id.:format", + "required_params" : [ + "id", + "format" + ], + "method" : "DELETE", + "authentication" : true + }, + + "list_projects" : { + "path" : "/projects.:format", + "required_params" : [ + "format" + ], + "method" : "GET", + "authentication" : true + }, + + "get_project" : { + "path" : "/projects/:id.:format", + "required_params" : [ + "id", + "format" + ], + "method" : "GET", + "authentication" : true + }, + + "create_project" : { + "path" : "/projects.:format", + "required_params" : [ + "format" + ], + "method" : "POST", + "authentication" : true, + "required_payload": true, + "expected_status": [201, 422] + }, + + "update_project" : { + "path" : "/projects/:id.:format", + "required_params" : [ + "id", + "format" + ], + "method" : "PUT", + "required_payload": true, + "authentication" : true + }, + + "delete_project" : { + "path" : "/projects/:id.:format", + "required_params" : [ + "id", + "format" + ], + "method" : "DELETE", + "authentication" : true + }, + + "list_users" : { + "path" : "/users.:format", + "required_params" : [ + "format" + ], + "method" : "GET", + "authentication" : true + }, + + "get_user" : { + "path" : "/users/:id.:format", + "required_params" : [ + "id", + "format" + ], + "method" : "GET", + "authentication" : true + }, + + "get_current_user" : { + "path" : "/users/current.:format", + "required_params" : [ + "format" + ], + "optional_params" : [ + "include" + ], + "method" : "GET", + "authentication" : true + }, + + "create_user" : { + "path" : "/users.:format", + "required_params" : [ + "format" + ], + "method" : "POST", + "authentication" : true, + "required_payload": true, + "expected_status": [201, 422] + }, + + "update_user" : { + "path" : "/users/:id.:format", + "required_params" : [ + "id", + "format" + ], + "method" : "PUT", + "required_payload": true, + "authentication" : true + }, + + "delete_user" : { + "path" : "/users/:id.:format", + "required_params" : [ + "id", + "format" + ], + "method" : "DELETE", + "authentication" : true, + "expected_status": [200] + }, + + "list_time_entries" : { + "path" : "/time_entries.:format", + "required_params" : [ + "format" + ], + "method" : "GET", + "authentication" : true + }, + + "get_time_entry" : { + "path" : "/time_entries/:id.:format", + "required_params" : [ + "id", + "format" + ], + "method" : "GET", + "authentication" : true + }, + + "create_time_entries" : { + "path" : "/time_entries.:format", + "required_params" : [ + "format" + ], + "method" : "POST", + "authentication" : true, + "required_payload": true, + "expected_status": [201, 422] + }, + + "update_time_entries" : { + "path" : "/time_entries/:id.:format", + "required_params" : [ + "id", + "format" + ], + "method" : "PUT", + "authentication" : true, + "required_payload": true, + "expected_status": [200, 422] + }, + + "delete_time_entry" : { + "path" : "/time_entries/:id.:format", + "required_params" : [ + "id", + "format" + ], + "method" : "DELETE", + "authentication" : true + }, + + "list_issue_relations" : { + "path" : "/issues/:issue_id/relations.:format", + "required_params" : [ + "issue_id", + "format" + ], + "method" : "GET", + "authentication" : true + }, + + "get_issue_relation" : { + "path" : "/relations/:id.:format", + "required_params" : [ + "id", + "format" + ], + "method" : "GET", + "authentication" : true + }, + + "create_issue_relation" : { + "path" : "/issues/:issue_id/relations.:format", + "required_params" : [ + "issue_id", + "format" + ], + "method" : "POST", + "authentication" : true, + "required_payload": true, + "expected_status": [201, 422] + }, + + "delete_issue_relation" : { + "path" : "/relations/:id.:format", + "required_params" : [ + "id", + "format" + ], + "method" : "DELETE", + "authentication" : true, + "expected_status": [200, 422] + }, + + "list_versions" : { + "path" : "/projects/:project_id/versions.:format", + "required_params" : [ + "project_id", + "format" + ], + "method" : "GET", + "authentication" : true + }, + + "get_version" : { + "path" : "/versions/:id.:format", + "required_params" : [ + "id", + "format" + ], + "method" : "GET", + "authentication" : true + }, + + "create_version" : { + "path" : "/projects/:project_id/versions.:format", + "required_params" : [ + "project_id", + "format" + ], + "method" : "POST", + "authentication" : true, + "required_payload": true, + "expected_status": [201, 422] + }, + + "update_version" : { + "path" : "/versions/:id.:format", + "required_params" : [ + "id", + "format" + ], + "method" : "PUT", + "authentication" : true, + "required_payload": true, + "expected_status": [200, 422] + }, + + "delete_version" : { + "path" : "/versions/:id.:format", + "required_params" : [ + "id", + "format" + ], + "method" : "DELETE", + "authentication" : true + }, + + "list_queries" : { + "path" : "/queries.:format", + "required_params" : [ + "format" + ], + "method" : "GET", + "authentication" : true, + "expected_status": [200, 422] + }, + + "get_attachment" : { + "path" : "/attachments/:id.:format", + "required_params" : [ + "id", + "format" + ], + "method" : "GET", + "authentication" : true + } + }, + + "meta" : { + "documentation" : "http://www.redmine.org/projects/redmine/wiki/Rest_api", + "authors" : "LogicEditor.com: Valeriy Skurikhin" + } + +} |