MediaWiki:AppsCampaignConfig/schema.json

From Donate
Jump to navigation Jump to search

Note: After publishing, you may have to bypass your browser's cache to see the changes.

  • Firefox / Safari: Hold Shift while clicking Reload, or press either Ctrl-F5 or Ctrl-R (⌘-R on a Mac)
  • Google Chrome: Press Ctrl-Shift-R (⌘-Shift-R on a Mac)
  • Internet Explorer / Edge: Hold Ctrl while clicking Refresh, or press Ctrl-F5
  • Opera: Press Ctrl-F5.
$schema"https://json-schema.org/draft/2020-12/schema"
$id"https://donate.wikimedia.org/wiki/MediaWiki:AppsCampaignConfig/schema.json"
title"Apps Campaign Configuration"
description"List of campaign announcements to be shown in apps."
type"array"
items
title"Campaign"
type"object"
properties
id
description"Unique identifier of a campaign. Must not be the same as any current or previous campaign."
type"string"
version
description"Version number of this structure, to be incremented when a significant change to the schema is made."
type"integer"
start_time
type"string"
format"date-time"
end_time
type"string"
format"date-time"
countries
description"Country codes where this campaign will be shown."
type"array"
items
type"string"
minItems1
uniqueItemstrue
platforms
description"List of platforms on which this campaign will be shown, along with any applicable platform-specific parameters."
type"object"
properties
iOS
description"iOS-specific parameters for this campaign."
type"object"
Android
description"Android-specific parameters for this campaign."
type"object"
assets
description"List of assets to be shown in this campaign, grouped by language code."
type"object"
patternProperties
^.*$
type"object"
properties
text
description"Body text of the campaign message."
type"string"
footer
description"Footer text of the campaign message."
type"string"
currency_code
description"Currency code for the donation amount."
type"string"
actions
description"List of actions defined for buttons used in the campaign dialog."
type"array"
items
type"object"
properties
title
description"Label shown on the button."
type"string"
url
description"URL to be opened when the button is tapped."
type"string"
required
"title"
additionalPropertiesfalse
required
"id"
"version"
"start_time"
"end_time"
"countries"
"platforms"
"assets"