Back to top

API Documentation

Resource Group

Resource

GET/api/projects

Example URI

GET /api/projects
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer $token
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "projects": [
    {
      "id": 6,
      "name": "Welcome Project!",
      "repository": "rails",
      "slack_webhook_url": null,
      "velocity": 20,
      "span": 1,
      "serial_num": 22
    }
  ]
}

Resource

GET/api/projects/:project_id/stories

Example URI

GET /api/projects/:project_id/stories
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer $token
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "stories": [
    {
      "id": 46,
      "title": "ストーリーはビジネス側が気にするべきタスクの単位です",
      "description": "開発が今何をしているかを可視化しつつ、全体の進捗を見ることができます。",
      "status": "created",
      "points": 0,
      "position": 1,
      "serial_num": 1
    },
    {
      "id": 47,
      "title": "ストーリーにはタスクが紐付きます",
      "description": "工数はタスクがどれくらいで完了するかを表しています。",
      "status": "created",
      "points": 10,
      "position": 2,
      "serial_num": 2
    },
    {
      "id": 48,
      "title": "ステータスは9個あります",
      "description": null,
      "status": "created",
      "points": 10,
      "position": 3,
      "serial_num": 3
    },
    {
      "id": 49,
      "title": "ベロシティは開発チームの期間あたりのタスク消化量です",
      "description": "消化量の平均値を出すことでそのプロジェクトの開発スケジュールを自動で計算します。",
      "status": "created",
      "points": 0,
      "position": 4,
      "serial_num": 4
    },
    {
      "id": 50,
      "title": "では具体的なストーリーのサンプルを見てみましょう",
      "description": null,
      "status": "created",
      "points": 0,
      "position": 5,
      "serial_num": 5
    },
    {
      "id": 51,
      "title": "ユーザーがログインできる",
      "description": null,
      "status": "created",
      "points": 9,
      "position": 6,
      "serial_num": 6
    },
    {
      "id": 52,
      "title": "ユーザーがチームを登録できる",
      "description": null,
      "status": "created",
      "points": 3,
      "position": 7,
      "serial_num": 7
    },
    {
      "id": 53,
      "title": "ユーザーがチームにメンバーを招待できる",
      "description": null,
      "status": "created",
      "points": 6,
      "position": 8,
      "serial_num": 8
    },
    {
      "id": 54,
      "title": "ユーザーがプロジェクトを作成できる",
      "description": null,
      "status": "created",
      "points": 6,
      "position": 9,
      "serial_num": 9
    }
  ]
}

Resource

POST/api/projects/:project_id/stories

Example URI

POST /api/projects/:project_id/stories
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer $token
Body
{
  "story": {
    "title": "This is new story."
  }
}
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "story": {
    "id": 55,
    "title": "This is new story.",
    "description": null,
    "status": "created",
    "points": 0,
    "position": 10,
    "serial_num": 23
  }
}

Resource

PATCH/api/projects/:project_id/stories/:story_serial_num

Example URI

PATCH /api/projects/:project_id/stories/:story_serial_num
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer $token
Body
{
  "story": {
    "title": "This is updated story title."
  }
}
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "story": {
    "id": 55,
    "title": "This is updated story title.",
    "description": null,
    "status": "created",
    "points": 0,
    "position": 10,
    "serial_num": 23
  }
}

Resource

DELETE/api/projects/:project_id/stories/:story_serial_num

Example URI

DELETE /api/projects/:project_id/stories/:story_serial_num
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer $token
Response  204

Resource

GET/api/projects/:project_id/stories/:story_serial_num/tasks

Example URI

GET /api/projects/:project_id/stories/:story_serial_num/tasks
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer $token
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "tasks": [
    {
      "id": 66,
      "story_id": 46,
      "author_id": 6,
      "user_id": null,
      "title": "タスクはエンジニアが気にすべきタスクの単位です",
      "description": null,
      "issue_url": null,
      "pull_url": null,
      "status": "created",
      "points": 0,
      "kind": "feature",
      "position": 1,
      "serial_num": 10,
      "closed": false,
      "started_at": null,
      "stg_deployed_at": null,
      "deployed_at": null,
      "done_at": null,
      "created_at": "2017-07-18T18:24:31.000+09:00",
      "updated_at": "2017-07-18T18:24:31.000+09:00"
    }
  ]
}

Resource

POST/api/projects/:project_id/stories/:story_serial_num/tasks

Example URI

POST /api/projects/:project_id/stories/:story_serial_num/tasks
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer $token
Body
{
  "task": {
    "title": "This is new task title"
  }
}
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "task": {
    "id": 79,
    "story_id": 46,
    "author_id": 6,
    "user_id": null,
    "title": "This is new task title",
    "description": null,
    "issue_url": null,
    "pull_url": null,
    "status": "created",
    "points": 0,
    "kind": "feature",
    "position": 2,
    "serial_num": 24,
    "closed": false,
    "started_at": null,
    "stg_deployed_at": null,
    "deployed_at": null,
    "done_at": null,
    "created_at": "2017-07-18T18:26:23.000+09:00",
    "updated_at": "2017-07-18T18:26:23.000+09:00"
  }
}

Resource

PATCH/api/projects/:project_id/stories/:story_serial_num/tasks/:task_serial_num

Example URI

PATCH /api/projects/:project_id/stories/:story_serial_num/tasks/:task_serial_num
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer $token
Body
{
  "task": {
    "title": "This is updated task title"
  }
}
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "task": {
    "id": 79,
    "story_id": 46,
    "author_id": 6,
    "user_id": null,
    "title": "This is updated task title",
    "description": null,
    "issue_url": null,
    "pull_url": null,
    "status": "created",
    "points": 0,
    "kind": "feature",
    "position": 2,
    "serial_num": 24,
    "closed": false,
    "started_at": null,
    "stg_deployed_at": null,
    "deployed_at": null,
    "done_at": null,
    "created_at": "2017-07-18T18:26:23.000+09:00",
    "updated_at": "2017-07-18T18:26:33.000+09:00"
  }
}

Resource

DELETE/api/projects/:project_id/stories/:story_serial_num/tasks/:task_serial_num

Example URI

DELETE /api/projects/:project_id/stories/:story_serial_num/tasks/:task_serial_num
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer $token
Response  204

Generated by aglio on 18 Jul 2017