gitea/modules/structs/org.go

// Copyright 2015 The Gogs Authors. All rights reserved.
// SPDX-License-Identifier: MIT

package structs

// Organization represents an organization
type Organization struct {
	// The unique identifier of the organization
	ID int64 `json:"id"`
	// The name of the organization
	Name string `json:"name"`
	// The full display name of the organization
	FullName string `json:"full_name"`
	// The email address of the organization
	Email string `json:"email"`
	// The URL of the organization's avatar
	AvatarURL string `json:"avatar_url"`
	// The description of the organization
	Description string `json:"description"`
	// The website URL of the organization
	Website string `json:"website"`
	// The location of the organization
	Location string `json:"location"`
	// The visibility level of the organization (public, limited, private)
	Visibility string `json:"visibility"`
	// Whether repository administrators can change team access
	RepoAdminChangeTeamAccess bool `json:"repo_admin_change_team_access"`
	// username of the organization
	// deprecated
	UserName string `json:"username"`
}

// OrganizationPermissions list different users permissions on an organization
type OrganizationPermissions struct {
	// Whether the user is an owner of the organization
	IsOwner bool `json:"is_owner"`
	// Whether the user is an admin of the organization
	IsAdmin bool `json:"is_admin"`
	// Whether the user can write to the organization
	CanWrite bool `json:"can_write"`
	// Whether the user can read the organization
	CanRead bool `json:"can_read"`
	// Whether the user can create repositories in the organization
	CanCreateRepository bool `json:"can_create_repository"`
}

// CreateOrgOption options for creating an organization
type CreateOrgOption struct {
	// username of the organization
	// required: true
	UserName string `json:"username" binding:"Required;Username;MaxSize(40)"`
	// The full display name of the organization
	FullName string `json:"full_name" binding:"MaxSize(100)"`
	// The email address of the organization
	Email string `json:"email" binding:"MaxSize(255)"`
	// The description of the organization
	Description string `json:"description" binding:"MaxSize(255)"`
	// The website URL of the organization
	Website string `json:"website" binding:"ValidUrl;MaxSize(255)"`
	// The location of the organization
	Location string `json:"location" binding:"MaxSize(50)"`
	// possible values are `public` (default), `limited` or `private`
	// enum: public,limited,private
	Visibility string `json:"visibility" binding:"In(,public,limited,private)"`
	// Whether repository administrators can change team access
	RepoAdminChangeTeamAccess bool `json:"repo_admin_change_team_access"`
}

// TODO: make EditOrgOption fields optional after https://gitea.com/go-chi/binding/pulls/5 got merged

// EditOrgOption options for editing an organization
type EditOrgOption struct {
	// The full display name of the organization
	FullName string `json:"full_name" binding:"MaxSize(100)"`
	// The email address of the organization
	Email string `json:"email" binding:"MaxSize(255)"`
	// The description of the organization
	Description string `json:"description" binding:"MaxSize(255)"`
	// The website URL of the organization
	Website string `json:"website" binding:"ValidUrl;MaxSize(255)"`
	// The location of the organization
	Location string `json:"location" binding:"MaxSize(50)"`
	// possible values are `public`, `limited` or `private`
	// enum: public,limited,private
	Visibility string `json:"visibility" binding:"In(,public,limited,private)"`
	// Whether repository administrators can change team access
	RepoAdminChangeTeamAccess *bool `json:"repo_admin_change_team_access"`
}

// RenameOrgOption options when renaming an organization
type RenameOrgOption struct {
	// New username for this org. This name cannot be in use yet by any other user.
	//
	// required: true
	// unique: true
	NewName string `json:"new_name" binding:"Required"`
}

// OrgPinnedRepo represents a pinned repository for an organization
type OrgPinnedRepo struct {
	ID           int64           `json:"id"`
	RepoID       int64           `json:"repo_id"`
	GroupID      int64           `json:"group_id,omitempty"`
	DisplayOrder int             `json:"display_order"`
	Repo         *Repository     `json:"repo,omitempty"`
	Group        *OrgPinnedGroup `json:"group,omitempty"`
}

// OrgPinnedGroup represents a group of pinned repositories
type OrgPinnedGroup struct {
	ID           int64  `json:"id"`
	Name         string `json:"name"`
	DisplayOrder int    `json:"display_order"`
	Collapsed    bool   `json:"collapsed"`
}

// AddOrgPinnedRepoOption options for adding a pinned repository
type AddOrgPinnedRepoOption struct {
	// Name of the repository to pin
	// required: true
	RepoName string `json:"repo_name" binding:"Required"`
	// ID of the group to add the repo to (0 for ungrouped)
	GroupID int64 `json:"group_id"`
	// Display order within the group
	DisplayOrder int `json:"display_order"`
}

// ReorderOrgPinnedReposOption options for reordering pinned repositories
type ReorderOrgPinnedReposOption struct {
	// List of repo orders
	// required: true
	Orders []PinnedRepoOrder `json:"orders" binding:"Required"`
}

// PinnedRepoOrder represents the order for a pinned repo
type PinnedRepoOrder struct {
	RepoID       int64 `json:"repo_id"`
	GroupID      int64 `json:"group_id"`
	DisplayOrder int   `json:"display_order"`
}

// CreateOrgPinnedGroupOption options for creating a pinned group
type CreateOrgPinnedGroupOption struct {
	// Name of the group
	// required: true
	Name string `json:"name" binding:"Required;MaxSize(100)"`
	// Display order
	DisplayOrder int `json:"display_order"`
	// Whether the group is collapsed by default
	Collapsed bool `json:"collapsed"`
}

// UpdateOrgPinnedGroupOption options for updating a pinned group
type UpdateOrgPinnedGroupOption struct {
	// Name of the group
	Name *string `json:"name"`
	// Display order
	DisplayOrder *int `json:"display_order"`
	// Whether the group is collapsed by default
	Collapsed *bool `json:"collapsed"`
}

// OrgPublicMember represents a public member of an organization
type OrgPublicMember struct {
	User *User  `json:"user"`
	Role string `json:"role"` // "Owner", "Admin", "Member"
}

// OrgOverview represents the organization overview for the profile page
type OrgOverview struct {
	Organization  *Organization      `json:"organization"`
	PinnedRepos   []*OrgPinnedRepo   `json:"pinned_repos"`
	PinnedGroups  []*OrgPinnedGroup  `json:"pinned_groups"`
	PublicMembers []*OrgPublicMember `json:"public_members"`
	TotalMembers  int64              `json:"total_members"`
	Stats         *OrgOverviewStats  `json:"stats"`
	Profile       *OrgProfileContent `json:"profile,omitempty"`
}

// OrgOverviewStats represents organization statistics
type OrgOverviewStats struct {
	TotalRepos   int64 `json:"total_repos"`
	TotalMembers int64 `json:"total_members"`
	TotalTeams   int64 `json:"total_teams"`
	TotalStars   int64 `json:"total_stars"`
}

// OrgProfileContent represents the organization profile content
type OrgProfileContent struct {
	HasProfile bool   `json:"has_profile"`
	Readme     string `json:"readme,omitempty"`
	HasCSS     bool   `json:"has_css"`
}