GetFeatureFlagById | /src/agile/models/getFeatureFlagById.ts | jira@v3.0.2

interface GetFeatureFlagById

import { type GetFeatureFlagById } from "https://deno.land/x/jira@v3.0.2/src/agile/models/getFeatureFlagById.ts";

Data related to a single Feature Flag, across any Environment that the flag is present in.*

Properties

optional

schemaVersion: string

The FeatureFlagData schema version used for this flag data.

Placeholder to support potential schema changes in the future.

id: string

The identifier for the Feature Flag. Must be unique for a given Provider.

key: string

The identifier that users would use to reference the Feature Flag in their source code etc.

Will be made available via the UI for users to copy into their source code etc.

updateSequenceId: number

An ID used to apply an ordering to updates for this Feature Flag in the case of out-of-order receipt of update requests.

This can be any monotonically increasing number. A suggested implementation is to use epoch millis from the Provider system, but other alternatives are valid (e.g. a Provider could store a counter against each Feature Flag and increment that on each update to Jira).

Updates for a Feature Flag that are received with an updateSqeuenceId lower than what is currently stored will be ignored.

optional

displayName: string

The human-readable name for the Feature Flag. Will be shown in the UI.

If not provided, will use the ID for display.

issueKeys: string[]

The Jira issue keys to associate the Feature Flag information with.

summary: { url?: string; status: { enabled: boolean; defaultValue?: string; rollout?: { percentage?: number; text?: string; rules?: number; }; }; lastUpdated: string; }

Summary information for a single Feature Flag.

Providers may elect to provide information from a specific environment, or they may choose to 'roll up' information from across multiple environments - whatever makes most sense in the Provider system.

This is the summary information that will be presented to the user on e.g. the Jira issue screen.

details: { url: string; lastUpdated: string; environment: { name: string; type?: string; }; status: { enabled: boolean; defaultValue?: string; rollout?: { percentage?: number; text?: string; rules?: number; }; }; }[]

Detail information for this Feature Flag.

This may be information for each environment the Feature Flag is defined in or a selection of environments made by the user, as appropriate.