Skip to main content

MetadataConfigItem

Schema for a single metadata field of a provider configuration. Describes the field; does not carry a value.

type MetadataConfigItem {
  key: String!
  type: MetadataItemType!
  label: String
  possibleValues: [String!]
  regex: String
  secret: Boolean
  required: Boolean
  default: String
  example: String
  internal: Boolean
}

Fields​

MetadataConfigItem.key ● String! non-null scalar​

Metadata key. Dot-notation for nested fields, e.g. petitionParams.merchantCode.

MetadataConfigItem.type ● MetadataItemType! non-null enum​

Storage type.

MetadataConfigItem.label ● String scalar​

Human-readable field label.

MetadataConfigItem.possibleValues ● [String!] list scalar​

Allowed values when the field is constrained to an enum.

MetadataConfigItem.regex ● String scalar​

Regular expression the value must match.

MetadataConfigItem.secret ● Boolean scalar​

Whether the value is sensitive (e.g. a secret/API key) and should be masked in UIs.

MetadataConfigItem.required ● Boolean scalar​

Whether the field is required.

MetadataConfigItem.default ● String scalar​

Default value applied when the field is omitted.

MetadataConfigItem.example ● String scalar​

Example value shown in form UIs.

MetadataConfigItem.internal ● Boolean scalar​

Whether the field is internal-only (hidden from merchants).

Member Of​

ProviderConfig object