models

Documentation

Index

• type ExtendedRepository
• type Group
• type GroupYaml
• type ProjectYaml
• type RepoDiff
• type RepositoryOptions
• type RepositoryYaml
• type RollbackPlan
• type User
• type UserYaml
• type WebhookResponse
• type WorkzoneData

Types

type ExtendedRepository

type ExtendedRepository struct {
	ProjectKey     string                                `json:"projectKey,omitempty" yaml:"projectKey,omitempty"`
	RepositorySlug string                                `json:"repositorySlug,omitempty" yaml:"repositorySlug,omitempty"`
	DefaultBranch  string                                `json:"defaultBranch,omitempty" yaml:"defaultBranch,omitempty"`
	RestRepository *openapi.RestRepository               `json:"restRepository,omitempty" yaml:"restRepository,omitempty"`
	Webhooks       *[]openapi.RestWebhook                `json:"webhooks,omitempty" yaml:"webhooks,omitempty"`
	Manifest       *map[string]any                       `json:"manifest,omitempty" yaml:"manifest,omitempty"`
	ConfigFiles    *map[string]any                       `json:"configFiles,omitempty" yaml:"configFiles,omitempty"`
	RequiredBuilds *[]openapi.RestRequiredBuildCondition `json:"requiredBuilds,omitempty" yaml:"requiredBuilds,omitempty"`
	ReviewerGroups *[]openapi.RestReviewerGroup          `json:"reviewerGroups,omitempty" yaml:"reviewerGroups,omitempty"`
	Workzone       *WorkzoneData                         `json:"workzone,omitempty" yaml:"workzone,omitempty"`
}

Extended repository struct

type Group

type Group struct {
	Name string `json:"name" yaml:"name"`
}

Group represents a group for YAML parsing (with string fields)

type GroupYaml

type GroupYaml struct {
	Groups []Group `json:"groups,omitempty" yaml:"groups,omitempty"`
}

type ProjectYaml

type ProjectYaml struct {
	Projects []openapi.RestProject `json:"projects,omitempty" yaml:"projects,omitempty"`
}

type RepoDiff

type RepoDiff struct {
	Create []ExtendedRepository `json:"create" yaml:"create"`
	Update []ExtendedRepository `json:"update" yaml:"update"`
	Delete []ExtendedRepository `json:"delete" yaml:"delete"`
}

RepoDiff is a generic diff container for repository-scoped items. The concrete items (required-builds, webhooks) live inside ExtendedRepository fields.

type RepositoryOptions

type RepositoryOptions struct {
	Repository     bool
	Webhooks       bool
	DefaultBranch  bool
	Manifest       bool
	ManifestPath   *string
	ConfigFiles    bool
	ConfigFileMap  map[string]string
	RequiredBuilds bool
}

type RepositoryYaml

type RepositoryYaml struct {
	Repositories []ExtendedRepository `json:"repositories,omitempty" yaml:"repositories,omitempty"`
}

type RollbackPlan

type RollbackPlan struct {
	Delete []ExtendedRepository `json:"delete" yaml:"delete"`
	Update []ExtendedRepository `json:"update" yaml:"update"`
	Create []ExtendedRepository `json:"create" yaml:"create"`
}

RollbackPlan represents a set of repository-level changes that can be executed (apply) or reversed (rollback). It is generic for different domains (required-builds, webhooks) since the payload lives inside ExtendedRepository fields (RequiredBuilds or Webhooks).

type User

type User struct {
	Name         string `json:"name" yaml:"name"`
	DisplayName  string `json:"displayName" yaml:"displayName"`
	EmailAddress string `json:"emailAddress" yaml:"emailAddress"`
}

User represents a user for YAML parsing (with string fields)

type UserYaml

type UserYaml struct {
	Users []User `json:"users,omitempty" yaml:"users,omitempty"`
}

type WebhookResponse

type WebhookResponse struct {
	Size       int                   `json:"size,omitempty" yaml:"size,omitempty"`
	Limit      int                   `json:"limit,omitempty" yaml:"limit,omitempty"`
	IsLastPage bool                  `json:"isLastPage,omitempty" yaml:"isLastPage,omitempty"`
	Values     []openapi.RestWebhook `json:"values,omitempty" yaml:"values,omitempty"`
	Start      int                   `json:"start,omitempty" yaml:"start,omitempty"`
}

type WorkzoneData

type WorkzoneData struct {
	WorkflowProperties *workzone.WorkflowProperties `json:"workflowProperties,omitempty" yaml:"workflowProperties,omitempty"`
	// Future sections: Reviewers, AutoMergers, Signatures, GlobalConfig, etc.
	Reviewers     []workzone.RestBranchReviewers     `json:"reviewers,omitempty" yaml:"reviewers,omitempty"`
	Signapprovers []workzone.RestBranchSignapprovers `json:"signapprovers,omitempty" yaml:"signapprovers,omitempty"`
	Mergerules    []workzone.RestBranchAutoMergers   `json:"mergerules,omitempty" yaml:"mergerules,omitempty"`
}

WorkzoneData groups Workzone-related sections for a repository