Skip to main content

MetadataItem

Single metadata entry on a provider. Combines the field schema (see MetadataConfigItem) with the stored value.

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

Fields​

MetadataItem.key ● String! non-null scalar​

Metadata key.

MetadataItem.value ● String scalar​

Stored value, serialized per type. null when unset or masked.

MetadataItem.type ● MetadataItemType! non-null enum​

Storage type.

MetadataItem.label ● String scalar​

Human-readable field label.

MetadataItem.possibleValues ● [String!] list scalar​

Allowed values when the field is constrained to an enum.

MetadataItem.regex ● String scalar​

Regular expression the value must match.

MetadataItem.secret ● Boolean scalar​

Whether the value is sensitive and may be masked.

MetadataItem.required ● Boolean scalar​

Whether the field is required.

MetadataItem.default ● String scalar​

Default value applied when the field is omitted.

MetadataItem.example ● String scalar​

Example value shown in form UIs.

MetadataItem.internal ● Boolean scalar​

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

Member Of​

Provider object