StoryBoard/ObjectModel
Storyboard Object Model
Contents
Entities List
- Project Group
- Project
- Branch
- Milestone
- Story
- Task
- Comment
Entities Details
Project Group
A Project Group object represents a list of projects which are closely dependent on each other.
Field Name | Type | Description |
---|---|---|
id | integer | A primary key for a database. |
name | string | Project Group short name. One word names are preferred. |
title | string | A detailed description for the entire Project Group. |
members | list(Project) | A list of Projects that belong to this Project Group. |
Project
A Project object represents a single project.
Field Name | Type | Description |
---|---|---|
id | integer | A primary key for a database. |
name | string | A Project short name. One word names are preferred. |
title | string | A detailed description for the Project. |
Branch
A Branch object represents a single development branch.
Field Name | Type | Description |
---|---|---|
id | integer | A primary key for a database. |
name | string | Full Branch name. |
short_name | string | Short Branch name. |
status | char | Release status of a Branch. This may be M - master, R - release, S - stable, U - unsupported. |
Milestone
A Milestone object is used for associating Stories with a moment of time, when they are expected to be implemented.
Field Name | Type | Description |
---|---|---|
id | integer | A primary key for a database. |
name | string | Milestone name. |
branch | Branch | A Branch to which this Milestone belongs to. |
released | boolean | Is this Milestone already released. |
undefined | boolean | Milestone marked 'undefined' is similar to 'next' Milestone in Launchpad. |
Story
A Story is a basic object to describe bugs and features Stories are used to group Tasks.
Field Name | Type | Description |
---|---|---|
id | integer | A primary key for a database. |
title | string | Story name. |
description | string | Full Story description. |
is_bug | boolean | Is this Story a bug or a feature. |
priority | integer | 0 - Undefined, 1 - Low, 2 - Medium, 3 - High, 4 - Critical. |
creator | User | User who has created this Story. |
Task
A Task is a Project specific part of a Story (Feature or Bug).
Field Name | Type | Description |
---|---|---|
id | integer | A primary key for a database. |
title | string | Task name. |
story | Story | The Story, to which this Task belongs to. |
project | Project | The Project, to which this Task belongs to. |
assignee | User | The User assigned to this Task. May be empty. Empty by default. |
status | char | T - Todo, R - In review, L - Landed. |
milestone | Milestone | The Milestone when this Task is expected to be implemented. |