Interface SubmitFeatureFlagRequest

SubmitFeatureFlagRequest

The payload used to submit (update / insert) Feature Flag data.

interface SubmitFeatureFlagRequest {
    flags: unknown[];
    properties?: {
        [key: string]: string;
    };
    providerMetadata?: {
        product?: string;
    } & {
        [key: string]: unknown;
    };
}

Hierarchy

  • Record<string, unknown>
    • SubmitFeatureFlagRequest

Properties

flags properties? providerMetadata?

Properties

flags

flags: unknown[]

A list of Feature Flags to submit to Jira.

Each Feature Flag may be associated with 1 or more Jira issue keys, and will be associated with any properties included in this request.

Optionalproperties

properties?: {
    [key: string]: string;
}

Properties

Properties assigned to Feature Flag data that can then be used for delete / query operations.

Examples might be an account or user ID that can then be used to clean up data if an account is removed from the Provider system.

Note that these properties will never be returned with Feature Flag data. They are not intended for use as metadata to associate with a Feature Flag. Internally they are stored as a hash so that personal information etc. is never stored within Jira.

Properties are supplied as key/value pairs, a maximum of 5 properties can be supplied, and keys must not contain ':' or start with '_'.

Example

{
  "accountId": "account-234",
  "projectId": "project-123"
}

OptionalproviderMetadata

providerMetadata?: {
    product?: string;
} & {
    [key: string]: unknown;
}

ProviderMetadata

Information about the provider. This is useful for auditing, logging, debugging, and other internal uses. It is not considered private information. Hence, it may not contain personally identifiable information.

Type declaration

  • Optionalproduct?: string

    An optional name of the source of the feature flags.

    Example

    Atlassian Release Platform 2.1.0

Settings

Member Visibility

On This Page

Properties