Skip to content

Latest commit

 

History

History
258 lines (150 loc) · 8.39 KB

featureflag.md

File metadata and controls

258 lines (150 loc) · 8.39 KB

FeatureFlag Schema

https://platform.codeclimate.com/schemas/feature-flag

FeatureFlags allow changes to be gradually rolled out to an Environment after a Deployment.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Access Restrictions Defined In
Can be instantiated No Unknown status No Forbidden Allowed none FeatureFlag.schema.json

FeatureFlag Type

object (FeatureFlag)

FeatureFlag Properties

Property Type Required Nullable Defined by
_type string Required cannot be null FeatureFlag
id string Required cannot be null FeatureFlag
self string Required cannot be null FeatureFlag
name string Required cannot be null FeatureFlag
kind string Optional cannot be null FeatureFlag
key string Optional cannot be null FeatureFlag
temporary boolean Optional cannot be null FeatureFlag
maintainer Merged Optional cannot be null FeatureFlag
htmlUrl string Optional cannot be null FeatureFlag
createdAt string Optional cannot be null FeatureFlag
updatedAt string Optional cannot be null FeatureFlag
deletedAt string Optional cannot be null FeatureFlag

_type

_type

  • is required
  • Type: string
  • cannot be null
  • defined in: FeatureFlag

_type Type

string

_type Constraints

constant: the value of this property must be equal to:

"FeatureFlag"

id

The unique ID of this feature flag.

id

  • is required
  • Type: string
  • cannot be null
  • defined in: FeatureFlag

id Type

string

self

The canonical URI for this record.

self

  • is required
  • Type: string
  • cannot be null
  • defined in: FeatureFlag

self Type

string

self Constraints

URI: the string must be a URI, according to RFC 3986

name

The name of the feature flag.

name

  • is required
  • Type: string
  • cannot be null
  • defined in: FeatureFlag

name Type

string

kind

The kind of feature flag.

kind

  • is optional
  • Type: string
  • cannot be null
  • defined in: FeatureFlag

kind Type

string

key

The feature flag key.

key

  • is optional
  • Type: string
  • cannot be null
  • defined in: FeatureFlag

key Type

string

temporary

Whether the feature flag is temporary.

temporary

  • is optional
  • Type: boolean
  • cannot be null
  • defined in: FeatureFlag

temporary Type

boolean

maintainer

The self URI of the maintainer this test commit to, or a nested maintainer record.

maintainer

maintainer Type

merged type (Details)

one (and only one) of

htmlUrl

The URL to view this environment.

htmlUrl

  • is optional
  • Type: string
  • cannot be null
  • defined in: FeatureFlag

htmlUrl Type

string

htmlUrl Constraints

URI: the string must be a URI, according to RFC 3986

createdAt

The time this feature flag was created

createdAt

  • is optional
  • Type: string
  • cannot be null
  • defined in: FeatureFlag

createdAt Type

string

createdAt Constraints

date time: the string must be a date time string, according to RFC 3339, section 5.6

updatedAt

The time this feature flag was updated

updatedAt

  • is optional
  • Type: string
  • cannot be null
  • defined in: FeatureFlag

updatedAt Type

string

updatedAt Constraints

date time: the string must be a date time string, according to RFC 3339, section 5.6

deletedAt

The time this feature flag was deleted

deletedAt

  • is optional
  • Type: string
  • cannot be null
  • defined in: FeatureFlag

deletedAt Type

string

deletedAt Constraints

date time: the string must be a date time string, according to RFC 3339, section 5.6