Documentation
¶
Overview ¶
Package processes exposes the Azure DevOps Work Item Tracking process customization service: organization processes and their work item types, fields, states, and behaviors.
Index ¶
- Constants
- func Register(s *server.Server, c *ado.Clients)
- type AddFieldInput
- type AddWorkItemTypeInput
- type Behavior
- type CreateBehaviorInput
- type CreateInput
- type DeleteBehaviorInput
- type DeleteInput
- type GetInput
- type ListBehaviorsInput
- type ListFieldsInput
- type ListInput
- type ListStatesInput
- type ListWorkItemTypesInput
- type Process
- type ProcessField
- type ProcessState
- type ProcessWorkItemType
Constants ¶
const Name = "processes"
Name is the toolset name used for enable/disable filtering.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type AddFieldInput ¶ added in v0.1.2
type AddFieldInput struct {
ProcessID string `json:"processId" jsonschema:"the process ID"`
WitRefName string `json:"witRefName" jsonschema:"the work item type reference name"`
FieldRefName string `json:"fieldRefName" jsonschema:"the field reference name"`
Required bool `json:"required,omitempty" jsonschema:"whether the field is required (optional, default false)"`
Extra map[string]any `json:"extra,omitempty" jsonschema:"additional fields to merge into the request body (optional)"`
}
AddFieldInput identifies the field to add to a work item type within a process.
type AddWorkItemTypeInput ¶ added in v0.1.2
type AddWorkItemTypeInput struct {
ProcessID string `json:"processId" jsonschema:"the process ID"`
Name string `json:"name" jsonschema:"the work item type name"`
Description string `json:"description,omitempty" jsonschema:"the work item type description (optional)"`
Color string `json:"color,omitempty" jsonschema:"the work item type color, as a hex string without the leading '#' (optional)"`
Icon string `json:"icon,omitempty" jsonschema:"the work item type icon identifier (optional)"`
InheritsFrom string `json:"inheritsFrom,omitempty" jsonschema:"the reference name of the work item type this one inherits from (optional)"`
Extra map[string]any `json:"extra,omitempty" jsonschema:"additional fields to merge into the request body (optional)"`
}
AddWorkItemTypeInput describes a new work item type to add to a process.
type Behavior ¶
type Behavior struct {
ReferenceName string `json:"referenceName"`
Name string `json:"name"`
Description string `json:"description,omitempty"`
Rank int `json:"rank,omitempty"`
Color string `json:"color,omitempty"`
}
Behavior is a behavior defined within a process.
type CreateBehaviorInput ¶ added in v0.1.2
type CreateBehaviorInput struct {
ProcessID string `json:"processId" jsonschema:"the process ID"`
Name string `json:"name" jsonschema:"the behavior name"`
Color string `json:"color,omitempty" jsonschema:"the behavior color, as a hex string without the leading '#' (optional)"`
InheritsFrom string `json:"inheritsFrom,omitempty" jsonschema:"the reference name of the behavior this one inherits from (optional)"`
Extra map[string]any `json:"extra,omitempty" jsonschema:"additional fields to merge into the request body (optional)"`
}
CreateBehaviorInput describes a new behavior to add to a process.
type CreateInput ¶ added in v0.1.2
type CreateInput struct {
Name string `json:"name" jsonschema:"the process name"`
Description string `json:"description,omitempty" jsonschema:"the process description (optional)"`
ParentProcessTypeID string `` /* 136-byte string literal not displayed */
Extra map[string]any `json:"extra,omitempty" jsonschema:"additional fields to merge into the request body (optional)"`
}
CreateInput describes a new inherited process.
type DeleteBehaviorInput ¶ added in v0.1.2
type DeleteBehaviorInput struct {
ProcessID string `json:"processId" jsonschema:"the process ID"`
BehaviorRefName string `json:"behaviorRefName" jsonschema:"the behavior reference name"`
}
DeleteBehaviorInput identifies the behavior to remove from a process.
type DeleteInput ¶ added in v0.1.2
type DeleteInput struct {
ProcessTypeID string `json:"processTypeId" jsonschema:"the process type ID"`
}
DeleteInput identifies the process to delete.
type GetInput ¶
type GetInput struct {
ProcessTypeID string `json:"processTypeId" jsonschema:"the process type ID"`
}
GetInput identifies a single process.
type ListBehaviorsInput ¶
type ListBehaviorsInput struct {
ProcessTypeID string `json:"processTypeId" jsonschema:"the process type ID"`
}
ListBehaviorsInput identifies the process whose behaviors are listed.
type ListFieldsInput ¶
type ListFieldsInput struct {
ProcessTypeID string `json:"processTypeId" jsonschema:"the process type ID"`
WitRefName string `json:"witRefName" jsonschema:"the work item type reference name"`
}
ListFieldsInput identifies the work item type whose fields are listed.
type ListStatesInput ¶
type ListStatesInput struct {
ProcessTypeID string `json:"processTypeId" jsonschema:"the process type ID"`
WitRefName string `json:"witRefName" jsonschema:"the work item type reference name"`
}
ListStatesInput identifies the work item type whose states are listed.
type ListWorkItemTypesInput ¶
type ListWorkItemTypesInput struct {
ProcessTypeID string `json:"processTypeId" jsonschema:"the process type ID"`
Expand string `json:"expand,omitempty" jsonschema:"additional details to expand, e.g. states (optional)"`
}
ListWorkItemTypesInput identifies the process whose work item types are listed.
type Process ¶
type Process struct {
TypeID string `json:"typeId"`
Name string `json:"name"`
ReferenceName string `json:"referenceName,omitempty"`
Description string `json:"description,omitempty"`
IsEnabled bool `json:"isEnabled,omitempty"`
IsDefault bool `json:"isDefault,omitempty"`
ParentProcessTypeID string `json:"parentProcessTypeId,omitempty"`
}
Process is an organization work item tracking process.
type ProcessField ¶
type ProcessField struct {
ReferenceName string `json:"referenceName"`
Name string `json:"name"`
Type string `json:"type,omitempty"`
Required bool `json:"required,omitempty"`
ReadOnly bool `json:"readOnly,omitempty"`
}
ProcessField is a field on a process work item type.
type ProcessState ¶
type ProcessState struct {
ID string `json:"id"`
Name string `json:"name"`
Color string `json:"color,omitempty"`
StateCategory string `json:"stateCategory,omitempty"`
Order int `json:"order,omitempty"`
}
ProcessState is a workflow state of a process work item type.
type ProcessWorkItemType ¶
type ProcessWorkItemType struct {
ReferenceName string `json:"referenceName"`
Name string `json:"name"`
Description string `json:"description,omitempty"`
Color string `json:"color,omitempty"`
Icon string `json:"icon,omitempty"`
IsDisabled bool `json:"isDisabled,omitempty"`
Customization string `json:"customization,omitempty"`
}
ProcessWorkItemType is a work item type defined within a process.