docs: update references to list

docs/content/doc/development/errors.md

@@ -49,7 +49,7 @@ func (err ErrUserDoesNotExist) Error() string {
 // This needs to be unique, so you should check whether the error code exists or not.
 // The general convention for error codes is as follows:
 // * Every "group" errors lives in a thousend something. For example all user issues are 1000-something, all 
-//   list errors are 3000-something and so on.
+//   project errors are 3000-something and so on.
 // * New error codes should be the current max error code + 1. Don't take free numbers to prevent old errors
 //   which are depricated and removed from being "new ones". For example, if there are error codes 1001, 1002, 1004,
 //   a new error should be 1005 and not 1003.

docs/content/doc/development/feature.md

@@ -26,8 +26,8 @@ It returns the `limit` (max-length) and `offset` parameters needed for SQL-Queri
 You can feed this function directly into xorm's `Limit`-Function like so:
 
 {{< highlight golang >}}
-lists := []List{}
-err := x.Limit(getLimitFromPageIndex(pageIndex, itemsPerPage)).Find(&lists)
+projects := []*Project{}
+err := x.Limit(getLimitFromPageIndex(pageIndex, itemsPerPage)).Find(&projects)
 {{< /highlight >}}
 
 // TODO: Add a full example from start to finish, like a tutorial on how to create a new endpoint?

docs/content/doc/development/migration.md

@@ -20,8 +20,8 @@ There are two ways of migrating data from another service:
 1. Through the auth-based flow where the user gives you access to their data at the third-party service through an 
    oauth flow. You can then call the service's api on behalf of your user to get all the data.
    The Todoist, Trello and Microsoft To-Do Migrators use this pattern.
-2. A file migration where the user uploads a file obtained from some third-party service. In your migrator, you need 
-   to parse the file and create the lists, tasks etc.
+2. A file migration where the user uploads a file obtained from some third-party service. In your migrator, you need
+   to parse the file and create the projects, tasks etc.
    The Vikunja File Import uses this pattern.
 
 To differentiate the two, there are two different interfaces you must implement.
@@ -61,7 +61,7 @@ type FileMigrator interface {
 	// Name holds the name of the migration.
 	// This is used to show the name to users and to keep track of users who already migrated.
 	Name() string
-	// Migrate is the interface used to migrate a user's tasks, list and other things from a file to vikunja.
+	// Migrate is the interface used to migrate a user's tasks, projects and other things from a file to vikunja.
 	// The user object is the user who's tasks will be migrated.
 	Migrate(user *user.User, file io.ReaderAt, size int64) error
 }
@@ -103,9 +103,9 @@ You should also document the routes with [swagger annotations]({{< ref "swagger-
 ## Insertion helper method
 
 There is a method available in the `migration` package which takes a fully nested Vikunja structure and creates it with all relations. 
-This means you start by adding a namespace, then add lists inside of that namespace, then tasks in the lists and so on.
+This means you start by adding a namespace, then add projects inside that namespace, then tasks in the lists and so on.
 
-The root structure must be present as `[]*models.NamespaceWithListsAndTasks`. It allows to represent all of Vikunja's 
+The root structure must be present as `[]*models.NamespaceWithProjectsAndTasks`. It allows to represent all of Vikunja's 
 hierachie as a single data structure.
 
 Then call the method like so:

docs/content/doc/development/structure.md

@@ -108,7 +108,7 @@ Contains all possible avatar providers a user can choose to set their avatar.
 
 #### background
 
-All list background providers are in sub-packages of this package.
+All project background providers are in sub-packages of this package.
 
 #### dump
 

docs/content/doc/development/swagger-docs.md

@@ -19,29 +19,51 @@ The api documentation is generated using [swaggo](https://github.com/swaggo/swag
 You should always comment every field which will be exposed as a json in the api.
 These comments will show up in the documentation, it'll make it easier for developers using the api.
 
-As an example, this is the definition of a list with all comments:
+As an example, this is the definition of a project with all comments:
 
 {{< highlight golang >}}
-// List represents a list of tasks
-type List struct {
-	// The unique, numeric id of this list.
-	ID int64 `xorm:"bigint autoincr not null unique pk" json:"id" param:"list"`
-	// The title of the list. You'll see this in the namespace overview.
-	Title string `xorm:"varchar(250)" json:"title" valid:"required,runelength(3|250)" minLength:"3" maxLength:"250"`
-	// The description of the list.
-	Description string `xorm:"varchar(1000)" json:"description" valid:"runelength(0|1000)" maxLength:"1000"`
-	OwnerID     int64  `xorm:"bigint INDEX" json:"-"`
-	NamespaceID int64  `xorm:"bigint INDEX" json:"-" param:"namespace"`
+type Project struct {
+	// The unique, numeric id of this project.
+	ID int64 `xorm:"bigint autoincr not null unique pk" json:"id" param:"project"`
+	// The title of the project. You'll see this in the namespace overview.
+	Title string `xorm:"varchar(250) not null" json:"title" valid:"required,runelength(1|250)" minLength:"1" maxLength:"250"`
+	// The description of the project.
+	Description string `xorm:"longtext null" json:"description"`
+	// The unique project short identifier. Used to build task identifiers.
+	Identifier string `xorm:"varchar(10) null" json:"identifier" valid:"runelength(0|10)" minLength:"0" maxLength:"10"`
+	// The hex color of this project
+	HexColor string `xorm:"varchar(6) null" json:"hex_color" valid:"runelength(0|6)" maxLength:"6"`
 
-	// The user who created this list.
-	Owner User `xorm:"-" json:"owner" valid:"-"`
-	// An array of tasks which belong to the list.
-	Tasks []*ListTask `xorm:"-" json:"tasks"`
+	OwnerID     int64 `xorm:"bigint INDEX not null" json:"-"`
+	NamespaceID int64 `xorm:"bigint INDEX not null" json:"namespace_id" param:"namespace"`
 
-	// A unix timestamp when this list was created. You cannot change this value.
-	Created int64 `xorm:"created" json:"created"`
-	// A unix timestamp when this list was last updated. You cannot change this value.
-	Updated int64 `xorm:"updated" json:"updated"`
+	// The user who created this project.
+	Owner *user.User `xorm:"-" json:"owner" valid:"-"`
+
+	// Whether or not a project is archived.
+	IsArchived bool `xorm:"not null default false" json:"is_archived" query:"is_archived"`
+
+	// The id of the file this project has set as background
+	BackgroundFileID int64 `xorm:"null" json:"-"`
+	// Holds extra information about the background set since some background providers require attribution or similar. If not null, the background can be accessed at /projects/{projectID}/background
+	BackgroundInformation interface{} `xorm:"-" json:"background_information"`
+	// Contains a very small version of the project background to use as a blurry preview until the actual background is loaded. Check out https://blurha.sh/ to learn how it works.
+	BackgroundBlurHash string `xorm:"varchar(50) null" json:"background_blur_hash"`
+
+	// True if a project is a favorite. Favorite projects show up in a separate namespace. This value depends on the user making the call to the api.
+	IsFavorite bool `xorm:"-" json:"is_favorite"`
+
+	// The subscription status for the user reading this project. You can only read this property, use the subscription endpoints to modify it.
+	// Will only returned when retreiving one project.
+	Subscription *Subscription `xorm:"-" json:"subscription,omitempty"`
+
+	// The position this project has when querying all projects. See the tasks.position property on how to use this.
+	Position float64 `xorm:"double null" json:"position"`
+
+	// A timestamp when this project was created. You cannot change this value.
+	Created time.Time `xorm:"created not null" json:"created"`
+	// A timestamp when this project was last updated. You cannot change this value.
+	Updated time.Time `xorm:"updated not null" json:"updated"`
 
 	web.CRUDable `xorm:"-" json:"-"`
 	web.Rights   `xorm:"-" json:"-"`