provider

type APIConstraint ¶ added in v0.8.0

type APIConstraint interface {
	*models.ProjectScheme |
		*models.IssueTypeScheme |
		*models.ProjectCategoryScheme |
		*models.IssueFieldScheme
}

APIConstraint enumerates the supported go‑atlassian API models returned by service calls.

type APIListConstraint ¶ added in v0.8.0

type APIListConstraint interface {
	*models.ProjectScheme | *models.ProjectCategoryScheme | *models.IssueTypeScheme
}

Generic type constraints restricted to available provider types.

What these do - APIListConstraint enumerates the supported go-atlassian API models that appear in lists. - OutModelConstraint enumerates the supported Terraform object models (map values).

How to extend - Add new API and output model types to the unions below when introducing a new data source.

type AttrTypesFunc ¶ added in v0.8.0

type AttrTypesFunc func() map[string]attr.Type

type CRUDHooks ¶ added in v0.8.0

type CRUDHooks[TState StateConstraint, TPayload PayloadConstraint, TAPI APIConstraint] struct {
	// Required
	BuildPayload PayloadBuilderFunc[TState, TPayload]

	// API calls
	APICreate CreateFunc[TPayload, TAPI]
	APIRead   ReadFunc[TAPI]
	APIUpdate UpdateFunc[TPayload, TAPI]
	APIDelete DeleteFunc

	// State helpers
	ExtractID  ExtractIDFunc[TState]
	MapToState MapToStateFunc[TState, TAPI]

	// Optional hook for Create flows that need a follow-up read
	PostCreate PostAPIHook[TState, TAPI]
	PostRead   PostAPIHook[TState, TAPI]
	PostUpdate PostAPIHook[TState, TAPI]

	// Per-operation status options
	AcceptableCreateStatuses []int
	AcceptableUpdateStatuses []int
	AcceptableDeleteStatuses []int
	TreatDelete404AsSuccess  bool
}

CRUDHooks defines per‑resource behavior consumed by the generic runner.

Provide only the resource‑specific logic here; the runner coordinates the flow.

Required - BuildPayload: Construct the API payload from planned state (Create/Update). - APICreate/APIRead/APIUpdate/APIDelete: Call the concrete go‑atlassian client methods. - ExtractID: Return the stable identifier from state (used for Read/Update/Delete). - MapToState: Map the API model to Terraform state (also used by Import).

Optional - PostCreateRead: If Create returns a partial object, fetch the full model (Create → Get). - Acceptable*Statuses: Override HTTP statuses that should be treated as success per operation. - TreatDelete404AsSuccess: Make Delete idempotent by treating 404 as success.

Typical wiring - Define a hooks() method on each resource that returns CRUDHooks with all fields set. - Use ensureWith(&resp.Diagnostics) (see shared_helpers.go) to bind diagnostics in Do* calls. - Use shared mappers (map*SchemeToModel) for MapToState to keep behavior consistent.

type CRUDRunner ¶ added in v0.8.0

type CRUDRunner[TState StateConstraint, TPayload PayloadConstraint, TAPI APIConstraint] struct {
	// contains filtered or unexported fields
}

CRUDRunner coordinates the CRUD lifecycle using the per‑resource CRUDHooks. It is generic over TState (Terraform model), TPayload (API payload), and TAPI (API model).

func NewCRUDRunner[TState StateConstraint, TPayload PayloadConstraint, TAPI APIConstraint](hooks CRUDHooks[TState, TPayload, TAPI]) CRUDRunner[TState, TPayload, TAPI]

func (r CRUDRunner[TState, TPayload, TAPI]) DoCreate(
	ctx context.Context,
	getPlan func(ctx context.Context, dst *TState) diag.Diagnostics,
	setState func(ctx context.Context, src *TState) diag.Diagnostics,
	ensure func(ctx context.Context, action string, resp *models.ResponseScheme, err error, opts *EnsureSuccessOrDiagOptions) bool,
) diag.Diagnostics

func (r CRUDRunner[TState, TPayload, TAPI]) DoDelete(
	ctx context.Context,
	getState func(ctx context.Context, dst *TState) diag.Diagnostics,
	ensure func(ctx context.Context, action string, resp *models.ResponseScheme, err error, opts *EnsureSuccessOrDiagOptions) bool,
) diag.Diagnostics

func (r CRUDRunner[TState, TPayload, TAPI]) DoImport(
	ctx context.Context,
	id string,
	setState func(ctx context.Context, src *TState) diag.Diagnostics,
	ensure func(ctx context.Context, action string, resp *models.ResponseScheme, err error, opts *EnsureSuccessOrDiagOptions) bool,
) diag.Diagnostics

func (r CRUDRunner[TState, TPayload, TAPI]) DoRead(
	ctx context.Context,
	getState func(ctx context.Context, dst *TState) diag.Diagnostics,
	setState func(ctx context.Context, src *TState) diag.Diagnostics,
	remove func(ctx context.Context),
	ensure func(ctx context.Context, action string, resp *models.ResponseScheme, err error, opts *EnsureSuccessOrDiagOptions) bool,
	httpStatus func(*models.ResponseScheme) int,
) diag.Diagnostics

func (r CRUDRunner[TState, TPayload, TAPI]) DoUpdate(
	ctx context.Context,
	getPlan func(ctx context.Context, dst *TState) diag.Diagnostics,
	setState func(ctx context.Context, src *TState) diag.Diagnostics,
	ensure func(ctx context.Context, action string, resp *models.ResponseScheme, err error, opts *EnsureSuccessOrDiagOptions) bool,
) diag.Diagnostics

type CreateFunc ¶ added in v0.8.0

type CreateFunc[TPayload PayloadConstraint, TAPI APIConstraint] func(ctx context.Context, p TPayload) (api TAPI, apiResp *models.ResponseScheme, err error)

CreateFunc invokes the concrete API Create call and returns the created API model (TAPI). The models.ResponseScheme is threaded for Ensure* handling (status/body diagnostics).

type DeleteFunc ¶ added in v0.8.0

type DeleteFunc func(ctx context.Context, id string) (apiResp *models.ResponseScheme, err error)

DeleteFunc invokes the concrete API Delete call; Ensure* handles status evaluation and 404 semantics.

type EnsureSuccessOrDiagOptions ¶ added in v0.5.0

type EnsureSuccessOrDiagOptions struct {
	AcceptableStatuses      []int
	TreatRead404AsNotFound  bool
	TreatDelete404AsSuccess bool
	IncludeBodySnippet      bool
	MaxBodyBytes            int
}

EnsureSuccessOrDiagOptions configures success and diagnostics behavior per operation. AcceptableStatuses extends success criteria beyond 2xx. TreatRead404AsNotFound means callers will handle state removal on 404 reads. TreatDelete404AsSuccess makes delete idempotent. IncludeBodySnippet appends a truncated response body and select headers.

type ExtractIDFunc ¶ added in v0.8.0

type ExtractIDFunc[TState StateConstraint] func(st *TState) string

ExtractIDFunc returns the stable identifier from the current state (typically id string).

type FilterFunc ¶ added in v0.8.0

type FilterFunc[TAPI APIListConstraint] func(ctx context.Context, item TAPI) bool

type JiraProvider ¶

type JiraProvider struct {
	// contains filtered or unexported fields
}

JiraProvider defines the provider implementation.

func (j *JiraProvider) Configure(ctx context.Context, req provider.ConfigureRequest, resp *provider.ConfigureResponse)

func (j *JiraProvider) DataSources(_ context.Context) []func() datasource.DataSource

func (j *JiraProvider) Metadata(_ context.Context, _ provider.MetadataRequest, resp *provider.MetadataResponse)

func (j *JiraProvider) Resources(_ context.Context) []func() resource.Resource

func (j *JiraProvider) Schema(_ context.Context, _ provider.SchemaRequest, resp *provider.SchemaResponse)

func (j *JiraProvider) ValidateConfig(ctx context.Context, req provider.ValidateConfigRequest, resp *provider.ValidateConfigResponse)

type JiraProviderModel ¶

type JiraProviderModel struct {
	// Base Configuration
	Endpoint types.String `tfsdk:"endpoint"`

	AuthMethod types.String `tfsdk:"auth_method"`

	// Logging
	Debug types.Bool `tfsdk:"debug"`

	OperationTimeouts *OperationTimeoutsModel `tfsdk:"operation_timeouts"`

	// HTTP Settings
	HTTPTimeoutSeconds    types.Int64 `tfsdk:"http_timeout_seconds"`
	RetryOn4295xx         types.Bool  `tfsdk:"retry_on_429_5xx"`
	RetryMaxAttempts      types.Int64 `tfsdk:"retry_max_attempts"`
	RetryInitialBackoffMs types.Int64 `tfsdk:"retry_initial_backoff_ms"`
	RetryMaxBackoffMs     types.Int64 `tfsdk:"retry_max_backoff_ms"`

	// API Token Authentication
	APIToken     types.String `tfsdk:"api_token"`
	APIAuthEmail types.String `tfsdk:"api_auth_email"`

	// Basic Authentication
	Username types.String `tfsdk:"username"`
	Password types.String `tfsdk:"password"`

	// Privacy & Redaction
	EmailRedactionMode types.String `tfsdk:"email_redaction_mode"`
}

JiraProviderModel describes the provider data model.

type KeyOfFunc ¶ added in v0.8.0

type KeyOfFunc[TAPI APIListConstraint] func(item TAPI) string

type ListFunc ¶ added in v0.8.0

type ListFunc[TAPI APIListConstraint] func(ctx context.Context) ([]TAPI, diag.Diagnostics)

Function type aliases for list-to-map flows.

Why aliases? - Keep the ListHooks signatures concise and intention-revealing (list, filter, key-of, mapper). - Centralize call signatures so future changes won’t ripple across all data sources. - Combine with constraints below to catch type mismatches at compile time.

Usage: - Implement List to fetch all items (handle pagination internally). - Optionally implement Filter to apply client-side filtering. - KeyOf must return a stable string key (e.g., ID as string). - MapToOut converts an API item to the Terraform object model (struct of types.* fields).

type ListHooks ¶ added in v0.8.0

type ListHooks[TAPI APIListConstraint, TOut OutModelConstraint] struct {
	// List should fetch all items (handle pagination internally if needed).
	List ListFunc[TAPI]

	// Optional paginated fetcher. If provided, DoListToMapWithLimit will iterate via pages
	// using a default page size and aggregate incrementally. This avoids holding all items in memory.
	ListPage ListPageFunc[TAPI]

	// Optional filter applied client-side (return true to keep).
	Filter FilterFunc[TAPI]

	// KeyOf must return the stable string key (e.g., ID string).
	KeyOf KeyOfFunc[TAPI]

	// MapToOut converts API item to Terraform object model.
	MapToOut MapToOutFunc[TAPI, TOut]

	// AttrTypes returns the ObjectType attribute types for TOut.
	AttrTypes AttrTypesFunc
}

ListHooks defines list-to-map helpers for data sources. TAPI: API model per item (constrained by APIListConstraint). TOut: Terraform object model per item (constrained by OutModelConstraint).

type ListOptions ¶ added in v0.8.0

type ListOptions struct {
	MaxItems       int
	WarnThreshold  int
	PreallocCap    int
	RespectContext bool
}

ListOptions configures DoListToMapWithLimit behavior.

Fields - MaxItems: hard cap on kept items (post-filter). 0 = unlimited (default). - WarnThreshold: soft threshold that adds a warning once kept items reach/exceed it. 0 = disabled. - PreallocCap: explicit capacity for result map. 0 = auto (based on input length or MaxItems when known). - RespectContext: if true, checks ctx.Done() periodically and returns early with a warning if canceled.

type ListPageFunc ¶ added in v0.8.0

type ListPageFunc[TAPI APIListConstraint] func(ctx context.Context, startAt, max int) (items []TAPI, isLast bool, d diag.Diagnostics)

ListPageFunc optionally streams pages of items. Return items, whether this is the last page, and diagnostics. - startAt: zero-based offset of the first item to return for the page - max: desired maximum page size. Implementations may return fewer items. When provided, DoListToMapWithLimit will iterate pages until isLast=true, context cancellation, or reaching MaxItems.

type MapToOutFunc ¶ added in v0.8.0

type MapToOutFunc[TAPI APIListConstraint, TOut OutModelConstraint] func(ctx context.Context, item TAPI) (TOut, diag.Diagnostics)

type MapToStateFunc ¶ added in v0.8.0

type MapToStateFunc[TState StateConstraint, TAPI APIConstraint] func(ctx context.Context, api TAPI, st *TState) diag.Diagnostics

MapToStateFunc maps the API model (TAPI) into the Terraform state model (TState). Return diagnostics when mapping encounters unexpected values or schema mismatches.

type OperationTimeoutsModel ¶ added in v0.5.0

type OperationTimeoutsModel struct {
	Create types.String `tfsdk:"create"`
	Read   types.String `tfsdk:"read"`
	Update types.String `tfsdk:"update"`
	Delete types.String `tfsdk:"delete"`
}

type OutModelConstraint ¶ added in v0.8.0

type OutModelConstraint interface {
	projectResourceModel | projectCategoryResourceModel | workTypeResourceModel
}

type PayloadBuilderFunc ¶ added in v0.8.0

type PayloadBuilderFunc[TState StateConstraint, TPayload PayloadConstraint] func(ctx context.Context, st *TState) (TPayload, diag.Diagnostics)

PayloadBuilderFunc builds the API payload (TPayload) from the planned Terraform state (TState). Return diagnostics for validation or value derivation errors encountered during build.

type PayloadConstraint ¶ added in v0.8.0

type PayloadConstraint interface {
	*models.ProjectPayloadScheme |
		*models.IssueTypePayloadScheme |
		*models.ProjectCategoryPayloadScheme |
		*models.CustomFieldScheme
}

PayloadConstraint enumerates the supported go‑atlassian payload types used in Create/Update.

type PostAPIHook ¶ added in v0.8.0

type PostAPIHook[TState StateConstraint, TAPI APIConstraint] func(ctx context.Context, api TAPI, st *TState) (apiOut TAPI, apiResp *models.ResponseScheme, err error)

PostAPIHook is an optional extra step after Create to fetch the full TAPI model. Use this when Create returns a partial object and a subsequent Get is needed.

type ReadFunc ¶ added in v0.8.0

type ReadFunc[TAPI APIConstraint] func(ctx context.Context, id string) (api TAPI, apiResp *models.ResponseScheme, err error)

ReadFunc invokes the concrete API Read/Get call using a stable identifier and returns TAPI.

type ServiceClient ¶ added in v0.8.0

type ServiceClient struct {
	// contains filtered or unexported fields
}

type StateConstraint ¶ added in v0.8.0

type StateConstraint interface {
	projectResourceModel |
		workTypeResourceModel |
		projectCategoryResourceModel |
		fieldResourceModel
}

StateConstraint enumerates the Terraform state models supported by the CRUD runner.

type UpdateFunc ¶ added in v0.8.0

type UpdateFunc[TPayload PayloadConstraint, TAPI APIConstraint] func(ctx context.Context, id string, p TPayload) (api TAPI, apiResp *models.ResponseScheme, err error)

UpdateFunc invokes the concrete API Update call with payload and returns the refreshed TAPI. Some services may issue Update → Get to return a full object; both patterns are supported.