DevInformation

Request object for development information push operations, entities are grouped by repository

interface DevInformation {
    operationType?: "NORMAL" | "BACKFILL";
    preventTransitions?: boolean;
    properties?: {
        [key: string]: string;
    };
    providerMetadata?: ProviderMetadata;
    repositories: Repository[];
}

Hierarchy

  • Record<string, unknown>
    • DevInformation

Properties

operationType?: "NORMAL" | "BACKFILL"

Indicates the operation being performed by the provider system when sending this data. "NORMAL" - Data received during normal operation (e.g. a user pushing a branch). "BACKFILL" - Data received while backfilling existing data (e.g. indexing a newly connected account). Default is "NORMAL". Please note that "BACKFILL" operations have a much higher rate-limiting threshold but are also processed slower in comparison to "NORMAL" operations.

NORMAL
preventTransitions?: boolean

Flag to prevent automatic issue transitions and smart commits being fired, default is false.

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

Arbitrary properties to tag the submitted repositories with. These properties can be used for delete operations to e.g. clean up all development information associated with an account in the event that the account is removed from the provider system. Note that these properties will never be returned with repository or entity data. They are not intended for use as metadata to associate with a repository. Maximum length of each key or value is 255 characters. Maximum allowed number of properties key/value pairs is 5. Properties keys cannot start with '_' character. Properties keys cannot contain ':' character.

providerMetadata?: ProviderMetadata

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.

repositories: Repository[]

List of repositories containing development information. Must not contain duplicates. Maximum number of entities across all repositories is 1000.